Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AudioVideoFacade

Hierarchy

Implemented by

Index

Methods

Methods

addContentShareObserver

addDeviceChangeObserver

addObserver

addVideoTile

bindAudioElement

  • bindAudioElement(element: HTMLAudioElement): Promise<void>

bindVideoElement

  • bindVideoElement(tileId: number, videoElement: HTMLVideoElement): void

captureVideoTile

  • captureVideoTile(tileId: number): ImageData | null

chooseAudioInputDevice

chooseAudioOutputDevice

  • chooseAudioOutputDevice(deviceId: string | null): Promise<void>

chooseVideoInputDevice

chooseVideoInputQuality

  • chooseVideoInputQuality(width: number, height: number, frameRate: number, maxBandwidthKbps: number): void
  • 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 with a max bandwidth of 1400 kbps.

    Parameters

    • width: number
    • height: number
    • frameRate: number
    • maxBandwidthKbps: number

    Returns void

createAnalyserNodeForAudioInput

getAllRemoteVideoTiles

getAllVideoTiles

getLocalVideoTile

getRTCPeerConnectionStats

  • getRTCPeerConnectionStats(selector?: MediaStreamTrack): Promise<RTCStatsReport>

getRemoteVideoSources

getVideoInputQualitySettings

getVideoTile

  • getVideoTile(tileId: number): VideoTile | null

hasStartedLocalVideoTile

  • hasStartedLocalVideoTile(): boolean

listAudioInputDevices

  • listAudioInputDevices(): Promise<MediaDeviceInfo[]>

listAudioOutputDevices

  • listAudioOutputDevices(): Promise<MediaDeviceInfo[]>

listVideoInputDevices

  • listVideoInputDevices(): Promise<MediaDeviceInfo[]>

mixIntoAudioInput

  • mixIntoAudioInput(stream: MediaStream): MediaStreamAudioSourceNode

pauseContentShare

  • pauseContentShare(): void

pauseVideoTile

  • pauseVideoTile(tileId: number): void

realtimeCanUnmuteLocalAudio

  • realtimeCanUnmuteLocalAudio(): boolean

realtimeIsLocalAudioMuted

  • realtimeIsLocalAudioMuted(): boolean

realtimeMuteLocalAudio

  • realtimeMuteLocalAudio(): void

realtimeSendDataMessage

  • realtimeSendDataMessage(topic: string, data: Uint8Array | string | any, lifetimeMs?: number): void

realtimeSetCanUnmuteLocalAudio

  • realtimeSetCanUnmuteLocalAudio(canUnmute: boolean): void

realtimeSubscribeToAttendeeIdPresence

  • realtimeSubscribeToAttendeeIdPresence(callback: (attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean, posInFrame?: RealtimeAttendeePositionInFrame | null) => void): void

realtimeSubscribeToFatalError

  • realtimeSubscribeToFatalError(callback: (error: Error) => void): void

realtimeSubscribeToLocalSignalStrengthChange

  • realtimeSubscribeToLocalSignalStrengthChange(callback: (signalStrength: number) => void): void

realtimeSubscribeToMuteAndUnmuteLocalAudio

  • realtimeSubscribeToMuteAndUnmuteLocalAudio(callback: (muted: boolean) => void): void

realtimeSubscribeToReceiveDataMessage

  • realtimeSubscribeToReceiveDataMessage(topic: string, callback: (dataMessage: DataMessage) => void): void

realtimeSubscribeToSetCanUnmuteLocalAudio

  • realtimeSubscribeToSetCanUnmuteLocalAudio(callback: (canUnmute: boolean) => void): void

realtimeSubscribeToVolumeIndicator

realtimeUnmuteLocalAudio

  • realtimeUnmuteLocalAudio(): boolean

realtimeUnsubscribeFromReceiveDataMessage

  • realtimeUnsubscribeFromReceiveDataMessage(topic: string): void

realtimeUnsubscribeFromVolumeIndicator

realtimeUnsubscribeToAttendeeIdPresence

  • realtimeUnsubscribeToAttendeeIdPresence(callback: (attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean, posInFrame?: RealtimeAttendeePositionInFrame | null) => void): void

realtimeUnsubscribeToFatalError

  • realtimeUnsubscribeToFatalError(callback: (error: Error) => void): void

realtimeUnsubscribeToLocalSignalStrengthChange

  • realtimeUnsubscribeToLocalSignalStrengthChange(callback: (signalStrength: number) => void): void

realtimeUnsubscribeToMuteAndUnmuteLocalAudio

  • realtimeUnsubscribeToMuteAndUnmuteLocalAudio(callback: (muted: boolean) => void): void

realtimeUnsubscribeToSetCanUnmuteLocalAudio

  • realtimeUnsubscribeToSetCanUnmuteLocalAudio(callback: (canUnmute: boolean) => void): void

removeAllVideoTiles

  • removeAllVideoTiles(): void

removeContentShareObserver

removeDeviceChangeObserver

removeLocalVideoTile

  • removeLocalVideoTile(): void

removeObserver

removeVideoTile

  • removeVideoTile(tileId: number): void

removeVideoTilesByAttendeeId

  • removeVideoTilesByAttendeeId(attendeeId: string): number[]

setAudioProfile

setContentAudioProfile

setDeviceLabelTrigger

  • setDeviceLabelTrigger(trigger: () => Promise<MediaStream>): void
  • 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>
        • (): Promise<MediaStream>
        • Returns Promise<MediaStream>

    Returns void

start

  • start(options?: { signalingOnly?: boolean }): void
  • Start the meeting session. By default this will connect and begin sending and receiving audio, depending on the implementation.

    This method also allows you to provide options for how connection occurs.

    The only supported option is signalingOnly. Specifying this option will cause the controller to only connect the meeting signaling channel. This can be performed relatively early in the join lifecycle (e.g., prior to choosing audio devices), which can improve join latency.

    Your code is responsible for calling start again without signalingOnly to complete connection.

    Parameters

    • Optional options: { signalingOnly?: boolean }

      Passing signalingOnly: true will cause only the initial signaling connection to occur.

      • Optional signalingOnly?: boolean

    Returns void

startContentShare

  • startContentShare(stream: MediaStream): Promise<void>

startContentShareFromScreenCapture

  • startContentShareFromScreenCapture(sourceId?: string, frameRate?: number): Promise<MediaStream>

startLocalVideoTile

  • startLocalVideoTile(): number

startVideoPreviewForVideoInput

  • startVideoPreviewForVideoInput(element: HTMLVideoElement): void

stop

  • stop(): void

stopContentShare

  • stopContentShare(): void

stopLocalVideoTile

  • stopLocalVideoTile(): void

stopVideoPreviewForVideoInput

  • stopVideoPreviewForVideoInput(element: HTMLVideoElement): void

subscribeToActiveSpeakerDetector

  • subscribeToActiveSpeakerDetector(policy: ActiveSpeakerPolicy, callback: (activeSpeakers: string[]) => void, scoresCallback?: (scores: {}) => void, scoresCallbackIntervalMs?: number): void

unbindAudioElement

  • unbindAudioElement(): void

unbindVideoElement

  • unbindVideoElement(tileId: number): void

unpauseContentShare

  • unpauseContentShare(): void

unpauseVideoTile

  • unpauseVideoTile(tileId: number): void

unsubscribeFromActiveSpeakerDetector

  • unsubscribeFromActiveSpeakerDetector(callback: (activeSpeakers: string[]) => void): void

Generated using TypeDoc