Product
VOICEVIDEOMESSAGING
SolutionsIndustries
Documentation
GETTING STARTEDPLATFORM REFERENCETUTORIALS
ShowcasePricing
BlogHelp
FAQDEVELOPER COMMUNITYCONTACT SUPPORT
About
VOXIMPLANT IN PRESSSTATUS PAGELEGAL INFO
SIGN UP
SIGN UP

IAudioDeviceManager

Interface that may be used to manage audio devices, i.e. see current active device, select another active device and get the list of available devices.
Voximplant Android SDK supports the following devices:

  • earpiece
  • speaker
  • wired headset
  • bluetooth headset

Default audio device

The earpiece is the default audio device for devices that supports telephony feature (android phones). The speaker is the default audio device for android tablets.

Before a call

In case if the audio device was not selected via IAudioDeviceManager.selectAudioDevice(AudioDevice), it will be selected according to the following priority order:

  • bluetooth (if connected)
  • wired headset (if connected)
  • earpiece (if available)
  • speaker

In case if audio device was selected via IAudioDeviceManager.selectAudioDevice(AudioDevice) and then a higher priority device is connected, the new device will be used for a call. For example, speaker was selected and then bluetooth headset is connected, in this case bluetooth device will be used for a call.

During the call

In case if new audio device (wired headset or bluetooth headset) is connected, active audio device is switched to the new connected audio device.
In case if active audio device is disconnected (wired or bluetooth headset), active audio device will be selected according to the priority order.
In case if active audio device is selected via IAudioDeviceManager.selectAudioDevice(AudioDevice), active audio device is switched to the selected device.
In case if active audio device is selected via IAudioDeviceManager.selectAudioDevice(AudioDevice) and then new audio device is connected (wired or bluetooth headset), active audio device is switched to the new audio device. If wired or bluetooth headset will be disconnected during the same call, previously selected audio device becomes active.
For example:

  1. wired headset is connected
  2. call is started -> wired headset is active device
  3. speaker is selected as active device -> speaker is active device
  4. bluetooth headset is connected -> bluetooth is active device
  5. bluetooth headset is disconnected -> speaker is active device

Limits:

  1. IAudioDeviceManager should be used only after IClient initialization via Voximplant.getClientInstance(Executor, Context, ClientConfig)
  2. The plug in/out of a wired headset and bluetooth devices is monitored only if a connection to the Voximplant Cloud is active
  3. It is not possible to select an earpiece while wired headset is connected

Methods(7)

Methods

addAudioDeviceEventsListener

Since 2.3.4
void addAudioDeviceEventsListener(IAudioDeviceEventsListener listener)

Add IAudioDeviceEventsListener listener to handle audio device changes events.

Parameters

enableLoudspeaker

Deprecated
boolean enableLoudspeaker(boolean useLoudspeaker)

Since 2.3.4, use IAudioDeviceManager.selectAudioDevice(AudioDevice)

Enable/disable loudspeaker. Disabled by default.

It is highly recommended to enable loudspeaker after the call is connected.

Parameters

  • useLoudspeaker:

    boolean

    Enable/disable loudspeaker

Returns

  • Return:

    boolean

    true on success, false otherwise

getActiveDevice

Since 2.3.4
AudioDevice getActiveDevice()

Returns active audio device during the call or audio device that will be used for a call if there is no calls at this moment.

Please note that active audio device can be later changed if new device is connected. In this case IAudioDeviceEventsListener.onAudioDeviceChanged(AudioDevice) will be triggered to notify about new active device.

Returns

getAudioDevices

Since 2.3.4
List<AudioDevice> getAudioDevices()

Returns the list of available audio devices.

Returns

  • Return:

    List<AudioDevice>

    Current list of available audio devices

removeAudioDeviceEventsListener

Since 2.3.4
void removeAudioDeviceEventsListener(IAudioDeviceEventsListener listener)

Remove IAudioDeviceEventsListener listener.

Parameters

selectAudioDevice

Since 2.3.4
void selectAudioDevice(AudioDevice audioDevice)

Changes selection of the current active audio device. There are two cases:

  • before a call. The method doesn't activate an audio device, it just selects (i.e. points to) the audio device that will be activated
  • during a call. If the selected audio device is available, the method activates this audio device.

When the call is ended, selected audio device is reset to the default one.

Please note that active audio device can be later changed if new device is connected. In this case IAudioDeviceEventsListener.onAudioDeviceChanged(AudioDevice) will be triggered to notify about new active device.

Parameters

setAudioFocusChangeListener

void setAudioFocusChangeListener(IAudioFocusChangeListener listener)

Set IAudioFocusChangeListener listener to handle audio focus change events.

Parameters