/ fm / liveswitch / WebRtcVideoTrack

Class: WebRtcVideoTrack

fm.liveswitch.WebRtcVideoTrack

Hierarchy

Implements

Table of contents

Constructors

Methods

Constructors

constructor

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

Parameters:

Name Type
external IExternalVideoTrack
media WebRtcMedia<WebRtcAudioTrack, WebRtcVideoTrack>

Returns: WebRtcVideoTrack

Inherited from: WebRtcMediaTrack

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

Methods

addOnDestroyed

▸ addOnDestroyed(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

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

addOnMuted

▸ addOnMuted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrack.ts:93

addOnSize

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

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IInternalVideoTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcVideoTrack.ts:109

addOnSizeChange

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

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IInternalVideoTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcVideoTrack.ts:112

addOnStarted

▸ addOnStarted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

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

addOnStopped

▸ addOnStopped(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrack.ts:102

addOnUnmuted

▸ addOnUnmuted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrack.ts:96

changeSinkOutput

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

Parameters:

Name Type
sinkOutput SinkOutput

Returns: Future<Object>

Implementation of: IInternalVideoTrack

Overrides: WebRtcMediaTrack

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

changeSourceInput

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

Parameters:

Name Type
sourceInput SourceInput

Returns: Future<Object>

Implementation of: IInternalVideoTrack

Overrides: WebRtcMediaTrack

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

destroy

▸ destroy(): boolean

Returns: boolean

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

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

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: WebRtcMediaTrack

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

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

getMedia

▸ getMedia(): WebRtcMedia<WebRtcAudioTrack, WebRtcVideoTrack>

Returns: WebRtcMedia<WebRtcAudioTrack, WebRtcVideoTrack>

Inherited from: WebRtcMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrack.ts:126

getMuted

▸ getMuted(): boolean

Returns: boolean

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

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

getSinkOutput

▸ getSinkOutput(): SinkOutput

Returns: SinkOutput

Implementation of: IInternalVideoTrack

Overrides: WebRtcMediaTrack

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

getSinkOutputs

▸ getSinkOutputs(): Future<SinkOutput[]>

Returns: Future<SinkOutput[]>

Implementation of: IInternalVideoTrack

Overrides: WebRtcMediaTrack

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

getSize

▸ getSize(): Size

Returns: Size

Implementation of: IInternalVideoTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcVideoTrack.ts:115

getSourceInput

▸ getSourceInput(): SourceInput

Returns: SourceInput

Implementation of: IInternalVideoTrack

Overrides: WebRtcMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcVideoTrack.ts:88

getSourceInputs

▸ getSourceInputs(): Future<SourceInput[]>

Returns: Future<SourceInput[]>

Implementation of: IInternalVideoTrack

Overrides: WebRtcMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcVideoTrack.ts:94

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: WebRtcMediaTrack

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

getVideoType

▸ getVideoType(): VideoType

Returns: VideoType

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcVideoTrack.ts:23

grabFrame

▸ grabFrame(): Future<VideoBuffer>

Returns: Future<VideoBuffer>

Implementation of: IInternalVideoTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcVideoTrack.ts:118

isLocal

▸ PrivateisLocal(): boolean

Returns: boolean

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

removeOnDestroyed

▸ removeOnDestroyed(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

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

removeOnMuted

▸ removeOnMuted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrack.ts:108

removeOnSize

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

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IInternalVideoTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcVideoTrack.ts:121

removeOnSizeChange

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

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IInternalVideoTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcVideoTrack.ts:124

removeOnStarted

▸ removeOnStarted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

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

removeOnStopped

▸ removeOnStopped(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrack.ts:117

removeOnUnmuted

▸ removeOnUnmuted(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

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

setConfig

▸ setConfig(config: VideoConfig): void

Parameters:

Name Type
config VideoConfig

Returns: void

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

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

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

setMuted

▸ setMuted(muted: boolean): void

Parameters:

Name Type
muted boolean

Returns: void

Implementation of: IInternalVideoTrack

Inherited from: WebRtcMediaTrack

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

setSinkOutput

▸ setSinkOutput(value: SinkOutput): void

Parameters:

Name Type
value SinkOutput

Returns: void

Implementation of: IInternalVideoTrack

Overrides: WebRtcMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcVideoTrack.ts:73

setSourceInput

▸ setSourceInput(value: SourceInput): void

Parameters:

Name Type
value SourceInput

Returns: void

Implementation of: IInternalVideoTrack

Overrides: WebRtcMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcVideoTrack.ts:102

setVideoType

▸ setVideoType(videoType: VideoType): void

Parameters:

Name Type
videoType VideoType

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcVideoTrack.ts:26

stop

▸ stop(): void

Returns: void

Inherited from: WebRtcMediaTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaTrack.ts:153

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

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