/ fm / liveswitch / PluginVideoTrack

Class: PluginVideoTrack

fm.liveswitch.PluginVideoTrack

Hierarchy

Implements

Table of contents

Constructors

Methods

Constructors

constructor

+ new PluginVideoTrack(external: IExternalVideoTrack, media: PluginMedia): PluginVideoTrack

Parameters:

Name Type
external IExternalVideoTrack
media PluginMedia

Returns: PluginVideoTrack

Inherited from: PluginMediaTrack

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

Methods

addOnDestroyed

▸ addOnDestroyed(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:48

addOnMuted

▸ addOnMuted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

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

addOnSize

▸ addOnSize(value: IAction1<Size>): void

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IInternalVideoTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:129

addOnSizeChange

▸ addOnSizeChange(value: IAction1<Size>): void

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IInternalVideoTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:132

addOnStarted

▸ addOnStarted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

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

addOnStopped

▸ addOnStopped(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

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

addOnUnmuted

▸ addOnUnmuted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

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

changeSinkOutput

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

Parameters:

Name Type
sinkOutput SinkOutput

Returns: Future<Object>

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:79

changeSourceInput

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

Parameters:

Name Type
sourceInput SourceInput

Returns: Future<Object>

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:104

destroy

▸ destroy(): boolean

Returns: boolean

Implementation of: IInternalVideoTrack

Inherited from: PluginMediaTrack

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

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

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

getMedia

▸ getMedia(): PluginMedia

Returns: PluginMedia

Inherited from: PluginMediaTrack

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

getMuted

▸ getMuted(): boolean

Returns: boolean

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:135

getSinkOutput

▸ getSinkOutput(): SinkOutput

Returns: SinkOutput

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

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

getSinkOutputs

▸ getSinkOutputs(): Future<SinkOutput[]>

Returns: Future<SinkOutput[]>

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:91

getSize

▸ getSize(): Size

Returns: Size

Implementation of: IInternalVideoTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:138

getSourceInput

▸ getSourceInput(): SourceInput

Returns: SourceInput

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:110

getSourceInputs

▸ getSourceInputs(): Future<SourceInput[]>

Returns: Future<SourceInput[]>

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:116

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: PluginMediaTrack

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

grabFrame

▸ grabFrame(): Future<VideoBuffer>

Returns: Future<VideoBuffer>

Implementation of: IInternalVideoTrack

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

isLocal

▸ PrivateisLocal(): boolean

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:20

removeOnDestroyed

▸ removeOnDestroyed(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:75

removeOnMuted

▸ removeOnMuted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:51

removeOnSize

▸ removeOnSize(value: IAction1<Size>): void

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IInternalVideoTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:147

removeOnSizeChange

▸ removeOnSizeChange(value: IAction1<Size>): void

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IInternalVideoTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:150

removeOnStarted

▸ removeOnStarted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:63

removeOnStopped

▸ removeOnStopped(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:69

removeOnUnmuted

▸ removeOnUnmuted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

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

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

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

setMuted

▸ setMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:144

setSinkOutput

▸ setSinkOutput(value: SinkOutput): void

Parameters:

Name Type
value SinkOutput

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoTrack.ts:97

setSourceInput

▸ setSourceInput(value: SourceInput): void

Parameters:

Name Type
value SourceInput

Returns: void

Implementation of: IInternalVideoTrack

Overrides: PluginMediaTrack

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

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

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