Search Results for

    / fm / liveswitch / DomVideoSink

    Class: DomVideoSink

    fm.liveswitch.DomVideoSink

    Hierarchy

    • Dynamic

      ↳ DomVideoSink

    Implements

    • IExternalDomVideoSink

    Table of contents

    Constructors

    • constructor

    Methods

    • getDynamicProperties
    • getDynamicValue
    • getTypeString
    • getVideo
    • getView
    • getViewMirror
    • getViewScale
    • setDynamicValue
    • setViewMirror
    • setViewScale
    • unsetDynamicValue

    Constructors

    constructor

    + new DomVideoSink(track: VideoTrack): DomVideoSink

    Parameters:

    Name Type
    track VideoTrack

    Returns: DomVideoSink

    Inherited from: Dynamic

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

    Methods

    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


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Dynamic

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


    getVideo

    ▸ getVideo(): HTMLVideoElement

    Returns: HTMLVideoElement

    Implementation of: IExternalDomVideoSink

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


    getView

    ▸ getView(): HTMLElement

    Returns: HTMLElement

    Implementation of: IExternalDomVideoSink

    Defined in: Generated/TypeScript/fm.liveswitch/DomVideoSink.ts:19


    getViewMirror

    ▸ getViewMirror(): boolean

    Returns: boolean

    Implementation of: IExternalDomVideoSink

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


    getViewScale

    ▸ getViewScale(): LayoutScale

    Returns: LayoutScale

    Implementation of: IExternalDomVideoSink

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


    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


    setViewMirror

    ▸ setViewMirror(viewMirror: boolean): void

    Parameters:

    Name Type
    viewMirror boolean

    Returns: void

    Implementation of: IExternalDomVideoSink

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


    setViewScale

    ▸ setViewScale(viewScale: LayoutScale): void

    Parameters:

    Name Type
    viewScale LayoutScale

    Returns: void

    Implementation of: IExternalDomVideoSink

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


    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

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.14.6