com.quickblox.videochat.webrtc

Class AppRTCAudioManager

java.lang.Object

com.quickblox.videochat.webrtc.AppRTCAudioManager

public class AppRTCAudioManager
extends java.lang.Object

AppRTCAudioManager manages all audio related parts of the AppRTC demo.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppRTCAudioManager.AudioDevice AudioDevice is the names of possible audio devices that we currently support.
static interface	AppRTCAudioManager.AudioManagerEvents Selected audio device change event.
static class	AppRTCAudioManager.AudioManagerState AudioManager state.
static interface	AppRTCAudioManager.BluetoothAudioDeviceStateListener
static interface	AppRTCAudioManager.OnAudioManagerStateListener Deprecated. since 3.8.0. Use AppRTCAudioManager.AudioManagerEvents
static interface	AppRTCAudioManager.OnWiredHeadsetStateListener

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated. since 3.8.0. Use stop()
static AppRTCAudioManager	create(Context context) Construction.
static AppRTCAudioManager	create(Context context, AppRTCAudioManager.OnAudioManagerStateListener onAudioManagerStateListener) Deprecated. since 3.8.0. Use create(Context)
AudioManager	getAndroidAudioManager()
java.util.Set<AppRTCAudioManager.AudioDevice>	getAudioDevices() Returns current set of available/selectable audio devices.
AppRTCAudioManager.AudioDevice	getDefaultAudioDevice() Returns default audio device.
AppRTCAudioManager.AudioDevice	getSelectedAudioDevice() Returns the currently selected audio device.
void	init() Deprecated. since 3.8.0. Use start(AudioManagerEvents)
void	selectAudioDevice(AppRTCAudioManager.AudioDevice device) Changes selection of the currently active audio device.
void	setAudioDevice(AppRTCAudioManager.AudioDevice device) Deprecated. since 3.8.0. Use selectAudioDevice(AudioDevice)
void	setBluetoothAudioDeviceStateListener(AppRTCAudioManager.BluetoothAudioDeviceStateListener bluetoothAudioDeviceStateListener) Sets listener to handle Bluetooth Audio device state.
void	setDefaultAudioDevice(AppRTCAudioManager.AudioDevice defaultDevice) Changes default audio device.
void	setManageBluetoothByDefault(boolean manageBluetoothByDefault) AppRTCAudioManager will handle BLUETOOTH state or no.
void	setManageHeadsetByDefault(boolean manageHeadsetByDefault) AppRTCAudioManager will handle headset state or no.
void	setManageSpeakerPhoneByProximity(boolean manageSpeakerPhoneByProximity) AppRTCAudioManager can manage SPEAKER_PHONE by proximity sensor in case if device doesn't have any other connected headsets (e.g.
void	setOnAudioManagerStateListener(AppRTCAudioManager.OnAudioManagerStateListener onAudioManagerStateListener) Deprecated. since 3.8.0. Set AudioManagerStateListener via start(AudioManagerEvents)
void	setOnWiredHeadsetStateListener(AppRTCAudioManager.OnWiredHeadsetStateListener wiredHeadsetStateListener) Sets listener to handle headset state.
void	start(AppRTCAudioManager.AudioManagerEvents audioManagerEvents)
void	stop()
void	updateAudioDeviceState() Updates list of possible audio devices and make new device selection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static AppRTCAudioManager create(Context context)

Construction.

create

@Deprecated
public static AppRTCAudioManager create(Context context,
                                                    AppRTCAudioManager.OnAudioManagerStateListener onAudioManagerStateListener)

Deprecated. since 3.8.0. Use create(Context)

init

@Deprecated
public void init()

Deprecated. since 3.8.0. Use start(AudioManagerEvents)

start

public void start(AppRTCAudioManager.AudioManagerEvents audioManagerEvents)

getAndroidAudioManager

public AudioManager getAndroidAudioManager()

setOnAudioManagerStateListener

@Deprecated
public void setOnAudioManagerStateListener(AppRTCAudioManager.OnAudioManagerStateListener onAudioManagerStateListener)

Deprecated. since 3.8.0. Set AudioManagerStateListener via start(AudioManagerEvents)

Parameters:

onAudioManagerStateListener -

setManageHeadsetByDefault

public void setManageHeadsetByDefault(boolean manageHeadsetByDefault)

AppRTCAudioManager will handle headset state or no. If "true" AppRTCAudioManager will handle headset state and selected audio channel. In this case when headset is plugged AppRTCAudioManager sets headset as current audio device. When headset is unplugged, AppRTCAudioManager sets audio device to default one. If "false" headset state will be handled by android default behaviour and AppRTCAudioManager will only notify about headset's state. This option enabled by default.

Parameters:

manageHeadsetByDefault - Set 'false' if want manage headset by himself.

setOnWiredHeadsetStateListener

public void setOnWiredHeadsetStateListener(AppRTCAudioManager.OnWiredHeadsetStateListener wiredHeadsetStateListener)

Sets listener to handle headset state.

Parameters:

wiredHeadsetStateListener - instance of OnWiredHeadsetStateListener

setManageSpeakerPhoneByProximity

public void setManageSpeakerPhoneByProximity(boolean manageSpeakerPhoneByProximity)

AppRTCAudioManager can manage SPEAKER_PHONE by proximity sensor in case if device doesn't have any other connected headsets (e.g. WIRED_HEADSET, BLUETOOTH). By default this option disabled.

Parameters:

manageSpeakerPhoneByProximity - Set 'true' if want use this feature.

setManageBluetoothByDefault

public void setManageBluetoothByDefault(boolean manageBluetoothByDefault)

AppRTCAudioManager will handle BLUETOOTH state or no. If "true" AppRTCAudioManager will handle BLUETOOTH state and selected audio channel. In this case when BLUETOOTH is connected AppRTCAudioManager sets BLUETOOTH as current audio device. When BLUETOOTH is disconnected, AppRTCAudioManager sets audio device to default one. If "false" BLUETOOTH state will be handled by android default behaviour and AppRTCAudioManager will only notify about changing audio device state via AppRTCAudioManager.AudioManagerEvents. This option enabled by default.

Parameters:

manageBluetoothByDefault - Set 'false' if want manage headset by himself.

setBluetoothAudioDeviceStateListener

public void setBluetoothAudioDeviceStateListener(AppRTCAudioManager.BluetoothAudioDeviceStateListener bluetoothAudioDeviceStateListener)

Sets listener to handle Bluetooth Audio device state.

Parameters:

bluetoothAudioDeviceStateListener -

close

@Deprecated
public void close()

Deprecated. since 3.8.0. Use stop()

stop

public void stop()

setAudioDevice

@Deprecated
public void setAudioDevice(AppRTCAudioManager.AudioDevice device)

Deprecated. since 3.8.0. Use selectAudioDevice(AudioDevice)

getDefaultAudioDevice

public AppRTCAudioManager.AudioDevice getDefaultAudioDevice()

Returns default audio device.

setDefaultAudioDevice

public void setDefaultAudioDevice(AppRTCAudioManager.AudioDevice defaultDevice)

Changes default audio device. TODO(henrika): add usage of this method in the AppRTCMobile client.

selectAudioDevice

public void selectAudioDevice(AppRTCAudioManager.AudioDevice device)

Changes selection of the currently active audio device.

getAudioDevices

public java.util.Set<AppRTCAudioManager.AudioDevice> getAudioDevices()

Returns current set of available/selectable audio devices.

getSelectedAudioDevice

public AppRTCAudioManager.AudioDevice getSelectedAudioDevice()

Returns the currently selected audio device.

updateAudioDeviceState

public void updateAudioDeviceState()

Updates list of possible audio devices and make new device selection. TODO(henrika): add unit test to verify all state transitions.