/ fm / liveswitch / PluginDataStream

Class: PluginDataStream

fm.liveswitch.PluginDataStream

Hierarchy

• PluginStream

  ↳ PluginDataStream

Implements

• IDataStream<PluginDataChannel>
• IInternalDataStream

Table of contents

Constructors

• constructor

Properties

• _state

Methods

• addChannel
• addOnDirectionChange
• addOnStateChange
• changeDirection
• getAllChannels
• getChannels
• getDirection
• getDynamicProperties
• getDynamicValue
• getExternalId
• getHandle
• getId
• getInfo
• getLabel
• getLocalDirection
• getLocalReceive
• getLocalSend
• getMediaDescriptionId
• getRemoteDirection
• getRemoteReceive
• getRemoteSend
• getState
• getTag
• getTransportInfo
• getType
• getTypeString
• removeOnDirectionChange
• removeOnStateChange
• setDynamicValue
• setExternalId
• setLocalDirection
• setLocalReceive
• setLocalSend
• setTag
• unsetDynamicValue

Constructors

constructor

+ new PluginDataStream(external: IExternalDataStream, channels: PluginDataChannel[]): PluginDataStream

Parameters:

Name	Type
external	IExternalDataStream
channels	PluginDataChannel[]

Returns: PluginDataStream

Inherited from: PluginStream

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

Properties

_state

• Private _state: StreamState

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

Methods

addChannel

▸ addChannel(channel: IInternalDataChannel): void

Parameters:

Name	Type
channel	IInternalDataChannel

Returns: void

Implementation of: IInternalDataStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:172

---

addOnDirectionChange

▸ addOnDirectionChange(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:136

---

addOnStateChange

▸ addOnStateChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalDataStream

Overrides: PluginStream

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

---

changeDirection

▸ changeDirection(newDirection: StreamDirection): Error

Parameters:

Name	Type
newDirection	StreamDirection

Returns: Error

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:100

---

getAllChannels

▸ getAllChannels(): PluginDataChannel[]

Returns: PluginDataChannel[]

Implementation of: IInternalDataStream

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

---

getChannels

▸ getChannels(): PluginDataChannel[]

Returns: PluginDataChannel[]

Implementation of: IInternalDataStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:142

---

getDirection

▸ getDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalDataStream

Overrides: PluginStream

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

---

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: PluginStream

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

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

---

getExternalId

▸ getExternalId(): string

Returns: string

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:109

---

getHandle

▸ getHandle(): number

Returns: number

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:96

---

getId

▸ getId(): string

Returns: string

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:106

---

getInfo

▸ getInfo(): DataStreamInfo

Returns: DataStreamInfo

Implementation of: IInternalDataStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:69

---

getLabel

▸ getLabel(): string

Returns: string

Implementation of: IInternalDataStream

Overrides: PluginStream

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

---

getLocalDirection

▸ getLocalDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalDataStream

Overrides: PluginStream

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

---

getLocalReceive

▸ getLocalReceive(): boolean

Returns: boolean

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:73

---

getLocalSend

▸ getLocalSend(): boolean

Returns: boolean

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:76

---

getMediaDescriptionId

▸ getMediaDescriptionId(): string

Returns: string

Implementation of: IInternalDataStream

Overrides: PluginStream

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

---

getRemoteDirection

▸ getRemoteDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalDataStream

Overrides: PluginStream

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

---

getRemoteReceive

▸ getRemoteReceive(): boolean

Returns: boolean

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:79

---

getRemoteSend

▸ getRemoteSend(): boolean

Returns: boolean

Implementation of: IInternalDataStream

Overrides: PluginStream

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

---

getState

▸ getState(): StreamState

Returns: StreamState

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:59

---

getTag

▸ getTag(): string

Returns: string

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:124

---

getTransportInfo

▸ getTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalDataStream

Overrides: PluginStream

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

---

getType

▸ getType(): StreamType

Returns: StreamType

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:127

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:7

---

removeOnDirectionChange

▸ removeOnDirectionChange(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:139

---

removeOnStateChange

▸ removeOnStateChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:65

---

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

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

---

setExternalId

▸ setExternalId(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:112

---

setLocalDirection

▸ setLocalDirection(value: StreamDirection): void

Parameters:

Name	Type
value	StreamDirection

Returns: void

Implementation of: IInternalDataStream

Overrides: PluginStream

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

---

setLocalReceive

▸ setLocalReceive(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:85

---

setLocalSend

▸ setLocalSend(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalDataStream

Overrides: PluginStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginDataStream.ts:88

---

setTag

▸ setTag(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IInternalDataStream

Overrides: PluginStream

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

---

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

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