/ fm / liveswitch / VideoTrack

Class: VideoTrack

fm.liveswitch.VideoTrack

Hierarchy

Implements

Table of contents

Constructors

Methods

Constructors

constructor

+ new VideoTrack(media: Media, internalMedia?: IInternalMedia): VideoTrack

Parameters:

Name Type
media Media
internalMedia? IInternalMedia

Returns: VideoTrack

Inherited from: MediaTrack

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

Methods

addOnDestroyed

▸ addOnDestroyed(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

addOnMuted

▸ addOnMuted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

addOnSize

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

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IExternalVideoTrack

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

addOnSizeChange

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

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IExternalVideoTrack

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

addOnStarted

▸ addOnStarted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

addOnStopped

▸ addOnStopped(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

addOnUnmuted

▸ addOnUnmuted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

changeSinkOutput

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

Parameters:

Name Type
sinkOutput SinkOutput

Returns: Future<Object>

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

changeSourceInput

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

Parameters:

Name Type
sourceInput SourceInput

Returns: Future<Object>

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

destroy

▸ destroy(): boolean

Returns: boolean

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: MediaTrack

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

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

getMedia

▸ getMedia(): Media

Returns: Media

Inherited from: MediaTrack

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

getMuted

▸ getMuted(): boolean

Returns: boolean

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

getSinkOutput

▸ getSinkOutput(): SinkOutput

Returns: SinkOutput

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

getSinkOutputs

▸ getSinkOutputs(): Future<SinkOutput[]>

Returns: Future<SinkOutput[]>

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

getSize

▸ getSize(): Size

Returns: Size

Implementation of: IExternalVideoTrack

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

getSourceInput

▸ getSourceInput(): SourceInput

Returns: SourceInput

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

getSourceInputs

▸ getSourceInputs(): Future<SourceInput[]>

Returns: Future<SourceInput[]>

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: MediaTrack

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

grabFrame

▸ grabFrame(): Future<VideoBuffer>

Returns: Future<VideoBuffer>

Implementation of: IExternalVideoTrack

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

removeOnDestroyed

▸ removeOnDestroyed(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

removeOnMuted

▸ removeOnMuted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

removeOnSize

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

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IExternalVideoTrack

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

removeOnSizeChange

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

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IExternalVideoTrack

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

removeOnStarted

▸ removeOnStarted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

removeOnStopped

▸ removeOnStopped(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

removeOnUnmuted

▸ removeOnUnmuted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

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

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

setMuted

▸ setMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

setSinkOutput

▸ setSinkOutput(value: SinkOutput): void

Parameters:

Name Type
value SinkOutput

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

setSourceInput

▸ setSourceInput(value: SourceInput): void

Parameters:

Name Type
value SourceInput

Returns: void

Implementation of: IExternalVideoTrack

Inherited from: MediaTrack

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

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

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