/ fm / liveswitch / WebRtcDomVideoSink

Class: WebRtcDomVideoSink

fm.liveswitch.WebRtcDomVideoSink

Hierarchy

Implements

Table of contents

Constructors

Methods

Constructors

constructor

+ new WebRtcDomVideoSink(external: IExternalDomVideoSink, track: WebRtcVideoTrack): WebRtcDomVideoSink

Parameters:

Name Type
external IExternalDomVideoSink
track WebRtcVideoTrack

Returns: WebRtcDomVideoSink

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:106

Methods

applyScale

▸ PrivateapplyScale(scale: LayoutScale): void

Parameters:

Name Type
scale LayoutScale

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:285

destroy

▸ destroy(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:87

doRetry

▸ PrivatedoRetry<T>(attempt: number, retries: number, interval: number, action: () => Promise<T>, promise: Promise<T>): void

Type parameters:

Name
T

Parameters:

Name Type
attempt number
retries number
interval number
action () => Promise<T>
promise Promise<T>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:260

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: Dynamic

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

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

getLocal

▸ getLocal(): boolean

Returns: boolean

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

getMuted

▸ getMuted(): boolean

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:81

getTrack

▸ getTrack(): WebRtcVideoTrack

Returns: WebRtcVideoTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:33

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

getVideo

▸ getVideo(): HTMLVideoElement

Returns: HTMLVideoElement

Implementation of: IInternalDomVideoSink

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:60

getVideoHeight

▸ getVideoHeight(): number

Returns: number

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

getVideoWidth

▸ getVideoWidth(): number

Returns: number

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

getView

▸ getView(): HTMLElement

Returns: HTMLElement

Implementation of: IInternalDomVideoSink

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:39

getViewMirror

▸ getViewMirror(): boolean

Returns: boolean

Implementation of: IInternalDomVideoSink

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

getViewScale

▸ getViewScale(): LayoutScale

Returns: LayoutScale

Implementation of: IInternalDomVideoSink

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

getVolume

▸ getVolume(): number

Returns: number

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

playVideo

▸ PrivateplayVideo(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:237

retry

▸ Privateretry<T>(retries: number, interval: number, action: () => Promise<T>): Future<T>

Type parameters:

Name
T

Parameters:

Name Type
retries number
interval number
action () => Promise<T>

Returns: Future<T>

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:252

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

setMuted

▸ setMuted(muted: boolean): void

Parameters:

Name Type
muted boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:84

setTrack

▸ setTrack(track: WebRtcVideoTrack): boolean

Parameters:

Name Type
track WebRtcVideoTrack

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:162

setViewMirror

▸ setViewMirror(viewMirror: boolean): void

Parameters:

Name Type
viewMirror boolean

Returns: void

Implementation of: IInternalDomVideoSink

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:52

setViewScale

▸ setViewScale(viewScale: LayoutScale): void

Parameters:

Name Type
viewScale LayoutScale

Returns: void

Implementation of: IInternalDomVideoSink

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:45

setVolume

▸ setVolume(volume: number): void

Parameters:

Name Type
volume number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomVideoSink.ts:78

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

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