Search Results for

    / fm / liveswitch / PluginRemoteMedia

    Class: PluginRemoteMedia

    fm.liveswitch.PluginRemoteMedia

    Hierarchy

    • PluginMedia

      ↳ PluginRemoteMedia

    Implements

    • IRemoteMedia<PluginAudioTrack, PluginVideoTrack>
    • IInternalRemoteMedia

    Table of contents

    Constructors

    • constructor

    Properties

    • _videoSink

    Methods

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

    Constructors

    constructor

    + new PluginRemoteMedia(external: IExternalRemoteMedia, audio: boolean, video: boolean): PluginRemoteMedia

    Parameters:

    Name Type
    external IExternalRemoteMedia
    audio boolean
    video boolean

    Returns: PluginRemoteMedia

    Inherited from: PluginMedia

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

    Properties

    _videoSink

    • Protected _videoSink: PluginDomVideoSink= null

    Inherited from: PluginMedia._videoSink

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

    Methods

    addOnAudioDestroyed

    ▸ addOnAudioDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalRemoteMedia

    Overrides: PluginMedia

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


    addOnAudioLevel

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

    Parameters:

    Name Type
    value IAction1<number>

    Returns: void

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    addOnVideoDestroyed

    ▸ addOnVideoDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalRemoteMedia

    Overrides: PluginMedia

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


    addOnVideoSize

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

    Parameters:

    Name Type
    value IAction1<Size>

    Returns: void

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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

    Inherited from: PluginMedia

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


    changeAudioSinkOutput

    ▸ changeAudioSinkOutput(audioSinkOutput: SinkOutput): Future<Object>

    Parameters:

    Name Type
    audioSinkOutput SinkOutput

    Returns: Future<Object>

    Implementation of: IInternalRemoteMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:86


    changeVideoSinkOutput

    ▸ changeVideoSinkOutput(videoSinkOutput: SinkOutput): Future<Object>

    Parameters:

    Name Type
    videoSinkOutput SinkOutput

    Returns: Future<Object>

    Implementation of: IInternalRemoteMedia

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


    checkifLoaded

    ▸ PrivatecheckifLoaded(object: RemoteMediaActiveXObject): void

    Parameters:

    Name Type
    object RemoteMediaActiveXObject

    Returns: void

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


    destroy

    ▸ destroy(): void

    Returns: void

    Implementation of: IInternalRemoteMedia

    Overrides: PluginMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:135


    getAudio

    ▸ getAudio(): any

    Returns: any

    Inherited from: PluginMedia

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


    getAudioGain

    ▸ getAudioGain(): number

    Returns: number

    Implementation of: IInternalRemoteMedia

    Overrides: PluginMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:138


    getAudioLevelInterval

    ▸ getAudioLevelInterval(): number

    Returns: number

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    getAudioMuted

    ▸ getAudioMuted(): boolean

    Returns: boolean

    Implementation of: IInternalRemoteMedia

    Overrides: PluginMedia

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


    getAudioSink

    ▸ getAudioSink(): PluginDomAudioSink

    Returns: PluginDomAudioSink

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    getAudioSinkOutput

    ▸ getAudioSinkOutput(): SinkOutput

    Returns: SinkOutput

    Implementation of: IInternalRemoteMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:100


    getAudioSinkOutputs

    ▸ getAudioSinkOutputs(): Future<SinkOutput[]>

    Returns: Future<SinkOutput[]>

    Implementation of: IInternalRemoteMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:103


    getAudioTrack

    ▸ getAudioTrack(): PluginAudioTrack

    Returns: PluginAudioTrack

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    getAudioTracks

    ▸ getAudioTracks(): PluginAudioTrack[]

    Returns: PluginAudioTrack[]

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    getAudioVolume

    ▸ getAudioVolume(): number

    Returns: number

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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

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

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


    getHandle

    ▸ getHandle(): number

    Returns: number

    Overrides: PluginMedia

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


    getId

    ▸ getId(): string

    Returns: string

    Implementation of: IInternalRemoteMedia

    Overrides: PluginMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:144


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: PluginMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:7


    getVideo

    ▸ getVideo(): any

    Returns: any

    Inherited from: PluginMedia

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


    getVideoMuted

    ▸ getVideoMuted(): boolean

    Returns: boolean

    Implementation of: IInternalRemoteMedia

    Overrides: PluginMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:147


    getVideoSink

    ▸ getVideoSink(): PluginDomVideoSink

    Returns: PluginDomVideoSink

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    getVideoSinkOutput

    ▸ getVideoSinkOutput(): SinkOutput

    Returns: SinkOutput

    Implementation of: IInternalRemoteMedia

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


    getVideoSinkOutputs

    ▸ getVideoSinkOutputs(): Future<SinkOutput[]>

    Returns: Future<SinkOutput[]>

    Implementation of: IInternalRemoteMedia

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


    getVideoSize

    ▸ getVideoSize(): Size

    Returns: Size

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    getVideoTrack

    ▸ getVideoTrack(): PluginVideoTrack

    Returns: PluginVideoTrack

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    getVideoTracks

    ▸ getVideoTracks(): PluginVideoTrack[]

    Returns: PluginVideoTrack[]

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    getView

    ▸ getView(): HTMLElement

    Returns: HTMLElement

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    getViewSink

    ▸ getViewSink(): PluginDomVideoSink

    Returns: PluginDomVideoSink

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    grabVideoFrame

    ▸ grabVideoFrame(): Future<VideoBuffer>

    Returns: Future<VideoBuffer>

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    removeOnAudioDestroyed

    ▸ removeOnAudioDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalRemoteMedia

    Overrides: PluginMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:79


    removeOnAudioLevel

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

    Parameters:

    Name Type
    value IAction1<number>

    Returns: void

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    removeOnVideoDestroyed

    ▸ removeOnVideoDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalRemoteMedia

    Overrides: PluginMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:82


    removeOnVideoSize

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

    Parameters:

    Name Type
    value IAction1<Size>

    Returns: void

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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

    Inherited from: PluginMedia

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


    setAudio

    ▸ setAudio(audio: any): void

    Parameters:

    Name Type
    audio any

    Returns: void

    Inherited from: PluginMedia

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


    setAudioGain

    ▸ setAudioGain(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalRemoteMedia

    Overrides: PluginMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:150


    setAudioLevelInterval

    ▸ setAudioLevelInterval(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    setAudioMuted

    ▸ setAudioMuted(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalRemoteMedia

    Overrides: PluginMedia

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


    setAudioSinkOutput

    ▸ setAudioSinkOutput(value: SinkOutput): void

    Parameters:

    Name Type
    value SinkOutput

    Returns: void

    Implementation of: IInternalRemoteMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:128


    setAudioVolume

    ▸ setAudioVolume(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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

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


    setId

    ▸ setId(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Implementation of: IInternalRemoteMedia

    Inherited from: PluginMedia

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


    setVideo

    ▸ setVideo(video: any): void

    Parameters:

    Name Type
    video any

    Returns: void

    Inherited from: PluginMedia

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


    setVideoMuted

    ▸ setVideoMuted(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalRemoteMedia

    Overrides: PluginMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:156


    setVideoSinkOutput

    ▸ setVideoSinkOutput(value: SinkOutput): void

    Parameters:

    Name Type
    value SinkOutput

    Returns: void

    Implementation of: IInternalRemoteMedia

    Defined in: Generated/TypeScript/fm.liveswitch/PluginRemoteMedia.ts:131


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

    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