AudioDeviceManager | RingCentral Video Client SDK for Browser

The AudioDeviceManager class is a managing class to manage the audio devices and test them out.

Hierarchy

AudioDeviceEventEmitter
- AudioDeviceManager

Index

Constructors

constructor

Events

Methods

Constructors

constructor

new AudioDeviceManager(): AudioDeviceManager

Overrides AudioDeviceEventEmitter.constructor
Returns AudioDeviceManager

Events

on

on(event: RECORDING_DEVICE_LIST_UPDATED, listener: ((devices: MediaDeviceInfo[]) => void)): any
on(event: PLAYBACK_DEVICE_LIST_UPDATED, listener: ((devices: MediaDeviceInfo[]) => void)): any
on(event: RECORDING_DEVICE_CHANGED, listener: ((deviceId: string) => void)): any

Inherited from AudioDeviceEventEmitter.on

Occurs when the recording device list updated

Parameters
- event: RECORDING_DEVICE_LIST_UPDATED
- listener: ((devices: MediaDeviceInfo[]) => void)
  - - (devices: MediaDeviceInfo[]): void
    - Parameters
      - devices: MediaDeviceInfo[]
      Returns void
Returns any
Occurs when the playback device list updated

Parameters
- event: PLAYBACK_DEVICE_LIST_UPDATED
- listener: ((devices: MediaDeviceInfo[]) => void)
  - - (devices: MediaDeviceInfo[]): void
    - Parameters
      - devices: MediaDeviceInfo[]
      Returns void
Returns any
Occurs when the current recording device changed

Parameters
- event: RECORDING_DEVICE_CHANGED
- listener: ((deviceId: string) => void)
  - - (deviceId: string): void
    - Parameters
      - deviceId: string
      Returns void
Returns any

Methods

clear

clear(): void

Inherited from AudioDeviceEventEmitter.clear

Clear away side effect.

Returns void

enumeratePlaybackDevices

enumeratePlaybackDevices(skipPermissionCheck?: boolean): Promise<MediaDeviceInfo[]>

Enumerates the audio playback devices.

Parameters
- skipPermissionCheck: boolean = false
  
  true | false, default false.
Returns Promise<MediaDeviceInfo[]>
The audio playback device list

enumerateRecordingDevices

enumerateRecordingDevices(skipPermissionCheck?: boolean): Promise<MediaDeviceInfo[]>

Enumerates the audio recording devices.

Parameters
- skipPermissionCheck: boolean = false
  
  true | false, default false.
Returns Promise<MediaDeviceInfo[]>
The audio recording device list

off

off(eventName: RECORDING_DEVICE_LIST_UPDATED | PLAYBACK_DEVICE_LIST_UPDATED | RECORDING_DEVICE_CHANGED | DEVICE_LIST_UPDATED, listener: TEventCB): void

Inherited from AudioDeviceEventEmitter.off

Removes the specified listener from the listener array for the event named eventName.

Parameters
- eventName: RECORDING_DEVICE_LIST_UPDATED | PLAYBACK_DEVICE_LIST_UPDATED | RECORDING_DEVICE_CHANGED | DEVICE_LIST_UPDATED
- listener: TEventCB
Returns void

once

once(eventName: RECORDING_DEVICE_LIST_UPDATED | PLAYBACK_DEVICE_LIST_UPDATED | RECORDING_DEVICE_CHANGED | DEVICE_LIST_UPDATED, listener: TEventCB): void

Inherited from AudioDeviceEventEmitter.once

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

Parameters
- eventName: RECORDING_DEVICE_LIST_UPDATED | PLAYBACK_DEVICE_LIST_UPDATED | RECORDING_DEVICE_CHANGED | DEVICE_LIST_UPDATED
- listener: TEventCB
Returns void

safeGetDisplayMedia

safeGetDisplayMedia(constraints?: DisplayMediaStreamConstraints): Promise<MediaStream>

Inherited from AudioDeviceEventEmitter.safeGetDisplayMedia
Parameters
- constraints: DisplayMediaStreamConstraints = ...
Returns Promise<MediaStream>

safeGetUserMedia

safeGetUserMedia(constraints?: MediaStreamConstraints): Promise<MediaStream>

Inherited from AudioDeviceEventEmitter.safeGetUserMedia

Prompts the user for permission to use a media input which produces a MediaStream with tracks containing the requested types of media.

Parameters
- constraints: MediaStreamConstraints = ...
Returns Promise<MediaStream>

setRecordingDevice

setRecordingDevice(deviceId: string): Promise<ErrorCodeType>

Sets the current audio recording device by the device id.

description
A successful call of setRecordingDevice triggers the {@link DeviceEvent.RECORDING_DEVICE_CHANGED} event notification.

Parameters
- deviceId: string
  
  The unique id of the audio recording device
Returns Promise<ErrorCodeType>
0 means success or fails otherwise

startPlaybackDeviceTest

startPlaybackDeviceTest(audioFilePath: string): Promise<ErrorCodeType>

Starts the audio playback device test.

description
A successful call of startPlaybackDeviceTest triggers playing an audio file specified by the user. If the user can hear the voice that means the playback device works properly.

Parameters
- audioFilePath: string
  
  The path of the audio file for the audio playback device test
Returns Promise<ErrorCodeType>
0 means success or fails otherwise

startRecordingDeviceTest

startRecordingDeviceTest(options?: boolean | MediaTrackConstraints): Promise<MediaStream>

Starts the audio capturing device test. This method tests whether the audio capturing device works properly.

Parameters
- Optional options: boolean | MediaTrackConstraints
Returns Promise<MediaStream>
The audio media stream or fails otherwise

stopPlaybackDeviceTest

stopPlaybackDeviceTest(): ErrorCodeType

Stops the audio playback device test.

Returns ErrorCodeType
0 means success or fails otherwise

stopRecordingDeviceTest

stopRecordingDeviceTest(): ErrorCodeType

Stops the camera test.

Returns ErrorCodeType
0 means success or fails otherwise

Static replaceStreamTrack

replaceStreamTrack(originStream: MediaStream, targetStream: MediaStream, stopOrigin?: any): void

Inherited from AudioDeviceEventEmitter.replaceStreamTrack
description
replace stream track

Parameters
- originStream: MediaStream
- targetStream: MediaStream
- Optional stopOrigin: any
Returns void

Hierarchy

Index

Constructors

Events

Methods

Constructors

constructor

Returns AudioDeviceManager

Events

on

Parameters

event: RECORDING_DEVICE_LIST_UPDATED

listener: ((devices: MediaDeviceInfo[]) => void)

Parameters

devices: MediaDeviceInfo[]

Returns void

Returns any

Parameters

event: PLAYBACK_DEVICE_LIST_UPDATED

listener: ((devices: MediaDeviceInfo[]) => void)

Parameters

devices: MediaDeviceInfo[]

Returns void

Returns any

Parameters

event: RECORDING_DEVICE_CHANGED

listener: ((deviceId: string) => void)

Parameters

deviceId: string

Returns void

Returns any

Methods

clear

Returns void

enumeratePlaybackDevices

Parameters

skipPermissionCheck: boolean = false

Returns Promise<MediaDeviceInfo[]>

enumerateRecordingDevices

Parameters

skipPermissionCheck: boolean = false

Returns Promise<MediaDeviceInfo[]>

off

Parameters

eventName: RECORDING_DEVICE_LIST_UPDATED | PLAYBACK_DEVICE_LIST_UPDATED | RECORDING_DEVICE_CHANGED | DEVICE_LIST_UPDATED

listener: TEventCB

Returns void

once

Parameters

eventName: RECORDING_DEVICE_LIST_UPDATED | PLAYBACK_DEVICE_LIST_UPDATED | RECORDING_DEVICE_CHANGED | DEVICE_LIST_UPDATED

listener: TEventCB

Returns void

safeGetDisplayMedia

Parameters

constraints: DisplayMediaStreamConstraints = ...

Returns Promise<MediaStream>

safeGetUserMedia

Parameters

constraints: MediaStreamConstraints = ...

Returns Promise<MediaStream>

setRecordingDevice

Parameters

deviceId: string

Returns Promise<ErrorCodeType>

startPlaybackDeviceTest

Parameters

audioFilePath: string

Returns Promise<ErrorCodeType>

startRecordingDeviceTest

Parameters

Optional options: boolean | MediaTrackConstraints

Returns Promise<MediaStream>

stopPlaybackDeviceTest

Returns ErrorCodeType

stopRecordingDeviceTest

Returns ErrorCodeType

Static replaceStreamTrack

Parameters

originStream: MediaStream

targetStream: MediaStream