/ fm / liveswitch / MediaTrack

Class: MediaTrack

fm.liveswitch.MediaTrack

Hierarchy

Implements

Table of contents

Constructors

Methods

Constructors

constructor

+ new MediaTrack(media: Media): MediaTrack

Parameters:

Name Type
media Media

Returns: MediaTrack

Inherited from: Dynamic

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

Methods

addOnDestroyed

▸ addOnDestroyed(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalMediaTrack

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaTrack.ts:28

addOnStarted

▸ addOnStarted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalMediaTrack

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

addOnStopped

▸ addOnStopped(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalMediaTrack

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaTrack.ts:25

changeSinkOutput

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

Parameters:

Name Type
sinkOutput SinkOutput

Returns: Future<Object>

Implementation of: IExternalMediaTrack

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

changeSourceInput

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

Parameters:

Name Type
sourceInput SourceInput

Returns: Future<Object>

Implementation of: IExternalMediaTrack

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

destroy

▸ destroy(): boolean

Returns: boolean

Implementation of: IExternalMediaTrack

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

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: Dynamic

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

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: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:51

getMedia

▸ getMedia(): Media

Returns: Media

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

getMuted

▸ getMuted(): boolean

Returns: boolean

Implementation of: IExternalMediaTrack

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

getSinkOutput

▸ getSinkOutput(): SinkOutput

Returns: SinkOutput

Implementation of: IExternalMediaTrack

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaTrack.ts:53

getSinkOutputs

▸ getSinkOutputs(): Future<SinkOutput[]>

Returns: Future<SinkOutput[]>

Implementation of: IExternalMediaTrack

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaTrack.ts:56

getSourceInput

▸ getSourceInput(): SourceInput

Returns: SourceInput

Implementation of: IExternalMediaTrack

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaTrack.ts:59

getSourceInputs

▸ getSourceInputs(): Future<SourceInput[]>

Returns: Future<SourceInput[]>

Implementation of: IExternalMediaTrack

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaTrack.ts:62

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

removeOnDestroyed

▸ removeOnDestroyed(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalMediaTrack

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

removeOnStarted

▸ removeOnStarted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalMediaTrack

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

removeOnStopped

▸ removeOnStopped(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalMediaTrack

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

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: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:86

setMuted

▸ setMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IExternalMediaTrack

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaTrack.ts:65

setSinkOutput

▸ setSinkOutput(value: SinkOutput): void

Parameters:

Name Type
value SinkOutput

Returns: void

Implementation of: IExternalMediaTrack

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaTrack.ts:68

setSourceInput

▸ setSourceInput(value: SourceInput): void

Parameters:

Name Type
value SourceInput

Returns: void

Implementation of: IExternalMediaTrack

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

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

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