Class JitsiMediaDevices

Media devices utilities for Jitsi.

Hierarchy (View Summary)

Listenable
- JitsiMediaDevices

Index

Constructors

Methods

enumerateDevices getAudioOutputDevice isDeviceChangeAvailable isDevicePermissionGranted isMultipleAudioInputSupported setAudioOutputDevice

Constructors

constructor

new JitsiMediaDevices(): JitsiMediaDevices
Initializes a JitsiMediaDevices object. There will be a single instance of this class.

Returns JitsiMediaDevices
Overrides Listenable.constructor
- Defined in JitsiMediaDevices.ts:25

Methods

enumerateDevices

enumerateDevices(callback: (devices: MediaDeviceInfo[]) => void): void
Executes callback with list of media devices connected.
Parameters
- callback: (devices: MediaDeviceInfo[]) => void
Returns void
- Defined in JitsiMediaDevices.ts:158

getAudioOutputDevice

getAudioOutputDevice(): string
Returns currently used audio output device id, 'default' stands for default device

Returns string
- Defined in JitsiMediaDevices.ts:255

isDeviceChangeAvailable

isDeviceChangeAvailable(deviceType?: string): boolean
Returns true if changing the input (camera / microphone) or output (audio) device is supported and false if not.
Parameters
- OptionaldeviceType: string
  type of device to change. Default is undefined or 'input', 'output' - for audio output device change.
Returns boolean
true if available, false otherwise.
- Defined in JitsiMediaDevices.ts:169

isDevicePermissionGranted

isDevicePermissionGranted(type?: MediaType): Promise<boolean>
Checks if the permission for the given device was granted.
Parameters
- Optionaltype: MediaType
  type of devices to check, undefined stands for both 'audio' and 'video' together
Returns Promise<boolean>
- Defined in JitsiMediaDevices.ts:180

isMultipleAudioInputSupported

isMultipleAudioInputSupported(): boolean
Returns true if it is possible to be simultaneously capturing audio from more than one device.

Returns boolean
- Defined in JitsiMediaDevices.ts:243

setAudioOutputDevice

setAudioOutputDevice(deviceId: string): Promise<void>
Sets current audio output device.
Parameters
- deviceId: string
  id of 'audiooutput' device from navigator.mediaDevices.enumerateDevices(), 'default' is for default device
Returns Promise<void>
- resolves when audio output is changed, is rejected otherwise
- Defined in JitsiMediaDevices.ts:267