/ fm / liveswitch / PluginDomVideoSink
Class: PluginDomVideoSink
fm.liveswitch.PluginDomVideoSink
Hierarchy
-
↳ PluginDomVideoSink
Implements
Table of contents
Constructors
Methods
- checkifLoaded
- getDynamicProperties
- getDynamicValue
- getLocal
- getTrack
- getTypeString
- getVideo
- getVideoHeight
- getVideoWidth
- getView
- getViewMirror
- getViewScale
- setDynamicValue
- setTrack
- setViewMirror
- setViewScale
- unsetDynamicValue
Constructors
constructor
+ new PluginDomVideoSink(external
: IExternalDomVideoSink, track
: PluginVideoTrack): PluginDomVideoSink
Parameters:
Name | Type |
---|---|
external |
IExternalDomVideoSink |
track |
PluginVideoTrack |
Returns: PluginDomVideoSink
Inherited from: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:80
Methods
checkifLoaded
▸ Private
checkifLoaded(object
: IPluginDomVideoView): boolean
Parameters:
Name | Type |
---|---|
object |
IPluginDomVideoView |
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:136
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/PluginDomVideoSink.ts:30
getTrack
▸ getTrack(): PluginVideoTrack
Returns: PluginVideoTrack
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:27
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:5
getVideo
▸ getVideo(): HTMLVideoElement
Returns: HTMLVideoElement
Implementation of: IInternalDomVideoSink
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:34
getVideoHeight
▸ getVideoHeight(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:63
getVideoWidth
▸ getVideoWidth(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:57
getView
▸ getView(): HTMLElement
Returns: HTMLElement
Implementation of: IInternalDomVideoSink
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:43
getViewMirror
▸ getViewMirror(): boolean
Returns: boolean
Implementation of: IInternalDomVideoSink
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:70
getViewScale
▸ getViewScale(): LayoutScale
Returns: LayoutScale
Implementation of: IInternalDomVideoSink
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:46
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
setTrack
▸ setTrack(track
: PluginVideoTrack): boolean
Parameters:
Name | Type |
---|---|
track |
PluginVideoTrack |
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:91
setViewMirror
▸ setViewMirror(viewMirror
: boolean): void
Parameters:
Name | Type |
---|---|
viewMirror |
boolean |
Returns: void
Implementation of: IInternalDomVideoSink
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:76
setViewScale
▸ setViewScale(viewScale
: LayoutScale): void
Parameters:
Name | Type |
---|---|
viewScale |
LayoutScale |
Returns: void
Implementation of: IInternalDomVideoSink
Defined in: Generated/TypeScript/fm.liveswitch/PluginDomVideoSink.ts:52
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