/ fm / liveswitch / MediaSinkBase

Class: MediaSinkBase

fm.liveswitch.MediaSinkBase

Media sink base properties/methods.

Hierarchy

• Dynamic

  ↳ MediaSinkBase

Table of contents

Constructors

• constructor

Methods

• getDynamicProperties
• getDynamicValue
• getExternalId
• getId
• getTag
• getTypeString
• setDynamicValue
• setExternalId
• setTag
• unsetDynamicValue

Constructors

constructor

+ new MediaSinkBase(): MediaSinkBase

Returns: MediaSinkBase

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkBase.ts:18

Methods

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: Dynamic

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

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

---

getExternalId

▸ getExternalId(): string

Gets the external identifier.

Returns: string

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

---

getId

▸ getId(): string

Gets the identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkBase.ts:49

---

getTag

▸ getTag(): string

Gets optional data to associate with this instance.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkBase.ts:61

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

---

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

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

---

setExternalId

▸ setExternalId(value: string): void

Sets the external identifier.

Parameters:

Name	Type
value	string

Returns: void

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

---

setTag

▸ setTag(value: string): void

Sets optional data to associate with this instance.

Parameters:

Name	Type
value	string

Returns: void

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

---

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

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