/ 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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:57

Properties

_controlTransportInfo

• Private _controlTransportInfo: TransportInfo

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

_simulcastMode

• Private _simulcastMode: SimulcastMode

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

Methods

addOnDirectionChange

▸ addOnDirectionChange(value: IAction0): void

Adds a handler that is raised when the stream direction change has occurred.

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

addOnDiscardBitrateNotification

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

Parameters:

Name Type
value IAction1<BitrateNotification>

Returns: void

Implementation of: IInternalMediaStream

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

addOnDiscardBitrateRequest

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

Parameters:

Name Type
value IAction1<BitrateRequest>

Returns: void

Implementation of: IInternalMediaStream

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:95

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:105

addOnStateChange

▸ addOnStateChange(value: IAction0): void

Adds a handler that is raised when the stream state changes.

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:115

findSendEncodingIndex

▸ PrivatefindSendEncodingIndex(bitrateRequest: BitrateRequest): number

Parameters:

Name Type
bitrateRequest BitrateRequest

Returns: number

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

getCanonicalName

▸ getCanonicalName(): string

Gets the canonical name. Getting the value of MediaStream.CanonicalName is deprecated. Get the value of MediaStream.LocalCanonicalName instead.

Returns: string

Inherited from: WebRtcMediaStreamBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:176

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:95

getConnection

▸ getConnection(): WebRtcConnection

Returns: WebRtcConnection

Inherited from: WebRtcMediaStreamBase

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

getConnectionId

▸ getConnectionId(): string

Gets the connection identifier.

Returns: string

Inherited from: WebRtcMediaStreamBase

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

getControlTransportInfo

▸ getControlTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

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

getDirection

▸ getDirection(): StreamDirection

Gets the direction.

Returns: StreamDirection

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getDirectionCapabilities

▸ getDirectionCapabilities(): StreamDirection

Returns: StreamDirection

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

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: WebRtcMediaStreamBase

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

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: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:51

getExternalId

▸ getExternalId(): string

Gets the external identifier.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getId

▸ getId(): string

Gets the identifier.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getInfo

▸ getInfo(): MediaStreamInfo

Gets the media stream info.

Returns: MediaStreamInfo

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getInputMuted

▸ getInputMuted(): boolean

Returns: boolean

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

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

getIsTerminated

▸ getIsTerminated(): boolean

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

Returns: boolean

Inherited from: WebRtcMediaStreamBase

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

getIsTerminating

▸ getIsTerminating(): boolean

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

Returns: boolean

Inherited from: WebRtcMediaStreamBase

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

getIsTerminatingOrTerminated

▸ getIsTerminatingOrTerminated(): boolean

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

Returns: boolean

Inherited from: WebRtcMediaStreamBase

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

getLabel

▸ getLabel(): string

Gets a label that identifies this class.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:268

getLocalCanonicalName

▸ getLocalCanonicalName(): string

Gets the local canonical name.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getLocalDirection

▸ getLocalDirection(): StreamDirection

Gets current direction indicated by the local description.

Returns: StreamDirection

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getLocalMuted

▸ getLocalMuted(): boolean

Gets and value indicating if local is muted. Alias for [[fm.liveswitch.mediaStreamBase.muted]].

Returns: boolean

Inherited from: WebRtcMediaStreamBase

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

getLocalReceive

▸ getLocalReceive(): boolean

Gets a value indicating whether receiving media is supported by the local peer on this stream.

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getLocalSend

▸ getLocalSend(): boolean

Gets a value indicating whether sending media is supported by the local peer on this stream.

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getLocalTrack

▸ getLocalTrack(): TTrack

Returns: TTrack

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

getMaxReceiveBitrate

▸ getMaxReceiveBitrate(): number

Gets the maximum desired receive bitrate, 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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:308

getMaxSendBitrate

▸ getMaxSendBitrate(): number

Gets the maximum desired send bitrate, 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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:318

getMediaDescriptionId

▸ getMediaDescriptionId(): string

Gets the media description identifier.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getMuted

▸ getMuted(): boolean

Gets whether the input track is muted. Alias for [[fm.liveswitch.mediaStreamBase.inputMuted]].

Returns: boolean

Inherited from: WebRtcMediaStreamBase

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

getOutputMuted

▸ getOutputMuted(): boolean

Returns: boolean

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

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

getPreferredCodecs

▸ getPreferredCodecs(): string[]

Gets any preferred codecs, in order of preference.

Returns: string[]

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getRemoteBandwidth

▸ getRemoteBandwidth(): number

Gets the remote bandwidth, in kbps. This value is signalled in the remote session description received from the remote endpoint so we can limit our outbound media bitrate. 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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:360

getRemoteCanonicalName

▸ getRemoteCanonicalName(): string

Gets the remote canonical name.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getRemoteDirection

▸ getRemoteDirection(): StreamDirection

Gets current direction indicated by the remote description.

Returns: StreamDirection

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getRemoteEncoding

▸ getRemoteEncoding(): EncodingInfo

Gets the remote encoding.

Returns: EncodingInfo

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getRemoteMuted

▸ getRemoteMuted(): boolean

Gets a value indicating if remote is muted.

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getRemoteReceive

▸ getRemoteReceive(): boolean

Gets a value indicating whether receiving media is supported by the local 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: fm/Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:225

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:236

getRemoteTrack

▸ getRemoteTrack(): TTrack

Returns: TTrack

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

getRenegotiationPending

▸ ProtectedgetRenegotiationPending(): boolean

Gets whether there exist changes that are pending SDP renegotiation.

Returns: boolean

Inherited from: WebRtcMediaStreamBase

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

getSimulcastMode

▸ getSimulcastMode(): SimulcastMode

Returns: SimulcastMode

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

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

getState

▸ getState(): StreamState

Gets the state of the stream.

Returns: StreamState

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getTag

▸ getTag(): string

Gets optional data to associate with this instance.

Returns: string

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getTransportInfo

▸ getTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getType

▸ getType(): StreamType

Gets the type.

Returns: StreamType

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: WebRtcMediaStreamBase

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

populateInfo

▸ populateInfo(info: MediaStreamInfo): void

Parameters:

Name Type
info MediaStreamInfo

Returns: void

Overrides: WebRtcMediaStreamBase

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

processCachedChanges

▸ processCachedChanges(): void

Returns: void

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:511

processStateChange

▸ ProtectedprocessStateChange(): void

Processes a state change.

Returns: void

Inherited from: WebRtcMediaStreamBase

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

processStateLockChange

▸ ProtectedprocessStateLockChange(): void

Processes a state lock change.

Returns: void

Inherited from: WebRtcMediaStreamBase

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

raiseBitrateNotification

▸ raiseBitrateNotification(bitrateNotification: BitrateNotification): boolean

Parameters:

Name Type
bitrateNotification BitrateNotification

Returns: boolean

Implementation of: IInternalMediaStream

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

raiseBitrateRequest

▸ raiseBitrateRequest(bitrateRequest: BitrateRequest): boolean

Parameters:

Name Type
bitrateRequest BitrateRequest

Returns: boolean

Implementation of: IInternalMediaStream

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

raiseLocalEncodingDisabled

▸ ProtectedraiseLocalEncodingDisabled(encoding: EncodingInfo): void

Raises the OnLocalEncodingDisabled event.

Parameters:

Name Type Description
encoding EncodingInfo The encoding.

Returns: void

Inherited from: WebRtcMediaStreamBase

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

raiseLocalEncodingEnabled

▸ ProtectedraiseLocalEncodingEnabled(encoding: EncodingInfo): void

Raises the OnLocalEncodingEnabled event.

Parameters:

Name Type Description
encoding EncodingInfo The encoding.

Returns: void

Inherited from: WebRtcMediaStreamBase

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

remoteRequestedMaxSendBitrate

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

Parameters:

Name Type
sendEncodingIndex number
maxBitrate number

Returns: boolean

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

removeOnDirectionChange

▸ removeOnDirectionChange(value: IAction0): void

Removes a handler that is raised when the stream direction change has occurred.

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

removeOnDiscardBitrateNotification

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

Parameters:

Name Type
value IAction1<BitrateNotification>

Returns: void

Implementation of: IInternalMediaStream

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

removeOnDiscardBitrateRequest

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

Parameters:

Name Type
value IAction1<BitrateRequest>

Returns: void

Implementation of: IInternalMediaStream

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:457

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:467

removeOnStateChange

▸ removeOnStateChange(value: IAction0): void

Removes a handler that is raised when the stream state changes.

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

resetRemoteDirection

▸ resetRemoteDirection(): void

Returns: void

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:479

setConnection

▸ setConnection(remoteTrack: WebRtcConnection): void

Parameters:

Name Type
remoteTrack WebRtcConnection

Returns: void

Inherited from: WebRtcMediaStreamBase

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

setControlTransportInfo

▸ setControlTransportInfo(info: TransportInfo): void

Parameters:

Name Type
info TransportInfo

Returns: void

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

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: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:86

setExternalId

▸ setExternalId(value: string): void

Sets the external identifier.

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

setInputMuted

▸ setInputMuted(muted: boolean): void

Parameters:

Name Type
muted boolean

Returns: void

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:498

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:517

setLocalMuted

▸ setLocalMuted(value: boolean): void

Sets and value indicating if local is muted. Alias for [[fm.liveswitch.mediaStreamBase.muted]].

Parameters:

Name Type
value boolean

Returns: void

Inherited from: WebRtcMediaStreamBase

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

setLocalReceive

▸ setLocalReceive(value: boolean): void

Sets a value indicating whether receiving media is supported by the local peer on this stream.

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

setLocalSend

▸ setLocalSend(value: boolean): void

Sets a value indicating whether sending media is supported by the local peer on this stream.

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

setLocalTrack

▸ setLocalTrack(localTrack: TTrack): void

Parameters:

Name Type
localTrack TTrack

Returns: void

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

setMaxReceiveBitrate

▸ setMaxReceiveBitrate(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

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

setMaxSendBitrate

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

Parameters:

Name Type
value number

Returns: Future<object>

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

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

setMuted

▸ setMuted(value: boolean): void

Sets whether the input track is muted. Alias for [[fm.liveswitch.mediaStreamBase.inputMuted]].

Parameters:

Name Type
value boolean

Returns: void

Inherited from: WebRtcMediaStreamBase

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

setOutputMuted

▸ setOutputMuted(muted: boolean): void

Parameters:

Name Type
muted boolean

Returns: void

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:599

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 so we can limit our outbound media bitrate. 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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:609

setRemoteEncoding

▸ setRemoteEncoding(value: EncodingInfo): void

Sets the remote encoding.

Parameters:

Name Type
value EncodingInfo

Returns: void

Implementation of: IInternalMediaStream

Inherited from: WebRtcMediaStreamBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:650

setRemoteTrack

▸ setRemoteTrack(remoteTrack: TTrack): void

Parameters:

Name Type
remoteTrack TTrack

Returns: void

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:660

setSimulcastMode

▸ setSimulcastMode(value: SimulcastMode): void

Parameters:

Name Type
value SimulcastMode

Returns: void

Implementation of: IInternalMediaStream

Overrides: WebRtcMediaStreamBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:531

setTransportInfo

▸ setTransportInfo(transportInfo: TransportInfo): void

Parameters:

Name Type
transportInfo TransportInfo

Returns: void

Inherited from: WebRtcMediaStreamBase

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

toString

▸ toString(): string

Returns a string that represents this instance.

Returns: string

Inherited from: WebRtcMediaStreamBase

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

unsetDynamicValue

▸ unsetDynamicValue(key: string): boolean

Unsets 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.

Returns: boolean

true if the value was removed; otherwise, false.

Inherited from: WebRtcMediaStreamBase

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