/ fm / liveswitch / Stream

Class: Stream

fm.liveswitch.Stream

Hierarchy

• Dynamic

  ↳ Stream

  ↳↳ MediaStream

  ↳↳ DataStream

Implements

• IExternalStream

Table of contents

Constructors

• constructor

Methods

• addOnDirectionChange
• addOnStateChange
• changeDirection
• getDirection
• getDynamicProperties
• getDynamicValue
• getEncryptionPolicy
• getExternalId
• getId
• 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 Stream(): Stream

Returns: Stream

Inherited from: Dynamic

Methods

addOnDirectionChange

▸ addOnDirectionChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IExternalStream

---

addOnStateChange

▸ addOnStateChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IExternalStream

---

changeDirection

▸ changeDirection(newDirection: StreamDirection): Error

Parameters:

Name	Type
newDirection	StreamDirection

Returns: Error

Implementation of: IExternalStream

---

getDirection

▸ getDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IExternalStream

---

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: Dynamic

---

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

---

getEncryptionPolicy

▸ getEncryptionPolicy(): EncryptionPolicy

Returns: EncryptionPolicy

---

getExternalId

▸ getExternalId(): string

Returns: string

Implementation of: IExternalStream

---

getId

▸ getId(): string

Returns: string

Implementation of: IExternalStream

---

getLabel

▸ getLabel(): string

Returns: string

Implementation of: IExternalStream

---

getLocalDirection

▸ getLocalDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IExternalStream

---

getLocalReceive

▸ getLocalReceive(): boolean

Returns: boolean

Implementation of: IExternalStream

---

getLocalSend

▸ getLocalSend(): boolean

Returns: boolean

Implementation of: IExternalStream

---

getMediaDescriptionId

▸ getMediaDescriptionId(): string

Returns: string

Implementation of: IExternalStream

---

getRemoteDirection

▸ getRemoteDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IExternalStream

---

getRemoteReceive

▸ getRemoteReceive(): boolean

Returns: boolean

Implementation of: IExternalStream

---

getRemoteSend

▸ getRemoteSend(): boolean

Returns: boolean

Implementation of: IExternalStream

---

getState

▸ getState(): StreamState

Returns: StreamState

Implementation of: IExternalStream

---

getTag

▸ getTag(): string

Returns: string

Implementation of: IExternalStream

---

getTransportInfo

▸ getTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IExternalStream

---

getType

▸ getType(): StreamType

Returns: StreamType

Implementation of: IExternalStream

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

---

removeOnDirectionChange

▸ removeOnDirectionChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IExternalStream

---

removeOnStateChange

▸ removeOnStateChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IExternalStream

---

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

---

setExternalId

▸ setExternalId(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IExternalStream

---

setLocalDirection

▸ setLocalDirection(value: StreamDirection): void

Parameters:

Name	Type
value	StreamDirection

Returns: void

Implementation of: IExternalStream

---

setLocalReceive

▸ setLocalReceive(receiveEnabled: boolean): void

Parameters:

Name	Type
receiveEnabled	boolean

Returns: void

Implementation of: IExternalStream

---

setLocalSend

▸ setLocalSend(sendEnabled: boolean): void

Parameters:

Name	Type
sendEnabled	boolean

Returns: void

Implementation of: IExternalStream

---

setTag

▸ setTag(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IExternalStream

---

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