Class SimulcastContentShareTransceiverController

Deprecated

Simulcast is deprecated in favor of scalable video coding (SVC).

Hierarchy (View Summary)

SimulcastTransceiverController
- SimulcastContentShareTransceiverController

Index

Constructors

Properties

_localAudioTransceiver _localCameraTransceiver browserBehavior defaultMediaStream encodedTransformWorkerManager? groupIdToTransceiver logger meetingSessionContext? peer streamIdToTransceiver videoQualityControlParameterMap videoSubscriptions BITRATE_ARR_ASCENDING HIGH_LEVEL_NAME LOW_LEVEL_NAME MID_LEVEL_NAME NAME_ARR_ASCENDING

Constructors

constructor

new SimulcastContentShareTransceiverController(
    logger: Logger,
    browserBehavior: BrowserBehavior,
    meetingSessionContext?: AudioVideoControllerState,
    encodedTransformWorkerManager?: EncodedTransformWorkerManager,
): SimulcastContentShareTransceiverController
Parameters
- logger: Logger
- browserBehavior: BrowserBehavior
- OptionalmeetingSessionContext: AudioVideoControllerState
- OptionalencodedTransformWorkerManager: EncodedTransformWorkerManager
Returns SimulcastContentShareTransceiverController
Overrides SimulcastTransceiverController.constructor
- Defined in src/transceivercontroller/SimulcastContentShareTransceiverController.ts:17

Properties

`Protected`_localAudioTransceiver

_localAudioTransceiver: RTCRtpTransceiver = null

`Protected`_localCameraTransceiver

_localCameraTransceiver: RTCRtpTransceiver = null

`Protected`browserBehavior

browserBehavior: BrowserBehavior

`Protected`defaultMediaStream

defaultMediaStream: MediaStream = null

`Protected` `Optional`encodedTransformWorkerManager

encodedTransformWorkerManager?: EncodedTransformWorkerManager

`Protected`groupIdToTransceiver

groupIdToTransceiver: Map<number, RTCRtpTransceiver> = ...

`Protected`logger

logger: Logger

`Protected` `Optional`meetingSessionContext

meetingSessionContext?: AudioVideoControllerState

`Protected`peer

peer: RTCPeerConnection = null

`Protected`streamIdToTransceiver

streamIdToTransceiver: Map<number, RTCRtpTransceiver> = ...

`Protected`videoQualityControlParameterMap

videoQualityControlParameterMap: Map<string, RTCRtpEncodingParameters> = ...

`Protected`videoSubscriptions

videoSubscriptions: number[] = []

`Static` `Readonly`BITRATE_ARR_ASCENDING

BITRATE_ARR_ASCENDING: number[] = ...

`Static` `Readonly`HIGH_LEVEL_NAME

HIGH_LEVEL_NAME: string = 'hi'

`Static` `Readonly`LOW_LEVEL_NAME

LOW_LEVEL_NAME: string = 'low'

`Static` `Readonly`MID_LEVEL_NAME

MID_LEVEL_NAME: string = 'mid'

`Static` `Readonly`NAME_ARR_ASCENDING

NAME_ARR_ASCENDING: string[] = ...

Methods

addRedundantAudioRecoveryMetricsObserver

addRedundantAudioRecoveryMetricsObserver(
_observer: RedundantAudioRecoveryMetricsObserver,
): void
Parameters
- _observer: RedundantAudioRecoveryMetricsObserver
Returns void
Deprecated
This method is deprecated and should not be used. Access the encodedTransformWorkerManager directly via the meeting session context instead.
Inherited from SimulcastTransceiverController.addRedundantAudioRecoveryMetricsObserver
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:473

`Protected`copyEncodingParams

copyEncodingParams(
fromEncodingParams: RTCRtpEncodingParameters,
toEncodingParams: RTCRtpEncodingParameters,
): void
Parameters
- fromEncodingParams: RTCRtpEncodingParameters
- toEncodingParams: RTCRtpEncodingParameters
Returns void
Inherited from SimulcastTransceiverController.copyEncodingParams
- Defined in src/transceivercontroller/SimulcastTransceiverController.ts:145

getMidForGroupId

getMidForGroupId(groupId: number): string
Get the associated MID for a given group ID, set during updateVideoTransceivers
Parameters
- groupId: number
Returns string
Inherited from SimulcastTransceiverController.getMidForGroupId
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:415

getMidForStreamId

getMidForStreamId(streamId: number): string
Get the associated MID for a given stream ID, either set via updateVideoTransceivers or overriden through setStreamIdForMid.

Note: According to https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpTransceiver/mid mid may not exist yet even if the transceiver has been created: "This association is established, when possible, whenever either a local or remote description is applied. This field is null if neither a local or remote description has been applied, or if its associated m-line is rejected by either a remote offer or any answer."
Parameters
- streamId: number
Returns string
Inherited from SimulcastTransceiverController.getMidForStreamId
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:401

hasVideoInput

hasVideoInput(): boolean
Indicates if there is a video input attached

Returns boolean
Inherited from SimulcastTransceiverController.hasVideoInput
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:143

localAudioTransceiver

localAudioTransceiver(): RTCRtpTransceiver
Returns the [[RTCRtpTransceiver]] for audio

Returns RTCRtpTransceiver
Inherited from SimulcastTransceiverController.localAudioTransceiver
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:82

localVideoTransceiver

localVideoTransceiver(): RTCRtpTransceiver
Returns the [[RTCRtpTransceiver]] for local camera

Returns RTCRtpTransceiver
Inherited from SimulcastTransceiverController.localVideoTransceiver
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:86

`Protected`logVideoTransceiverParameters

logVideoTransceiverParameters(): void
Returns void
Inherited from SimulcastTransceiverController.logVideoTransceiverParameters
- Defined in src/transceivercontroller/SimulcastTransceiverController.ts:135

removeRedundantAudioRecoveryMetricsObserver

removeRedundantAudioRecoveryMetricsObserver(
_observer: RedundantAudioRecoveryMetricsObserver,
): void
Parameters
- _observer: RedundantAudioRecoveryMetricsObserver
Returns void
Deprecated
This method is deprecated and should not be used. Access the encodedTransformWorkerManager directly via the meeting session context instead.
Inherited from SimulcastTransceiverController.removeRedundantAudioRecoveryMetricsObserver
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:483

replaceAudioTrack

replaceAudioTrack(track: MediaStreamTrack): Promise<boolean>
Replaces [[MediaStreamTrack]] on audio transceiver of sendrecv direction.
Parameters
- track: MediaStreamTrack
Returns Promise<boolean>
Inherited from SimulcastTransceiverController.replaceAudioTrack
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:199

reset

reset(): void
Resets the transceiver controller states.

Returns void
Inherited from SimulcastTransceiverController.reset
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:113

setAudioInput

setAudioInput(track: MediaStreamTrack): Promise<void>
Sets the audio track.
Parameters
- track: MediaStreamTrack
Returns Promise<void>
Inherited from SimulcastTransceiverController.setAudioInput
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:208

setAudioPayloadTypes

setAudioPayloadTypes(_payloadTypeMap: Map<string, number>): void
Parameters
- _payloadTypeMap: Map<string, number>
Returns void
Deprecated
This method is deprecated and should not be used. Access the encodedTransformWorkerManager directly via the meeting session context instead.
Inherited from SimulcastTransceiverController.setAudioPayloadTypes
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:463

setEncodingParameters

setEncodingParameters(
encodingParamMap: Map<string, RTCRtpEncodingParameters>,
): Promise<void>
Set [[RTCRtpEncodingParameters]] on the sender of transceiver. This method should be called whenever the sender's encoding parameters of the local video transceiver need to be updated. For example, the default NScaleVideoUplinkBandwidthPolicy calls this method whenever a video is on/off or the active speaker changes. This method assumes that the sender of the local video transceiver is available and the input parameters should not be empty. The encoding parameters for sender should be retrieved using sender.getParameters and updated using sender.setParameters method.
Parameters
- encodingParamMap: Map<string, RTCRtpEncodingParameters>
Returns Promise<void>
Overrides SimulcastTransceiverController.setEncodingParameters
- Defined in src/transceivercontroller/SimulcastContentShareTransceiverController.ts:38

setPeer

setPeer(peer: RTCPeerConnection): void
Sets the peer connection.
Parameters
- peer: RTCPeerConnection
Returns void
Inherited from SimulcastTransceiverController.setPeer
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:108

setStreamIdForMid

setStreamIdForMid(mid: string, newStreamId: number): void
Override or set an internal mapping of stream ID to MID.
Parameters
- mid: string
- newStreamId: number
Returns void
Inherited from SimulcastTransceiverController.setStreamIdForMid
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:405

setupLocalTransceivers

setupLocalTransceivers(): void
Creates audio and video transceivers.

Returns void
Inherited from SimulcastTransceiverController.setupLocalTransceivers
- Defined in src/transceivercontroller/SimulcastTransceiverController.ts:92

setVideoInput

setVideoInput(track: MediaStreamTrack): Promise<void>
Sets the video track.
Parameters
- track: MediaStreamTrack
Returns Promise<void>
Inherited from SimulcastTransceiverController.setVideoInput
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:213

setVideoSendingBitrateKbps

setVideoSendingBitrateKbps(_bitrateKbps: number): Promise<void>
Sets video sending bitrate in Kilo-bit-per-second
Parameters
- _bitrateKbps: number
Returns Promise<void>
Inherited from SimulcastTransceiverController.setVideoSendingBitrateKbps
- Defined in src/transceivercontroller/SimulcastTransceiverController.ts:88

trackIsVideoInput

trackIsVideoInput(track: MediaStreamTrack): boolean
Returns whether the track is a video track.
Parameters
- track: MediaStreamTrack
Returns boolean
Inherited from SimulcastTransceiverController.trackIsVideoInput
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:150

`Protected`transceiverIsVideo

transceiverIsVideo(transceiver: RTCRtpTransceiver): boolean
Parameters
- transceiver: RTCRtpTransceiver
Returns boolean
Inherited from SimulcastTransceiverController.transceiverIsVideo
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:419

updateVideoTransceivers

updateVideoTransceivers(
videoStreamIndex: VideoStreamIndex,
videosToReceive: VideoStreamIdSet,
): number[]
Updates video transceivers.
Parameters
- videoStreamIndex: VideoStreamIndex
- videosToReceive: VideoStreamIdSet
Returns number[]
Inherited from SimulcastTransceiverController.updateVideoTransceivers
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:218

useTransceivers

useTransceivers(): boolean
Indicates whether the transceiver is used.

Returns boolean
Inherited from SimulcastTransceiverController.useTransceivers
- Defined in src/transceivercontroller/DefaultTransceiverController.ts:139

Class SimulcastContentShareTransceiverController

Deprecated

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SimulcastContentShareTransceiverController

Properties

Protected_localAudioTransceiver

Protected_localCameraTransceiver

ProtectedbrowserBehavior

ProtecteddefaultMediaStream

Protected OptionalencodedTransformWorkerManager

ProtectedgroupIdToTransceiver

Protectedlogger

Protected OptionalmeetingSessionContext

Protectedpeer

ProtectedstreamIdToTransceiver

ProtectedvideoQualityControlParameterMap

ProtectedvideoSubscriptions

Static ReadonlyBITRATE_ARR_ASCENDING

Static ReadonlyHIGH_LEVEL_NAME

Static ReadonlyLOW_LEVEL_NAME

Static ReadonlyMID_LEVEL_NAME

Static ReadonlyNAME_ARR_ASCENDING

Methods

addRedundantAudioRecoveryMetricsObserver

Parameters

Returns void

Deprecated

ProtectedcopyEncodingParams

Parameters

Returns void

getMidForGroupId

Parameters

Returns string

getMidForStreamId

Parameters

Returns string

hasVideoInput

Returns boolean

localAudioTransceiver

Returns RTCRtpTransceiver

localVideoTransceiver

Returns RTCRtpTransceiver

ProtectedlogVideoTransceiverParameters

Returns void

removeRedundantAudioRecoveryMetricsObserver

Parameters

Returns void

Deprecated

replaceAudioTrack

Parameters

Returns Promise<boolean>

reset

Returns void

setAudioInput

Parameters

Returns Promise<void>

setAudioPayloadTypes

Parameters

Returns void

Deprecated

setEncodingParameters

Parameters

Returns Promise<void>

setPeer

Parameters

Returns void

setStreamIdForMid

Parameters

Returns void

setupLocalTransceivers

Returns void

setVideoInput

Parameters

`Protected`_localAudioTransceiver

`Protected`_localCameraTransceiver

`Protected`browserBehavior

`Protected`defaultMediaStream

`Protected` `Optional`encodedTransformWorkerManager

`Protected`groupIdToTransceiver

`Protected`logger

`Protected` `Optional`meetingSessionContext

`Protected`peer

`Protected`streamIdToTransceiver

`Protected`videoQualityControlParameterMap

`Protected`videoSubscriptions

`Static` `Readonly`BITRATE_ARR_ASCENDING

`Static` `Readonly`HIGH_LEVEL_NAME

`Static` `Readonly`LOW_LEVEL_NAME

`Static` `Readonly`MID_LEVEL_NAME

`Static` `Readonly`NAME_ARR_ASCENDING

`Protected`copyEncodingParams

`Protected`logVideoTransceiverParameters

`Protected`transceiverIsVideo