Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AudioVideoController

AudioVideoController manages the signaling and peer connections.

Hierarchy

Implemented by

Index

Properties

Readonly activeSpeakerDetector

activeSpeakerDetector: ActiveSpeakerDetector

Returns the ActiveSpeakerDetector for this audio-video controller.

Readonly audioMixController

audioMixController: AudioMixController

Returns the AudioMixController for this audio-video controller.

Readonly configuration

Returns the session configuration for this audio-video controller.

Optional Readonly eventController

eventController: EventController

Returns the EventController for this audio-video controller.

Readonly logger

logger: Logger

Returns the Logger for this audio-video controller.

Readonly mediaStreamBroker

mediaStreamBroker: MediaStreamBroker

Returns the MediaStreamBroker for this audio-video controller.

Readonly realtimeController

realtimeController: RealtimeController

Returns the RealtimeController for this audio-video controller.

Readonly rtcPeerConnection

rtcPeerConnection: RTCPeerConnection | null

Returns the RTCPeerConnection for this audio-video controller if there is one.

Readonly videoTileController

videoTileController: VideoTileController

Returns the VideoTileController for this audio-video controller.

Methods

addObserver

forEachObserver

getRTCPeerConnectionStats

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

getRemoteVideoSources

handleMeetingSessionStatus

pauseReceivingStream

  • pauseReceivingStream(streamId: number): void

reconnect

removeObserver

Optional replaceLocalVideo

  • replaceLocalVideo(): Promise<void>

restartLocalAudio

  • restartLocalAudio(callback: () => void): Promise<void>

restartLocalVideo

  • restartLocalVideo(callback: () => void): void

resumeReceivingStream

  • resumeReceivingStream(streamId: number): void

setAudioProfile

setVideoMaxBandwidthKbps

  • setVideoMaxBandwidthKbps(maxBandwidthKbps: number): 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

stop

  • stop(): void

update

  • update(): boolean

Generated using TypeDoc