Search Results for

    / fm / liveswitch / PluginMedia

    Class: PluginMedia

    fm.liveswitch.PluginMedia

    Hierarchy

    • Dynamic

      ↳ PluginMedia

      ↳↳ PluginLocalMedia

      ↳↳ PluginRemoteMedia

    Implements

    • IMedia<PluginAudioTrack, PluginVideoTrack>
    • IInternalMedia

    Table of contents

    Constructors

    • constructor

    Properties

    • _videoSink

    Methods

    • addOnAudioDestroyed
    • addOnAudioLevel
    • addOnVideoDestroyed
    • addOnVideoSize
    • addOnVideoSizeChange
    • destroy
    • getAudio
    • getAudioGain
    • getAudioLevelInterval
    • getAudioMuted
    • getAudioSink
    • getAudioTrack
    • getAudioTracks
    • getAudioVolume
    • getDynamicProperties
    • getDynamicValue
    • getHandle
    • getId
    • getTypeString
    • getVideo
    • getVideoMuted
    • getVideoSink
    • getVideoSize
    • getVideoTrack
    • getVideoTracks
    • getView
    • getViewSink
    • grabVideoFrame
    • removeOnAudioDestroyed
    • removeOnAudioLevel
    • removeOnVideoDestroyed
    • removeOnVideoSize
    • removeOnVideoSizeChange
    • setAudio
    • setAudioGain
    • setAudioLevelInterval
    • setAudioMuted
    • setAudioVolume
    • setDynamicValue
    • setId
    • setVideo
    • setVideoMuted
    • unsetDynamicValue

    Constructors

    constructor

    + new PluginMedia(external: IExternalMedia): PluginMedia

    Parameters:

    Name Type
    external IExternalMedia

    Returns: PluginMedia

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:230

    Properties

    _videoSink

    • Protected _videoSink: PluginDomVideoSink= null

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:230

    Methods

    addOnAudioDestroyed

    ▸ AbstractaddOnAudioDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalMedia

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


    addOnAudioLevel

    ▸ addOnAudioLevel(value: IAction1<number>): void

    Parameters:

    Name Type
    value IAction1<number>

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:55


    addOnVideoDestroyed

    ▸ AbstractaddOnVideoDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:48


    addOnVideoSize

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

    Parameters:

    Name Type
    value IAction1<Size>

    Returns: void

    Implementation of: IInternalMedia

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


    addOnVideoSizeChange

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

    Parameters:

    Name Type
    value IAction1<Size>

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:76


    destroy

    ▸ destroy(): void

    Returns: void

    Implementation of: IInternalMedia

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


    getAudio

    ▸ getAudio(): any

    Returns: any

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:210


    getAudioGain

    ▸ getAudioGain(): number

    Returns: number

    Implementation of: IInternalMedia

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


    getAudioLevelInterval

    ▸ getAudioLevelInterval(): number

    Returns: number

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:90


    getAudioMuted

    ▸ getAudioMuted(): boolean

    Returns: boolean

    Implementation of: IInternalMedia

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


    getAudioSink

    ▸ getAudioSink(): PluginDomAudioSink

    Returns: PluginDomAudioSink

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:182


    getAudioTrack

    ▸ getAudioTrack(): PluginAudioTrack

    Returns: PluginAudioTrack

    Implementation of: IInternalMedia

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


    getAudioTracks

    ▸ getAudioTracks(): PluginAudioTrack[]

    Returns: PluginAudioTrack[]

    Implementation of: IInternalMedia

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


    getAudioVolume

    ▸ getAudioVolume(): number

    Returns: number

    Implementation of: IInternalMedia

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


    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


    getHandle

    ▸ getHandle(): number

    Returns: number

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


    getId

    ▸ getId(): string

    Returns: string

    Implementation of: IInternalMedia

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


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Dynamic

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


    getVideo

    ▸ getVideo(): any

    Returns: any

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:218


    getVideoMuted

    ▸ getVideoMuted(): boolean

    Returns: boolean

    Implementation of: IInternalMedia

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


    getVideoSink

    ▸ getVideoSink(): PluginDomVideoSink

    Returns: PluginDomVideoSink

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:188


    getVideoSize

    ▸ getVideoSize(): Size

    Returns: Size

    Implementation of: IInternalMedia

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


    getVideoTrack

    ▸ getVideoTrack(): PluginVideoTrack

    Returns: PluginVideoTrack

    Implementation of: IInternalMedia

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


    getVideoTracks

    ▸ getVideoTracks(): PluginVideoTrack[]

    Returns: PluginVideoTrack[]

    Implementation of: IInternalMedia

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


    getView

    ▸ getView(): HTMLElement

    Returns: HTMLElement

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:195


    getViewSink

    ▸ getViewSink(): PluginDomVideoSink

    Returns: PluginDomVideoSink

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:201


    grabVideoFrame

    ▸ grabVideoFrame(): Future<VideoBuffer>

    Returns: Future<VideoBuffer>

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:132


    removeOnAudioDestroyed

    ▸ AbstractremoveOnAudioDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalMedia

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


    removeOnAudioLevel

    ▸ removeOnAudioLevel(value: IAction1<number>): void

    Parameters:

    Name Type
    value IAction1<number>

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:145


    removeOnVideoDestroyed

    ▸ AbstractremoveOnVideoDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:50


    removeOnVideoSize

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

    Parameters:

    Name Type
    value IAction1<Size>

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:151


    removeOnVideoSizeChange

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

    Parameters:

    Name Type
    value IAction1<Size>

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:157


    setAudio

    ▸ setAudio(audio: any): void

    Parameters:

    Name Type
    audio any

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:213


    setAudioGain

    ▸ setAudioGain(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:163


    setAudioLevelInterval

    ▸ setAudioLevelInterval(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:166


    setAudioMuted

    ▸ setAudioMuted(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:169


    setAudioVolume

    ▸ setAudioVolume(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:172


    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


    setId

    ▸ setId(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:175


    setVideo

    ▸ setVideo(video: any): void

    Parameters:

    Name Type
    video any

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:221


    setVideoMuted

    ▸ setVideoMuted(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:178


    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.15.0