Interface AudioMixController

An instance of [[AudioMixController]] is provided when constructing a [[MeetingClient]] to allow for binding audio output.

interface AudioMixController {
    addAudioMixObserver(observer: AudioMixObserver): void;
    bindAudioDevice(device: MediaDeviceInfo): Promise<void>;
    bindAudioElement(element: HTMLAudioElement): Promise<void>;
    bindAudioStream(stream: MediaStream): Promise<void>;
    getCurrentMeetingAudioStream(): Promise<MediaStream>;
    removeAudioMixObserver(observer: AudioMixObserver): void;
    unbindAudioElement(): void;
}

Hierarchy (View Summary)

AudioMixControllerFacade
- AudioMixController

Implemented by

DefaultAudioMixController

Index

Methods

addAudioMixObserver bindAudioDevice bindAudioElement bindAudioStream getCurrentMeetingAudioStream removeAudioMixObserver unbindAudioElement

Methods

addAudioMixObserver

addAudioMixObserver(observer: AudioMixObserver): void
Add an observer to listen for changes to the current meeting audio stream. The observer will be notified when a stream is bound or unbound from an audio element in the page.
Parameters
- observer: AudioMixObserver
Returns void
Overrides AudioMixControllerFacade.addAudioMixObserver
- Defined in src/audiomixcontroller/AudioMixController.ts:48

bindAudioDevice

bindAudioDevice(device: MediaDeviceInfo): Promise<void>
Called when the audio mix device can be bound to an element and stream.

This method rejects if you specify a device and the browser does not support setSinkId; use BrowserBehavior.supportsSetSinkId to check before calling this method.
Parameters
- device: MediaDeviceInfo
Returns Promise<void>
- Defined in src/audiomixcontroller/AudioMixController.ts:36

bindAudioElement

bindAudioElement(element: HTMLAudioElement): Promise<void>
Called when the audio mix element can be bound to a device and stream.
Parameters
- element: HTMLAudioElement
Returns Promise<void>
Overrides AudioMixControllerFacade.bindAudioElement
- Defined in src/audiomixcontroller/AudioMixController.ts:15

bindAudioStream

bindAudioStream(stream: MediaStream): Promise<void>
Called when the audio mix stream can be bound to a device and element.

This method rejects if you specify a device and the browser does not support setSinkId; use BrowserBehavior.supportsSetSinkId to check before calling this method.
Parameters
- stream: MediaStream
Returns Promise<void>
- Defined in src/audiomixcontroller/AudioMixController.ts:28

getCurrentMeetingAudioStream

getCurrentMeetingAudioStream(): Promise<MediaStream>
Returns the meeting audio stream currently bound to a HTMLAudioElement, or null if there is no current audio stream. This method will typically never reject.

Returns Promise<MediaStream>
Overrides AudioMixControllerFacade.getCurrentMeetingAudioStream
- Defined in src/audiomixcontroller/AudioMixController.ts:42

removeAudioMixObserver

removeAudioMixObserver(observer: AudioMixObserver): void
Remove an observer to stop listening for changes to the current meeting audio stream.
Parameters
- observer: AudioMixObserver
Returns void
Overrides AudioMixControllerFacade.removeAudioMixObserver
- Defined in src/audiomixcontroller/AudioMixController.ts:53

unbindAudioElement

unbindAudioElement(): void
Called to unbind the audio element so that the audio output stream does not have a sink.

Returns void
Overrides AudioMixControllerFacade.unbindAudioElement
- Defined in src/audiomixcontroller/AudioMixController.ts:20