/ fm / liveswitch / PluginMediaTrack

Class: PluginMediaTrack

fm.liveswitch.PluginMediaTrack

Hierarchy

• Dynamic

  ↳ PluginMediaTrack

  ↳↳ PluginAudioTrack

  ↳↳ PluginVideoTrack

Implements

• IMediaTrack
• IInternalMediaTrack

Table of contents

Constructors

• constructor

Methods

• addOnDestroyed
• addOnMuted
• addOnStarted
• addOnStopped
• addOnUnmuted
• changeSinkOutput
• changeSourceInput
• destroy
• getDynamicProperties
• getDynamicValue
• getMedia
• getMuted
• getSinkOutput
• getSinkOutputs
• getSourceInput
• getSourceInputs
• getTypeString
• removeOnDestroyed
• removeOnMuted
• removeOnStarted
• removeOnStopped
• removeOnUnmuted
• setDynamicValue
• setMuted
• setSinkOutput
• setSourceInput
• unsetDynamicValue

Constructors

constructor

+ new PluginMediaTrack(media: PluginMedia): PluginMediaTrack

Parameters:

Name	Type
media	PluginMedia

Returns: PluginMediaTrack

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:15

Methods

addOnDestroyed

▸ AbstractaddOnDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:33

---

addOnMuted

▸ AbstractaddOnMuted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:29

---

addOnStarted

▸ AbstractaddOnStarted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

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

---

addOnStopped

▸ AbstractaddOnStopped(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:32

---

addOnUnmuted

▸ AbstractaddOnUnmuted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:30

---

changeSinkOutput

▸ AbstractchangeSinkOutput(sinkOutput: SinkOutput): Future<Object>

Parameters:

Name	Type
sinkOutput	SinkOutput

Returns: Future<Object>

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:21

---

changeSourceInput

▸ AbstractchangeSourceInput(sourceInput: SourceInput): Future<Object>

Parameters:

Name	Type
sourceInput	SourceInput

Returns: Future<Object>

Implementation of: IInternalMediaTrack

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

---

destroy

▸ destroy(): boolean

Returns: boolean

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:24

---

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

---

getMedia

▸ getMedia(): PluginMedia

Returns: PluginMedia

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

---

getMuted

▸ AbstractgetMuted(): boolean

Returns: boolean

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:40

---

getSinkOutput

▸ AbstractgetSinkOutput(): SinkOutput

Returns: SinkOutput

Implementation of: IInternalMediaTrack

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

---

getSinkOutputs

▸ AbstractgetSinkOutputs(): Future<SinkOutput[]>

Returns: Future<SinkOutput[]>

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:42

---

getSourceInput

▸ AbstractgetSourceInput(): SourceInput

Returns: SourceInput

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:43

---

getSourceInputs

▸ AbstractgetSourceInputs(): Future<SourceInput[]>

Returns: Future<SourceInput[]>

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:44

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

---

removeOnDestroyed

▸ AbstractremoveOnDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:38

---

removeOnMuted

▸ AbstractremoveOnMuted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:34

---

removeOnStarted

▸ AbstractremoveOnStarted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:36

---

removeOnStopped

▸ AbstractremoveOnStopped(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

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

---

removeOnUnmuted

▸ AbstractremoveOnUnmuted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

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

---

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

---

setMuted

▸ AbstractsetMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalMediaTrack

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

---

setSinkOutput

▸ AbstractsetSinkOutput(value: SinkOutput): void

Parameters:

Name	Type
value	SinkOutput

Returns: void

Implementation of: IInternalMediaTrack

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

---

setSourceInput

▸ AbstractsetSourceInput(value: SourceInput): void

Parameters:

Name	Type
value	SourceInput

Returns: void

Implementation of: IInternalMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaTrack.ts:47

---

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