1. References
  2. React Native SDK
  3. Voximplant
  4. Hardware
  5. AudioDeviceManager
Rate this page:

AudioDeviceManager

Methods

callKitConfigureAudioSession

Copy URL
IOS
callKitConfigureAudioSession(): 
void

Initializes AVAudioSession if the application uses CallKit.Required for the correct CallKit integration only. Otherwise do not use this method.

Should be called when:

  1. the provider performs the specified start call action
  2. the provider performs the specified answer call action

Returns

  • type:

    void

callKitReleaseAudioSession

Copy URL
IOS
callKitReleaseAudioSession(): 
void

Restores the default AVAudioSession initialization routines, MUST be called if CallKit becomes disabled.Required for the correct CallKit integration only. Otherwise do not use this method.

Returns

  • type:

    void

callKitStartAudio

Copy URL
IOS
callKitStartAudio(): 
void

Starts AVAudioSession.Required for the correct CallKit integration only. Otherwise do not use this method.

Should be called when:

  1. the provider’s audio session is activated
  2. the provider performs the specified set held call action

Returns

  • type:

    void

callKitStopAudio

Copy URL
IOS
callKitStopAudio(): 
void

Stops AVAudioSession.Required for the correct CallKit integration only. Otherwise do not use this method.

Should be called when:

  1. the provider performs the specified end call action
  2. the provider performs the specified set held call action

Returns

  • type:

    void

getActiveDevice

Copy URL
getActiveDevice(): 
Promise<AudioDevice>

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

Returns

getAudioDevices

Copy URL
getAudioDevices(): 
Promise<AudioDevice[]>

Returns the list of available audio devices.

Returns

getInstance

Copy URL
getInstance(): 
AudioDeviceManager

Gets an AudioDeviceManager instance to control audio hardware settings.

Returns

off

Copy URL
off(eventType: 
AudioDeviceEventTypes
, event: 
Function
): 
void

Removes a handler for the specified AudioDeviceManager event.

Parameters

  • eventType:

    AudioDeviceEventTypes

  • event:

    Function

    Optional

    Handler function. If not specified, all handlers for the event are removed.

Returns

  • type:

    void

on

Copy URL
on(eventType: 
AudioDeviceEventTypes
, event: 
Function
): 
void

Registers a handler for the specified AudioDeviceManager event. One event can have more than one handler. Use the AudioDeviceManager.off method to delete a handler.

Parameters

Returns

  • type:

    void

selectAudioDevice

Copy URL
selectAudioDevice(audioDevice: 
AudioDevice
): 
void

Changes selection of the current active audio device. Please see Android and iOS documentation for platform specific.

Parameters

Returns

  • type:

    void