/ fm / liveswitch / WebRtcStream

Class: WebRtcStream

fm.liveswitch.WebRtcStream

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new WebRtcStream(type: StreamType): WebRtcStream

Initializes a new instance of the [[fm.liveswitch.streamBase]] class.

Parameters:

Name Type Description
type StreamType The type.

Returns: WebRtcStream

Inherited from: WebRtcStreamBase

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

Properties

_mediaDescriptionManager

• Private _mediaDescriptionManager: MediaDescriptionManager

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

_transportInfo

• Private _transportInfo: TransportInfo

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

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

Inherited from: WebRtcStreamBase

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

Inherited from: WebRtcStreamBase

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

changeDirection

▸ AbstractchangeDirection(newDirection: StreamDirection): Error

Changes this stream's direction.

Parameters:

Name Type
newDirection StreamDirection

Returns: Error

Implementation of: IInternalStream

Inherited from: WebRtcStreamBase

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

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

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

getConnection

▸ getConnection(): WebRtcConnection

Returns: WebRtcConnection

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

getConnectionId

▸ getConnectionId(): string

Gets the connection identifier.

Returns: string

Inherited from: WebRtcStreamBase

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

getDirection

▸ AbstractgetDirection(): StreamDirection

Gets the current direction.

Returns: StreamDirection

Implementation of: IInternalStream

Inherited from: WebRtcStreamBase

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

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: WebRtcStreamBase

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

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

getExternalId

▸ getExternalId(): string

Gets the external identifier.

Returns: string

Implementation of: IInternalStream

Inherited from: WebRtcStreamBase

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

getId

▸ getId(): string

Gets the identifier.

Returns: string

Implementation of: IInternalStream

Inherited from: WebRtcStreamBase

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

getIsTerminated

▸ getIsTerminated(): boolean

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

Returns: boolean

Inherited from: WebRtcStreamBase

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

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

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

getLabel

▸ AbstractgetLabel(): string

Gets a label that identifies this class.

Returns: string

Implementation of: IInternalStream

Inherited from: WebRtcStreamBase

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

getLocalDirection

▸ AbstractgetLocalDirection(): StreamDirection

Gets current direction indicated by the local description.

Returns: StreamDirection

Implementation of: IInternalStream

Inherited from: WebRtcStreamBase

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

getLocalReceive

▸ getLocalReceive(): boolean

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

Returns: boolean

Implementation of: IInternalStream

Inherited from: WebRtcStreamBase

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

Inherited from: WebRtcStreamBase

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

getMediaDescriptionId

▸ getMediaDescriptionId(): string

Gets the media description identifier.

Returns: string

Implementation of: IInternalStream

Inherited from: WebRtcStreamBase

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

getRemoteDirection

▸ AbstractgetRemoteDirection(): StreamDirection

Gets current direction indicated by the remote description.

Returns: StreamDirection

Implementation of: IInternalStream

Inherited from: WebRtcStreamBase

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

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

Inherited from: WebRtcStreamBase

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

Inherited from: WebRtcStreamBase

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

getState

▸ getState(): StreamState

Gets the state of the stream.

Returns: StreamState

Implementation of: IInternalStream

Inherited from: WebRtcStreamBase

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

Inherited from: WebRtcStreamBase

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

getTransportInfo

▸ getTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalStream

Overrides: WebRtcStreamBase

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

getType

▸ getType(): StreamType

Gets the type.

Returns: StreamType

Implementation of: IInternalStream

Inherited from: WebRtcStreamBase

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

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: WebRtcStreamBase

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

processStateChange

▸ ProtectedprocessStateChange(): void

Processes a state change.

Returns: void

Inherited from: WebRtcStreamBase

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

processStateLockChange

▸ ProtectedprocessStateLockChange(): void

Processes a state lock change.

Returns: void

Inherited from: WebRtcStreamBase

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

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

Inherited from: WebRtcStreamBase

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

Inherited from: WebRtcStreamBase

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

setConnection

▸ setConnection(remoteTrack: WebRtcConnection): void

Parameters:

Name Type
remoteTrack WebRtcConnection

Returns: void

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

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

Inherited from: WebRtcStreamBase

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

setLocalDirection

▸ AbstractsetLocalDirection(value: StreamDirection): void

Sets current direction indicated by the local description.

Parameters:

Name Type
value StreamDirection

Returns: void

Implementation of: IInternalStream

Inherited from: WebRtcStreamBase

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

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

Inherited from: WebRtcStreamBase

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

Inherited from: WebRtcStreamBase

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

Inherited from: WebRtcStreamBase

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

setTransportInfo

▸ setTransportInfo(transportInfo: TransportInfo): void

Parameters:

Name Type
transportInfo TransportInfo

Returns: void

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

toString

▸ toString(): string

Returns a string that represents this instance.

Returns: string

Inherited from: WebRtcStreamBase

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

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