Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DefaultAudioVideoFacade

Hierarchy

  • DefaultAudioVideoFacade

Implements

Index

Constructors

Methods

Constructors

constructor

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

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) => void): void
  • Parameters

    • callback: (attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean) => void
        • (attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean): void
        • Parameters

          • attendeeId: string
          • present: boolean
          • Optional externalUserId: string
          • Optional dropped: boolean

          Returns void

    Returns 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) => void): void
  • Parameters

    • callback: (attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean) => void
        • (attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean): void
        • Parameters

          • attendeeId: string
          • present: boolean
          • Optional externalUserId: string
          • Optional dropped: boolean

          Returns void

    Returns 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

start

  • start(options?: { signalingOnly?: boolean }): 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
  • Parameters

    • policy: ActiveSpeakerPolicy
    • callback: (activeSpeakers: string[]) => void
        • (activeSpeakers: string[]): void
        • Parameters

          • activeSpeakers: string[]

          Returns void

    • Optional scoresCallback: (scores: {}) => void
        • (scores: {}): void
        • Parameters

          • scores: {}
            • [attendeeId: string]: number

          Returns void

    • Optional scoresCallbackIntervalMs: number

    Returns 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