/ fm / liveswitch / WebRtcDataStream

Class: WebRtcDataStream

fm.liveswitch.WebRtcDataStream

Hierarchy

Implements

Table of contents

Constructors

Methods

Constructors

constructor

+ new WebRtcDataStream(external: IExternalDataStream, channels: WebRtcDataChannel[]): WebRtcDataStream

Parameters:

Name Type
external IExternalDataStream
channels WebRtcDataChannel[]

Returns: WebRtcDataStream

Inherited from: WebRtcDataStreamBase

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

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: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

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: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

attachToChannel

▸ ProtectedattachToChannel(channel: WebRtcDataChannel): void

Attaches a data channel to this stream (events and IDs).

Parameters:

Name Type
channel WebRtcDataChannel

Returns: void

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:46

changeDirection

▸ changeDirection(newDirection: StreamDirection): Error

Changes this stream's direction

Parameters:

Name Type
newDirection StreamDirection

Returns: Error

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

getBytesReceived

▸ getBytesReceived(): number

Gets the number of bytes received.

Returns: number

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:72

getBytesSent

▸ getBytesSent(): number

Gets the number of bytes sent.

Returns: number

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:82

getCanonicalName

▸ getCanonicalName(): string

Gets the canonical name. Getting the value of DataStream.CanonicalName is deprecated and will be removed in a future release.

Returns: string

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:92

getChannels

▸ getChannels(): WebRtcDataChannel[]

Returns: WebRtcDataChannel[]

Implementation of: IInternalDataStream

Overrides: WebRtcDataStreamBase

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

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: WebRtcDataStreamBase

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

getConnection

▸ getConnection(): WebRtcConnection

Returns: WebRtcConnection

Inherited from: WebRtcDataStreamBase

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

getConnectionId

▸ getConnectionId(): string

Gets the connection identifier.

Returns: string

Inherited from: WebRtcDataStreamBase

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

getDirection

▸ getDirection(): StreamDirection

Gets the current direction.

Returns: StreamDirection

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:107

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: WebRtcDataStreamBase

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: WebRtcDataStreamBase

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

getExternalId

▸ getExternalId(): string

Gets the external identifier.

Returns: string

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

getId

▸ getId(): string

Gets the identifier.

Returns: string

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

getInfo

▸ getInfo(): DataStreamInfo

Gets the data stream info.

Returns: DataStreamInfo

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:133

getIsTerminated

▸ getIsTerminated(): boolean

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

Returns: boolean

Inherited from: WebRtcDataStreamBase

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: WebRtcDataStreamBase

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: WebRtcDataStreamBase

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

getLabel

▸ getLabel(): string

Gets a label that identifies this class.

Returns: string

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:157

getLocalDirection

▸ getLocalDirection(): StreamDirection

Gets the current direction.

Returns: StreamDirection

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:167

getLocalReceive

▸ getLocalReceive(): boolean

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

Returns: boolean

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

getMediaDescriptionId

▸ getMediaDescriptionId(): string

Gets the media description identifier.

Returns: string

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

getMessagesReceived

▸ getMessagesReceived(): number

Gets the number of messages received.

Returns: number

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:177

getMessagesSent

▸ getMessagesSent(): number

Gets the number of messages sent.

Returns: number

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:187

getRemoteDirection

▸ getRemoteDirection(): StreamDirection

Gets the current direction.

Returns: StreamDirection

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:197

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: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

getState

▸ getState(): StreamState

Gets the state of the stream.

Returns: StreamState

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

getTransportInfo

▸ getTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

getType

▸ getType(): StreamType

Gets the type.

Returns: StreamType

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: WebRtcDataStreamBase

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

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/WebRtcDataStream.ts:8

processStateChange

▸ ProtectedprocessStateChange(): void

Processes a state change.

Returns: void

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:207

processStateLockChange

▸ ProtectedprocessStateLockChange(): void

Processes a state lock change.

Returns: void

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:233

registerDataReceived

▸ ProtectedregisterDataReceived(dataLength: number): void

Registers that a data has been received.

Parameters:

Name Type Description
dataLength number The data length.

Returns: void

Inherited from: WebRtcDataStreamBase

Defined in: fm/Generated/TypeScript/fm.liveswitch/WebRtcDataStreamBase.ts:252

registerDataSent

▸ ProtectedregisterDataSent(dataLength: number): void

Registers that a data has been received.

Parameters:

Name Type Description
dataLength number The data length.

Returns: void

Inherited from: WebRtcDataStreamBase

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

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: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

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: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

setConnection

▸ setConnection(remoteTrack: WebRtcConnection): void

Parameters:

Name Type
remoteTrack WebRtcConnection

Returns: void

Inherited from: WebRtcDataStreamBase

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

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: WebRtcDataStreamBase

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: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

setLocalDirection

▸ setLocalDirection(value: StreamDirection): void

Sets the current direction.

Parameters:

Name Type
value StreamDirection

Returns: void

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

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: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

setTag

▸ setTag(value: string): void

Sets optional data to associate with this instance.

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalDataStream

Inherited from: WebRtcDataStreamBase

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

setTransportInfo

▸ setTransportInfo(transportInfo: TransportInfo): void

Parameters:

Name Type
transportInfo TransportInfo

Returns: void

Inherited from: WebRtcDataStreamBase

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

toString

▸ toString(): string

Returns a string that represents this instance.

Returns: string

Inherited from: WebRtcDataStreamBase

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: WebRtcDataStreamBase

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