Adds an observer to receive callbacks about device changes.
Selects an audio output device for use. Null specifies the default device. Note: This method will throw an error if browser does not support setSinkId. See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/setSinkId
Sets the video input quality parameters to request when enabling video. These settings take effect the next time a video input device is chosen. The default is 960x540 @ 15 fps.
Gets an AnalyserNode from the current audio input. This node can be used to
generate the display for a mic indicator. null is returned if no audio
input has been selected.
The AnalyserNode is not updated automatically when you choose a new
audio input. Dispose of this one and fetch another by calling this method again.
Note that this node should be cleaned up after use, and as such a RemovableAnalyserNode is returned. Call RemovableAnalyserNode.removeOriginalInputs to disconnect the node from the Web Audio graph.
Get the current video input quality settings to request when enabling video.
Lists currently available audio input devices. If forceUpdate is set to true, the deviceInfoCache will be updated from browser.
Lists currently available audio output devices. If forceUpdate is set to true, the deviceInfoCache will be updated from browser.
Lists currently available video input devices. If forceUpdate is set to true, the deviceInfoCache will be updated from browser.
Mixes the audio from the given media stream into the main audio input stream.
Removes an observer to stop receiving callbacks about device changes.
Sets the device label trigger to use in the case where media device labels are not present due to privacy restrictions in the browser. See above for an explanation of how this works.
Selects an audio input device to use. The constraint may be a device id,
MediaTrackConstraint, MediaStream (containing audio track), or null to
generate a dummy audio stream. It may also be an AudioTransformDevice to customize the
constraints used or to apply Web Audio transforms.
The promise will resolve indicating success or it will throw an appropriate error indicating the failure.
Selects a video input device to use. The constraint may be a device id,
MediaTrackConstraint, MediaStream (containing video track). It may also be an VideoTransformDevice
to apply video transform.
The promise will resolve indicating success or it will throw an appropriate error indicating the failure.
Starts a video preview of the currently selected video and binds it a video element to be displayed before a meeting begins. Make sure to call stopVideoPreviewForVideoInput when the preview is no longer necessary so that the stream can be released and turn off the camera if it is not being used anymore.
Stop the current audio input. This needs to be called to clear out to stop the current audio input resources such as audio stream from microphone.
Stop the current video input. This needs to be called to clear out to stop the current video input resources such as video stream from camera.
Stops the stream for a previously bound video preview and unbinds it from the video element.
Generated using TypeDoc
DeviceControllerFacade keeps track of the devices being used for audio input (e.g. microphone), video input (e.g. camera), audio output (e.g. speakers). The list functions return MediaDeviceInfo objects. Once any list function is called, changes in device availability are broadcast to any registered DeviceChangeObserver.
Calling a start function will request permission for the device indicated by the device id, media stream or track constraint. For audio input, supply null to will generate an empty audio stream. Calling stop to stop the input stream. Make sure to choose the audio input before joining the session (even if it is the default device) so that you can offer the user options if the device cannot be selected before a connection is made.
Note that in certain situations such as private tabs, the browser may initially decline to provide device labels for when enumerating devices. If this is the case, the internal device label trigger function is called to try to coax the browser in to providing the labels. The default behavior of the function is to make a microphone and camera access request which, if successful, will unlock the labels. You may want to override this behavior to provide a custom UX such as a prompt explaining why microphone and camera access is being asked for by supplying your own function to setDeviceLabelTrigger(). To disable the device label trigger, supply a function that returns a rejected promise instead. For reference, the default implementation calls getUserMedia for audio and video and returns the promise to the stream so that the stream can be cleaned up once the labels are detected.