Called when the session needs to attach an audio input to the peer connection.
Called when the session needs to acquire a display input device for screen sharing.
Called when the session needs to attach a video input to the peer connection.
Adds an observer to receive callbacks about device changes.
Add a media stream broker observer to receive events when input/output streams change
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.
Dispose of this instance. The instance cannot be used after this method has been called.
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.
Mute the current active local audio input stream.
Removes an observer to stop receiving callbacks about device changes.
Remove a media stream broker observer to stop receiving events when input/output streams change
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.
Unmute the current active local audio input
Calls close on reusable audio context. This more forceful the suspend and is not recommended if you plan on reusing the Chime SDK, as it may lead to audio glitches (e.g. due to https://issues.chromium.org/issues/40282750).
Returns the Web Audio AudioContext used by the DefaultDeviceController. The AudioContext
is created lazily the first time this function is called.
This function will not attempt to recreate a stopped context, or resume a suspended one.
a Web Audio AudioContext
Calls resume on reusable audio context.
Overrides the default latency hint used by the user agent when creating the AudioContext. By default,
user agents will choose "interactive" which opts for the smallest possible audio buffer. This can
cause choppy audio in some cases on Windows. Therefore, "playback" will be chosen on Windows unless
this value is overridden with this function.
The latency hint to be used when creating the Web Audio AudioContext
Calls suspend on reusable audio context. This is useful if you want an application to power down the audio hardware when it will not be using an audio context for a while (i.e. if you have an application that isn't always running a Chime SDK meeting). This is preferrable to calling closeAudioContext
Generated using TypeDoc
EventController for publishing events.