Class NoOpDeviceController

When you are done using a DeviceController, you should perform some cleanup steps in order to avoid memory leaks:

  1. Call DeviceController.destroy to stop all active audio and video inputs.
  2. Remove any device change observers that you registered by using DeviceControllerFacade.removeDeviceChangeObserver.
  3. Drop your reference to the controller to allow it to be garbage collected.

Hierarchy (View Summary)

Implements

Constructors

Properties

destroyed: boolean

Methods

  • 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.

    Parameters

    • _width: number
    • _height: number
    • _frameRate: number

    Returns void

  • Dispose of this instance. The instance cannot be used after this method has been called.

    Returns Promise<void>

  • Lists currently available audio input devices. If forceUpdate is set to true, the deviceInfoCache will be updated from browser.

    Returns Promise<MediaDeviceInfo[]>

  • Lists currently available audio output devices. If forceUpdate is set to true, the deviceInfoCache will be updated from browser.

    Returns Promise<MediaDeviceInfo[]>

  • Lists currently available video input devices. If forceUpdate is set to true, the deviceInfoCache will be updated from browser.

    Returns Promise<MediaDeviceInfo[]>

  • Mixes the audio from the given media stream into the main audio input stream.

    Parameters

    • _stream: MediaStream

    Returns MediaStreamAudioSourceNode

  • 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.

    Parameters

    • _trigger: () => Promise<MediaStream>

    Returns void

  • 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.

    Parameters

    Returns Promise<MediaStream>

  • 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.

    Parameters

    Returns Promise<MediaStream>

  • 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.

    Parameters

    • _element: HTMLVideoElement

    Returns void

  • 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.

    Returns Promise<void>

  • 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.

    Returns Promise<void>

  • Stops the stream for a previously bound video preview and unbinds it from the video element.

    Parameters

    • _element: HTMLVideoElement

    Returns void