/ fm / liveswitch / WebRtcMediaTrack

Class: WebRtcMediaTrack

fm.liveswitch.WebRtcMediaTrack

Hierarchy

• WebRtcMediaTrackBase

  ↳ WebRtcMediaTrack

  ↳↳ WebRtcAudioTrack

  ↳↳ WebRtcVideoTrack

Implements

• IMediaTrack
• IInternalMediaTrack

Table of contents

Constructors

• constructor

Properties

• _muted

Methods

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

Constructors

constructor

+ new WebRtcMediaTrack(external: IExternalMediaTrack, media: WebRtcMedia<WebRtcAudioTrack, WebRtcVideoTrack>): WebRtcMediaTrack

Parameters:

Name	Type
external	IExternalMediaTrack
media	WebRtcMedia<WebRtcAudioTrack, WebRtcVideoTrack>

Returns: WebRtcMediaTrack

Inherited from: WebRtcMediaTrackBase

Properties

_muted

• Private _muted: boolean= false

Methods

addOnDestroyed

▸ addOnDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Overrides: WebRtcMediaTrackBase

---

addOnStarted

▸ addOnStarted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Overrides: WebRtcMediaTrackBase

---

addOnStopped

▸ addOnStopped(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Overrides: WebRtcMediaTrackBase

---

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

Inherited from: WebRtcMediaTrackBase

---

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

Inherited from: WebRtcMediaTrackBase

---

destroy

▸ destroy(): boolean

Returns: boolean

Implementation of: IInternalMediaTrack

Overrides: WebRtcMediaTrackBase

---

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: WebRtcMediaTrackBase

---

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

---

getMedia

▸ getMedia(): WebRtcMedia<WebRtcAudioTrack, WebRtcVideoTrack>

Returns: WebRtcMedia<WebRtcAudioTrack, WebRtcVideoTrack>

---

getMuted

▸ getMuted(): boolean

Returns: boolean

Implementation of: IInternalMediaTrack

Overrides: WebRtcMediaTrackBase

---

getSinkOutput

▸ AbstractgetSinkOutput(): SinkOutput

Gets the current sink output.

Returns: SinkOutput

Implementation of: IInternalMediaTrack

Inherited from: WebRtcMediaTrackBase

---

getSinkOutputs

▸ AbstractgetSinkOutputs(): Future<SinkOutput[]>

Gets the available sink outputs.

Returns: Future<SinkOutput[]>

A future with an array of sink outputs.

Implementation of: IInternalMediaTrack

Inherited from: WebRtcMediaTrackBase

---

getSourceInput

▸ AbstractgetSourceInput(): SourceInput

Gets the current source input.

Returns: SourceInput

Implementation of: IInternalMediaTrack

Inherited from: WebRtcMediaTrackBase

---

getSourceInputs

▸ AbstractgetSourceInputs(): Future<SourceInput[]>

Gets the available source inputs.

Returns: Future<SourceInput[]>

A future with an array of source inputs.

Implementation of: IInternalMediaTrack

Inherited from: WebRtcMediaTrackBase

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: WebRtcMediaTrackBase

---

raiseOnStopped

▸ PrivateraiseOnStopped(): void

Returns: void

---

removeOnDestroyed

▸ removeOnDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Overrides: WebRtcMediaTrackBase

---

removeOnStarted

▸ removeOnStarted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Overrides: WebRtcMediaTrackBase

---

removeOnStopped

▸ removeOnStopped(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaTrack

Overrides: WebRtcMediaTrackBase

---

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

---

setMuted

▸ setMuted(muted: boolean): void

Parameters:

Name	Type
muted	boolean

Returns: void

Implementation of: IInternalMediaTrack

Overrides: WebRtcMediaTrackBase

---

setSinkOutput

▸ AbstractsetSinkOutput(value: SinkOutput): void

Sets the current sink output.

Parameters:

Name	Type
value	SinkOutput

Returns: void

Implementation of: IInternalMediaTrack

Inherited from: WebRtcMediaTrackBase

---

setSourceInput

▸ AbstractsetSourceInput(value: SourceInput): void

Sets the current source input.

Parameters:

Name	Type
value	SourceInput

Returns: void

Implementation of: IInternalMediaTrack

Inherited from: WebRtcMediaTrackBase

---

stop

▸ stop(): void

Returns: void

---

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