/ fm / liveswitch / WebRtcMediaStream

Class: WebRtcMediaStream<TTrack>

fm.liveswitch.WebRtcMediaStream

Type parameters

Name Type
TTrack WebRtcMediaTrack

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new WebRtcMediaStream<TTrack>(external: IExternalMediaStream, localTrack: TTrack, remoteTrack: TTrack, type: StreamType): WebRtcMediaStream<TTrack>

Type parameters:

Name Type
TTrack WebRtcMediaTrack<TTrack>

Parameters:

Name Type
external IExternalMediaStream
localTrack TTrack
remoteTrack TTrack
type StreamType

Returns: WebRtcMediaStream<TTrack>

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:67

Properties

_cachedSignalledDirection

• Private _cachedSignalledDirection: StreamDirection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:870

_controlTransportInfo

• Private _controlTransportInfo: TransportInfo

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:583

_maxReceiveBitrateRequestQueue

• Private _maxReceiveBitrateRequestQueue: BitrateRequest[]

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:839

_maxSendBitrateRequestQueue

• Private _maxSendBitrateRequestQueue: any[]

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:795

_simulcastMode

• Private _simulcastMode: SimulcastMode

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:593

Methods

addOnDirectionChange

▸ addOnDirectionChange(value: IAction0): void

Adds a handler that is raised when the stream direction changes.
Stream direction indicates the direction of media flow. For example:

  • A stream in an SFU upstream connection has a direction of SendOnly.
  • A stream in an SFU downstream connection has a direction of ReceiveOnly.
  • A stream in an MCU connection has a direction of SendReceive if it is attached to both local and remote media. If it is only attached to local media, it has a direction of SendOnly. If it is only attached to remote media, it has a direction of ReceiveOnly.
The direction of a stream can change over its lifecycle. For example:
  • An update to an SFU upstream connection might instruct the stream to stop sending audio or video frames. In this case, the direction of the stream changes to Inactive.
  • An update to an SFU downstream connection might cause it to stop receiving audio or video frames. In this case, the direction of the stream changes to Inactive.
  • An update to an MCU upstream connection might instruct the stream to stop sending audio or video frames. In this case, the following occurs:

    • If the direction of the stream was SendOnly, then the direction changes to Inactive.
    • If the direction of the stream was ReceiveOnly, then the direction changes to SendReceive.
  • An update to an MCU upstream connection might instruct it to stop receiving audio or video frames. In this case, the following occurs:
    • If the direction of the stream was ReceiveOnly, then the direction changes to Inactive.
    • If the direction of the stream was SendReceive, then the direction changes to SendOnly.
An event handler bound to the change in direction can be used to update the UI accordingly so the user is aware of the change in the state of the application.

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:90

addOnDiscardBitrateNotification

▸ addOnDiscardBitrateNotification(value: IAction1<BitrateNotification>): void

Parameters:

Name Type
value IAction1<BitrateNotification>

Returns: void

Implementation of: IInternalMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:774

addOnDiscardBitrateRequest

▸ addOnDiscardBitrateRequest(value: IAction1<BitrateRequest>): void

Parameters:

Name Type
value IAction1<BitrateRequest>

Returns: void

Implementation of: IInternalMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:602

addOnLocalEncodingDisabled

▸ addOnLocalEncodingDisabled(value: IAction1<EncodingInfo>): void

Adds a handler that is raised when a local encoding is disabled.

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:118

addOnLocalEncodingEnabled

▸ addOnLocalEncodingEnabled(value: IAction1<EncodingInfo>): void

Adds a handler that is raised when a local encoding is enabled.

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:130

addOnMaxSendBitrateChange

▸ addOnMaxSendBitrateChange(value: IAction1<number>): void

Parameters:

Name Type
value IAction1<number>

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:141

addOnStateChange

▸ addOnStateChange(value: IAction0): void

Adds a handler that is raised when the connection state changes.
This method can track the state of the connection and can be used to display the current status of the connection to the user, add or remove media views in the UI, and handle retry logic if the connection fails.

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:103

changeDirection

▸ changeDirection(newDirection: StreamDirection): Error

Records the pending direction of this stream. The LocalDirection of this stream will be updated when the connection renegotiation commences.

Parameters:

Name Type
newDirection StreamDirection

Returns: Error

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:153

doSetMaxReceiveBitrate

▸ PrivatedoSetMaxReceiveBitrate(bitrateRequest: BitrateRequest): void

Parameters:

Name Type
bitrateRequest BitrateRequest

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:859

doSetMaxSendBitrate

▸ PrivatedoSetMaxSendBitrate(bitrate: number, promise: Promise<object>): void

Parameters:

Name Type
bitrate number
promise Promise<object>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:825

findSendEncodingIndex

▸ PrivatefindSendEncodingIndex(bitrateRequest: BitrateRequest): number

Parameters:

Name Type
bitrateRequest BitrateRequest

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:754

getCachedLocalDirection

▸ getCachedLocalDirection(): StreamDirection

Gets Cached Local Direction for this Media Stream. Internal use.

Returns: StreamDirection

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:213

getCanonicalName

▸ getCanonicalName(): string

Gets the canonical name.

deprecated Use LocalCanonicalName instead.

Returns: string

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:226

getCodecDisabled

▸ getCodecDisabled(name: string): boolean

Gets whether a codec is disabled.

Parameters:

Name Type Description
name string The codec name.

Returns: boolean

Whether the codec is disabled.

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:240

getConnectedTimestamp

▸ ProtectedgetConnectedTimestamp(): number

Gets the ManagedStopwatch.GetTimestamp() value representing the ticks that passed when this stream's connection state changed to connected.

Returns: number

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:122

getConnection

▸ getConnection(): WebRtcConnection

Returns: WebRtcConnection

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStream.ts:10

getConnectionId

▸ getConnectionId(): string

Gets the connection identifier.

Returns: string

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:134

getControlTransportInfo

▸ getControlTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:589

getDirection

▸ getDirection(): StreamDirection

Returns: StreamDirection

The Media Direction as a StreamDirection enumerator.

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:261

getDirectionCapabilities

▸ getDirectionCapabilities(): StreamDirection

Returns: StreamDirection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:579

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:37

getDynamicValue

▸ getDynamicValue(key: string): Object

Gets a property value from the local cache.

Parameters:

Name Type Description
key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

Returns: Object

The stored value, if found; otherwise null.

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:61

getExternalId

▸ getExternalId(): string

Gets the external identifier.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:154

getId

▸ getId(): string

Gets the identifier.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:166

getInfo

▸ getInfo(): MediaStreamInfo

Gets the media stream info.

Returns: MediaStreamInfo

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:294

getInputContent

▸ getInputContent(): string

Gets the input content descriptor.

Returns: string

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:316

getInputMuted

▸ getInputMuted(): boolean

Returns: boolean

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:50

getIsTerminated

▸ getIsTerminated(): boolean

Gets a value indicating whether the stream is currently closed or failed.

Returns: boolean

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:194

getIsTerminating

▸ getIsTerminating(): boolean

Gets a value indicating whether the stream is currently closing or failing.

Returns: boolean

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:206

getIsTerminatingOrTerminated

▸ getIsTerminatingOrTerminated(): boolean

Gets a value indicating whether the stream is currently closing, failing, closed, or failed.

Returns: boolean

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:218

getLabel

▸ getLabel(): string

Gets a label that identifies this class.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:334

getLocalBandwidth

▸ getLocalBandwidth(): number

Gets the local bandwidth, in kbps. This value is signalled in the local session description sent to the remote endpoint so it can limit its outbound media bitrate. Use [[fm.liveswitch.mediaStreamBase.maxReceiveBitrate]] to control inbound media bitrate once the session has been negotiated.

Returns: number

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:364

getLocalCanonicalName

▸ getLocalCanonicalName(): string

Gets the local canonical end-point identifier (CNAME) used by RTCP.
The CNAME is a unique identifier for endpoints across an application instance and can be used for third-party monitoring.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:377

getLocalDirection

▸ getLocalDirection(): StreamDirection

Gets current direction indicated by the local description.

Returns: StreamDirection

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:389

getLocalMuted

▸ getLocalMuted(): boolean

Gets a value indicating whether the local stream is muted.
A muted stream does not show or play media, but the stream is not disabled and its data continues to flow through the processing pipeline. Alias for [[fm.liveswitch.mediaStreamBase.muted]].

Returns: boolean

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:403

getLocalReceive

▸ getLocalReceive(): boolean

Gets a value indicating whether the local peer supports receiving media on this stream.
Use this method to determine if a stream is used for sending media or only receiving media.

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:251

getLocalSend

▸ getLocalSend(): boolean

Gets a value indicating whether the local peer on this stream supports sending media on this stream.
Use this property to determine if a stream is used for sending media or only receiving media.

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:265

getLocalTrack

▸ getLocalTrack(): TTrack

Returns: TTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:28

getMaxReceiveBitrate

▸ getMaxReceiveBitrate(): number

Gets the maximum bitrate that the connection receives in Kbps.
This value must be less than or equal to [[fm.liveswitch.mediaStreamBase.localBandwidth]].

Returns: number

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:416

getMaxSendBitrate

▸ getMaxSendBitrate(): number

Gets the maximum bitrate that the upstream connection sends in Kbps. This value must be less than or equal to [[fm.liveswitch.mediaStreamBase.remoteBandwidth]].

Returns: number

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:429

getMediaDescriptionId

▸ getMediaDescriptionId(): string

Gets the media description ID of this stream.
The media description ID is only available once a connection is opened with this stream, because it is obtained from the local SDP description of this stream.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:292

getMuted

▸ getMuted(): boolean

Gets whether the stream is muted.
A muted stream does not show or play media, but the stream is not disabled and its data continues to flow through the processing pipeline.
Alias for [[fm.liveswitch.mediaStreamBase.inputMuted]].

Returns: boolean

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:443

getOutputContent

▸ getOutputContent(): string

Gets the output content descriptor.

Returns: string

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:455

getOutputMuted

▸ getOutputMuted(): boolean

Returns: boolean

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:62

getPreferredCodecs

▸ getPreferredCodecs(): string[]

Gets any preferred codecs, in order of preference.

Returns: string[]

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:482

getRelatedMediaDescription

▸ ProtectedgetRelatedMediaDescription(): MediaDescription

Gets related SDP Media Description

Returns: MediaDescription

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:494

getRemoteBandwidth

▸ getRemoteBandwidth(): number

Gets the remote bandwidth in Kbps.
This value is signalled in the remote session description received from the remote endpoint.
Use [[fm.liveswitch.mediaStreamBase.maxSendBitrate]] to control outbound media bitrate once the session has been negotiated.

Returns: number

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:508

getRemoteCanonicalName

▸ getRemoteCanonicalName(): string

Gets the remote canonical name.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:520

getRemoteDirection

▸ getRemoteDirection(): StreamDirection

Gets current direction indicated by the remote description.

Returns: StreamDirection

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:532

getRemoteEncoding

▸ getRemoteEncoding(): EncodingInfo

Gets the remote encoding.

Returns: EncodingInfo

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:544

getRemoteMuted

▸ getRemoteMuted(): boolean

Gets a value indicating if remote is muted.

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:556

getRemoteReceive

▸ getRemoteReceive(): boolean

Gets a value indicating whether receiving media is supported by the remote peer on this stream. Returns false if the remote stream direction has not been received.

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:320

getRemoteRequestedDeactivation

▸ getRemoteRequestedDeactivation(): boolean

Gets Boolean value set when the server is currently requesting a 0 bitrate. This is to highlight the difference between when a stream is deactivated locally or by a control mechanism on the server. Internal Use

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:568

getRemoteSend

▸ getRemoteSend(): boolean

Gets a value indicating whether sending media is supported by the remote peer on this stream. Returns false if the remote stream direction has not been received.

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:333

getRemoteTrack

▸ getRemoteTrack(): TTrack

Returns: TTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:37

getRenegotiationPending

▸ ProtectedgetRenegotiationPending(): boolean

Gets whether there exist changes that are pending SDP renegotiation.

Returns: boolean

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:580

getSimulcastMode

▸ getSimulcastMode(): SimulcastMode

Returns: SimulcastMode

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:595

getState

▸ getState(): StreamState

Gets the state of the stream.

Returns: StreamState

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:346

getTag

▸ getTag(): string

Gets optional data to associate with this instance.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:366

getTransportInfo

▸ getTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStream.ts:41

getType

▸ getType(): StreamType

Gets the type.

Returns: StreamType

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:384

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:4

getUseWssForMedia

▸ getUseWssForMedia(): boolean

Gets a value indicating whether W

Returns: boolean

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:396

populateInfo

▸ populateInfo(info: MediaStreamInfo): void

Parameters:

Name Type
info MediaStreamInfo

Returns: void

Overrides: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:126

processCachedChanges

▸ processCachedChanges(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:529

processNextMaxReceiveBitrateRequest

▸ PrivateprocessNextMaxReceiveBitrateRequest(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:851

processNextMaxSendBitrate

▸ PrivateprocessNextMaxSendBitrate(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:817

processSdpContentAttribute

▸ Protected AbstractprocessSdpContentAttribute(sdpContentAttribute: ContentAttribute, isLocalDescription: boolean): void

Parameters:

Name Type
sdpContentAttribute ContentAttribute
isLocalDescription boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:540

processSdpMediaDescription

▸ processSdpMediaDescription(sdpMessage: Message, sdpMediaDescription: MediaDescription, index: number, isLocalDescription: boolean, isOffer: boolean, isRenegotiation: boolean): Error

Parameters:

Name Type
sdpMessage Message
sdpMediaDescription MediaDescription
index number
isLocalDescription boolean
isOffer boolean
isRenegotiation boolean

Returns: Error

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:542

processStateChange

▸ ProtectedprocessStateChange(): void

Processes a state change.

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:418

processStateLockChange

▸ ProtectedprocessStateLockChange(): void

Processes a state lock change.

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:429

raiseBitrateNotification

▸ raiseBitrateNotification(bitrateNotification: BitrateNotification): boolean

Parameters:

Name Type
bitrateNotification BitrateNotification

Returns: boolean

Implementation of: IInternalMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:791

raiseBitrateRequest

▸ raiseBitrateRequest(bitrateRequest: BitrateRequest): boolean

Parameters:

Name Type
bitrateRequest BitrateRequest

Returns: boolean

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:638

raiseLocalEncodingDisabled

▸ ProtectedraiseLocalEncodingDisabled(encoding: EncodingInfo): void

Raises the OnLocalEncodingDisabled event.

Parameters:

Name Type Description
encoding EncodingInfo The encoding.

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:635

raiseLocalEncodingEnabled

▸ ProtectedraiseLocalEncodingEnabled(encoding: EncodingInfo): void

Raises the OnLocalEncodingEnabled event.

Parameters:

Name Type Description
encoding EncodingInfo The encoding.

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:651

remoteRequestedMaxSendBitrate

▸ PrivateremoteRequestedMaxSendBitrate(sendEncodingIndex: number, maxBitrate: number): boolean

Parameters:

Name Type
sendEncodingIndex number
maxBitrate number

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:733

removeOnDirectionChange

▸ removeOnDirectionChange(value: IAction0): void

Removes a handler that is raised when the stream direction changes.
Stream direction indicates the direction of media flow. For example:

  • A stream in an SFU upstream connection has a direction of SendOnly.
  • A stream in an SFU downstream connection has a direction of ReceiveOnly.
  • A stream in an MCU connection has a direction of SendReceive if it is attached to both local and remote media. If it is only attached to local media, it has a direction of SendOnly. If it is only attached to remote media, it has a direction of ReceiveOnly.
The direction of a stream can change over its lifecycle. For example:
  • An update to an SFU upstream connection might instruct the stream to stop sending audio or video frames. In this case, the direction of the stream changes to Inactive.
  • An update to an SFU downstream connection might cause it to stop receiving audio or video frames. In this case, the direction of the stream changes to Inactive.
  • An update to an MCU upstream connection might instruct the stream to stop sending audio or video frames. In this case, the following occurs:

    • If the direction of the stream was SendOnly, then the direction changes to Inactive.
    • If the direction of the stream was ReceiveOnly, then the direction changes to SendReceive.
  • An update to an MCU upstream connection might instruct it to stop receiving audio or video frames. In this case, the following occurs:
    • If the direction of the stream was ReceiveOnly, then the direction changes to Inactive.
    • If the direction of the stream was SendReceive, then the direction changes to SendOnly.
An event handler bound to the change in direction can be used to update the UI accordingly so the user is aware of the change in the state of the application.

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:491

removeOnDiscardBitrateNotification

▸ removeOnDiscardBitrateNotification(value: IAction1<BitrateNotification>): void

Parameters:

Name Type
value IAction1<BitrateNotification>

Returns: void

Implementation of: IInternalMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:777

removeOnDiscardBitrateRequest

▸ removeOnDiscardBitrateRequest(value: IAction1<BitrateRequest>): void

Parameters:

Name Type
value IAction1<BitrateRequest>

Returns: void

Implementation of: IInternalMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:605

removeOnLocalEncodingDisabled

▸ removeOnLocalEncodingDisabled(value: IAction1<EncodingInfo>): void

Removes a handler that is raised when a local encoding is disabled.

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:683

removeOnLocalEncodingEnabled

▸ removeOnLocalEncodingEnabled(value: IAction1<EncodingInfo>): void

Removes a handler that is raised when a local encoding is enabled.

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:695

removeOnMaxSendBitrateChange

▸ removeOnMaxSendBitrateChange(value: IAction1<number>): void

Parameters:

Name Type
value IAction1<number>

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:706

removeOnStateChange

▸ removeOnStateChange(value: IAction0): void

Removes a handler that is raised when the connection state changes.
This method can track the state of the connection and can be used to display the current status of the connection to the user, add or remove media views in the UI, and handle retry logic if the connection fails.

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:504

resetRemoteDirection

▸ resetRemoteDirection(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:536

setCodecDisabled

▸ setCodecDisabled(name: string, disabled: boolean): void

Sets whether a codec is disabled.

Parameters:

Name Type Description
name string The codec name.
disabled boolean Whether to disable the codec.

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:735

setControlTransportInfo

▸ setControlTransportInfo(info: TransportInfo): void

Parameters:

Name Type
info TransportInfo

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:585

setDynamicValue

▸ setDynamicValue(key: string, value: Object): void

Sets a property value in the local cache.

Parameters:

Name Type Description
key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.
value Object The property value. This can be any object that needs to be stored for future use.

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:98

setExternalId

▸ setExternalId(value: string): void

Sets the external identifier.

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:540

setInputContent

▸ ProtectedsetInputContent(value: string): void

Sets the input content descriptor.

Parameters:

Name Type
value string

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:752

setInputMuted

▸ setInputMuted(muted: boolean): void

Parameters:

Name Type
muted boolean

Returns: void

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:44

setLocalBandwidth

▸ setLocalBandwidth(value: number): void

Sets the local bandwidth, in kbps. This value is signalled in the local session description sent to the remote endpoint so it can limit its outbound media bitrate. Use [[fm.liveswitch.mediaStreamBase.maxReceiveBitrate]] to control inbound media bitrate once the session has been negotiated.

Parameters:

Name Type
value number

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:774

setLocalDirection

▸ setLocalDirection(value: StreamDirection): void

Sets current direction indicated by the local description.

Parameters:

Name Type
value StreamDirection

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:795

setLocalMuted

▸ setLocalMuted(value: boolean): void

Sets a value indicating whether the local stream is muted.
A muted stream does not show or play media, but the stream is not disabled and its data continues to flow through the processing pipeline. Alias for [[fm.liveswitch.mediaStreamBase.muted]].

Parameters:

Name Type
value boolean

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:813

setLocalReceive

▸ setLocalReceive(value: boolean): void

Sets a value indicating whether the local peer supports receiving media on this stream.
Use this method to determine if a stream is used for sending media or only receiving media.

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:567

setLocalSend

▸ setLocalSend(value: boolean): void

Sets a value indicating whether the local peer on this stream supports sending media on this stream.
Use this property to determine if a stream is used for sending media or only receiving media.

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:606

setLocalTrack

▸ setLocalTrack(localTrack: TTrack): void

Parameters:

Name Type
localTrack TTrack

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:31

setMaxReceiveBitrate

▸ setMaxReceiveBitrate(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:840

setMaxSendBitrate

▸ setMaxSendBitrate(value: number): Future<object>

Parameters:

Name Type
value number

Returns: Future<object>

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:796

setMuted

▸ setMuted(value: boolean): void

Sets whether the stream is muted.
A muted stream does not show or play media, but the stream is not disabled and its data continues to flow through the processing pipeline.
Alias for [[fm.liveswitch.mediaStreamBase.inputMuted]].

Parameters:

Name Type
value boolean

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:872

setOutputContent

▸ ProtectedsetOutputContent(value: string): void

Sets the output content descriptor.

Parameters:

Name Type
value string

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:884

setOutputMuted

▸ setOutputMuted(muted: boolean): void

Parameters:

Name Type
muted boolean

Returns: void

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:57

setPreferredCodecs

▸ setPreferredCodecs(value: string[]): void

Sets any preferred codecs, in order of preference.

Parameters:

Name Type
value string[]

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:911

setRelatedMediaDescription

▸ ProtectedsetRelatedMediaDescription(value: MediaDescription): void

Sets related SDP Media Description

Parameters:

Name Type
value MediaDescription

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:923

setRemoteBandwidth

▸ ProtectedsetRemoteBandwidth(value: number): void

Sets the remote bandwidth in Kbps.
This value is signalled in the remote session description received from the remote endpoint.
Use [[fm.liveswitch.mediaStreamBase.maxSendBitrate]] to control outbound media bitrate once the session has been negotiated.

Parameters:

Name Type
value number

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:937

setRemoteEncoding

▸ setRemoteEncoding(value: EncodingInfo): void

Sets the remote encoding.

Parameters:

Name Type
value EncodingInfo

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:970

setRemoteMuted

▸ setRemoteMuted(value: boolean): void

Sets a value indicating if remote is muted.

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:982

setRemoteTrack

▸ setRemoteTrack(remoteTrack: TTrack): void

Parameters:

Name Type
remoteTrack TTrack

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:40

setRenegotiationPending

▸ ProtectedsetRenegotiationPending(value: boolean): void

Sets whether there exist changes that are pending SDP renegotiation.

Parameters:

Name Type
value boolean

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:1002

setSimulcastMode

▸ setSimulcastMode(value: SimulcastMode): void

Parameters:

Name Type
value SimulcastMode

Returns: void

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:598

setTag

▸ setTag(value: string): void

Sets optional data to associate with this instance.

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:694

setTransportInfo

▸ setTransportInfo(transportInfo: TransportInfo): void

Parameters:

Name Type
transportInfo TransportInfo

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStream.ts:37

setUseWssForMedia

▸ setUseWssForMedia(value: boolean): void

Sets a value indicating whether W

Parameters:

Name Type
value boolean

Returns: void

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:714

toString

▸ toString(): string

Returns a string that represents this instance.

Returns: string

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:726

unsetDynamicValue

▸ unsetDynamicValue(key: string): boolean

Removes a property value from the local cache. Returns true if the value was removed and returns false otherwise.

Parameters:

Name Type Description
key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

Returns: boolean

true if the value was removed; otherwise, false.

Inherited from: WebRtcMediaStreamBase

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:125