/ fm / liveswitch / WebRtcMediaTrackBase

Class: WebRtcMediaTrackBase

fm.liveswitch.WebRtcMediaTrackBase

Media track base properties/methods.

Hierarchy

• Dynamic

  ↳ WebRtcMediaTrackBase

  ↳↳ WebRtcMediaTrack

Implements

• IMediaTrack

Table of contents

Constructors

• constructor

Methods

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

Constructors

constructor

+ new WebRtcMediaTrackBase(): WebRtcMediaTrackBase

Returns: WebRtcMediaTrackBase

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:12

Methods

addOnDestroyed

▸ AbstractaddOnDestroyed(value: IAction0): void

Adds a handler that is raised when the track is destroyed.

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IMediaTrack

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

---

addOnMuted

▸ AbstractaddOnMuted(value: IAction0): void

Adds a handler that is raised when the track is muted. Only applicable for local media tracks.

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IMediaTrack

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

---

addOnStarted

▸ AbstractaddOnStarted(value: IAction0): void

Adds a handler that is raised when the track is started. Only applicable for local media tracks.

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IMediaTrack

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

---

addOnStopped

▸ AbstractaddOnStopped(value: IAction0): void

Adds a handler that is raised when the track is stopped. Only applicable for local media tracks.

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:50

---

addOnUnmuted

▸ AbstractaddOnUnmuted(value: IAction0): void

Adds a handler that is raised when the track is unmuted. Only applicable for local media tracks.

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:57

---

changeSinkOutput

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

Changes the sink output while the media track is active.

Parameters:

Name	Type	Description
sinkOutput	SinkOutput	The sink output.

Returns: Future<Object>

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:64

---

changeSourceInput

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

Changes the source input while the media track is active.

Parameters:

Name	Type	Description
sourceInput	SourceInput	The source input.

Returns: Future<Object>

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:71

---

destroy

▸ Abstractdestroy(): boolean

Destroys this media track.

Returns: boolean

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:77

---

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

---

getMuted

▸ AbstractgetMuted(): boolean

Gets a value indicating whether this track is muted.

Returns: boolean

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:84

---

getSinkOutput

▸ AbstractgetSinkOutput(): SinkOutput

Gets the current sink output.

Returns: SinkOutput

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:90

---

getSinkOutputs

▸ AbstractgetSinkOutputs(): Future<SinkOutput[]>

Gets the available sink outputs.

Returns: Future<SinkOutput[]>

A future with an array of sink outputs.

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:99

---

getSourceInput

▸ AbstractgetSourceInput(): SourceInput

Gets the current source input.

Returns: SourceInput

Implementation of: IMediaTrack

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

---

getSourceInputs

▸ AbstractgetSourceInputs(): Future<SourceInput[]>

Gets the available source inputs.

Returns: Future<SourceInput[]>

A future with an array of source inputs.

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:114

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

---

removeOnDestroyed

▸ AbstractremoveOnDestroyed(value: IAction0): void

Removes a handler that is raised when the track is destroyed.

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:120

---

removeOnMuted

▸ AbstractremoveOnMuted(value: IAction0): void

Removes a handler that is raised when the track is muted. Only applicable for local media tracks.

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IMediaTrack

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

---

removeOnStarted

▸ AbstractremoveOnStarted(value: IAction0): void

Removes a handler that is raised when the track is started. Only applicable for local media tracks.

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:134

---

removeOnStopped

▸ AbstractremoveOnStopped(value: IAction0): void

Removes a handler that is raised when the track is stopped. Only applicable for local media tracks.

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:141

---

removeOnUnmuted

▸ AbstractremoveOnUnmuted(value: IAction0): void

Removes a handler that is raised when the track is unmuted. Only applicable for local media tracks.

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:148

---

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

Sets a value indicating whether this track is muted.

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:155

---

setSinkOutput

▸ AbstractsetSinkOutput(value: SinkOutput): void

Sets the current sink output.

Parameters:

Name	Type
value	SinkOutput

Returns: void

Implementation of: IMediaTrack

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

---

setSourceInput

▸ AbstractsetSourceInput(value: SourceInput): void

Sets the current source input.

Parameters:

Name	Type
value	SourceInput

Returns: void

Implementation of: IMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrackBase.ts:167

---

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