Search Results for

    / fm / liveswitch / IPluginLocalMedia

    Interface: IPluginLocalMedia

    fm.liveswitch.IPluginLocalMedia

    An interface for COM usage.

    Table of contents

    Methods

    • AttachView
    • ChangeAudioSourceInput
    • ChangeVideoSourceInput
    • Destroy
    • GetAudioEncoding
    • GetAudioEncodings
    • GetAudioGain
    • GetAudioLevelInterval
    • GetAudioMuted
    • GetAudioSimulcastDisabled
    • GetAudioSimulcastEncodingCount
    • GetAudioSimulcastPreferredBitrate
    • GetAudioSourceInput
    • GetAudioSourceInputs
    • GetAudioVolume
    • GetHandle
    • GetId
    • GetState
    • GetVideoEncoding
    • GetVideoEncodings
    • GetVideoMuted
    • GetVideoSimulcastBitsPerPixel
    • GetVideoSimulcastDegradationPreference
    • GetVideoSimulcastDisabled
    • GetVideoSimulcastEncodingCount
    • GetVideoSimulcastPreferredBitrate
    • GetVideoSize
    • GetVideoSourceInput
    • GetVideoSourceInputs
    • GrabVideoFrame
    • Initialize
    • SetAudioEncodings
    • SetAudioGain
    • SetAudioLevelInterval
    • SetAudioMuted
    • SetAudioSimulcastDisabled
    • SetAudioSimulcastEncodingCount
    • SetAudioSimulcastPreferredBitrate
    • SetAudioSourceInput
    • SetAudioVolume
    • SetId
    • SetOnAudioDestroyed
    • SetOnAudioLevel
    • SetOnAudioMuted
    • SetOnAudioStarted
    • SetOnAudioStopped
    • SetOnAudioUnmuted
    • SetOnVideoDestroyed
    • SetOnVideoMuted
    • SetOnVideoSize
    • SetOnVideoSizeChange
    • SetOnVideoStarted
    • SetOnVideoStopped
    • SetOnVideoUnmuted
    • SetVideoEncodings
    • SetVideoMuted
    • SetVideoSimulcastBitsPerPixel
    • SetVideoSimulcastDegradationPreference
    • SetVideoSimulcastDisabled
    • SetVideoSimulcastEncodingCount
    • SetVideoSimulcastPreferredBitrate
    • SetVideoSourceInput
    • Start
    • Stop

    Methods

    AttachView

    ▸ AttachView(viewHandle: number): void

    Parameters:

    Name Type
    viewHandle number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:9


    ChangeAudioSourceInput

    ▸ ChangeAudioSourceInput(promise: Object, audioSourceInput: string): void

    Parameters:

    Name Type
    promise Object
    audioSourceInput string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:10


    ChangeVideoSourceInput

    ▸ ChangeVideoSourceInput(promise: Object, videoSourceInput: string): void

    Parameters:

    Name Type
    promise Object
    videoSourceInput string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:11


    Destroy

    ▸ Destroy(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:12


    GetAudioEncoding

    ▸ GetAudioEncoding(): string

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:13


    GetAudioEncodings

    ▸ GetAudioEncodings(): string

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:14


    GetAudioGain

    ▸ GetAudioGain(): number

    Returns: number

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


    GetAudioLevelInterval

    ▸ GetAudioLevelInterval(): number

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:16


    GetAudioMuted

    ▸ GetAudioMuted(): boolean

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:17


    GetAudioSimulcastDisabled

    ▸ GetAudioSimulcastDisabled(): boolean

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:18


    GetAudioSimulcastEncodingCount

    ▸ GetAudioSimulcastEncodingCount(): number

    Returns: number

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


    GetAudioSimulcastPreferredBitrate

    ▸ GetAudioSimulcastPreferredBitrate(): number

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:20


    GetAudioSourceInput

    ▸ GetAudioSourceInput(): string

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:21


    GetAudioSourceInputs

    ▸ GetAudioSourceInputs(promise: Object): void

    Parameters:

    Name Type
    promise Object

    Returns: void

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


    GetAudioVolume

    ▸ GetAudioVolume(): number

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:23


    GetHandle

    ▸ GetHandle(): number

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:24


    GetId

    ▸ GetId(): string

    Returns: string

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


    GetState

    ▸ GetState(): number

    Returns: number

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


    GetVideoEncoding

    ▸ GetVideoEncoding(): string

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:27


    GetVideoEncodings

    ▸ GetVideoEncodings(): string

    Returns: string

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


    GetVideoMuted

    ▸ GetVideoMuted(): boolean

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:29


    GetVideoSimulcastBitsPerPixel

    ▸ GetVideoSimulcastBitsPerPixel(): number

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:30


    GetVideoSimulcastDegradationPreference

    ▸ GetVideoSimulcastDegradationPreference(): number

    Returns: number

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


    GetVideoSimulcastDisabled

    ▸ GetVideoSimulcastDisabled(): boolean

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:32


    GetVideoSimulcastEncodingCount

    ▸ GetVideoSimulcastEncodingCount(): number

    Returns: number

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


    GetVideoSimulcastPreferredBitrate

    ▸ GetVideoSimulcastPreferredBitrate(): number

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:34


    GetVideoSize

    ▸ GetVideoSize(): string

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:35


    GetVideoSourceInput

    ▸ GetVideoSourceInput(): string

    Returns: string

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


    GetVideoSourceInputs

    ▸ GetVideoSourceInputs(promise: Object): void

    Parameters:

    Name Type
    promise Object

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:37


    GrabVideoFrame

    ▸ GrabVideoFrame(promise: Object): void

    Parameters:

    Name Type
    promise Object

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:38


    Initialize

    ▸ Initialize(disableAudio: boolean, disableVideo: boolean, isScreenShare: boolean): void

    Parameters:

    Name Type
    disableAudio boolean
    disableVideo boolean
    isScreenShare boolean

    Returns: void

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


    SetAudioEncodings

    ▸ SetAudioEncodings(valueJson: string): void

    Parameters:

    Name Type
    valueJson string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:40


    SetAudioGain

    ▸ SetAudioGain(gain: number): void

    Parameters:

    Name Type
    gain number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:41


    SetAudioLevelInterval

    ▸ SetAudioLevelInterval(audioLevelInterval: number): void

    Parameters:

    Name Type
    audioLevelInterval number

    Returns: void

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


    SetAudioMuted

    ▸ SetAudioMuted(muted: boolean): void

    Parameters:

    Name Type
    muted boolean

    Returns: void

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


    SetAudioSimulcastDisabled

    ▸ SetAudioSimulcastDisabled(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:44


    SetAudioSimulcastEncodingCount

    ▸ SetAudioSimulcastEncodingCount(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

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


    SetAudioSimulcastPreferredBitrate

    ▸ SetAudioSimulcastPreferredBitrate(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:46


    SetAudioSourceInput

    ▸ SetAudioSourceInput(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

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


    SetAudioVolume

    ▸ SetAudioVolume(volume: number): void

    Parameters:

    Name Type
    volume number

    Returns: void

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


    SetId

    ▸ SetId(idValue: string): void

    Parameters:

    Name Type
    idValue string

    Returns: void

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


    SetOnAudioDestroyed

    ▸ SetOnAudioDestroyed(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnAudioLevel

    ▸ SetOnAudioLevel(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnAudioMuted

    ▸ SetOnAudioMuted(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnAudioStarted

    ▸ SetOnAudioStarted(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:53


    SetOnAudioStopped

    ▸ SetOnAudioStopped(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:54


    SetOnAudioUnmuted

    ▸ SetOnAudioUnmuted(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnVideoDestroyed

    ▸ SetOnVideoDestroyed(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:56


    SetOnVideoMuted

    ▸ SetOnVideoMuted(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:57


    SetOnVideoSize

    ▸ SetOnVideoSize(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnVideoSizeChange

    ▸ SetOnVideoSizeChange(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:59


    SetOnVideoStarted

    ▸ SetOnVideoStarted(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnVideoStopped

    ▸ SetOnVideoStopped(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:61


    SetOnVideoUnmuted

    ▸ SetOnVideoUnmuted(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:62


    SetVideoEncodings

    ▸ SetVideoEncodings(valueJson: string): void

    Parameters:

    Name Type
    valueJson string

    Returns: void

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


    SetVideoMuted

    ▸ SetVideoMuted(muted: boolean): void

    Parameters:

    Name Type
    muted boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:64


    SetVideoSimulcastBitsPerPixel

    ▸ SetVideoSimulcastBitsPerPixel(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

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


    SetVideoSimulcastDegradationPreference

    ▸ SetVideoSimulcastDegradationPreference(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:66


    SetVideoSimulcastDisabled

    ▸ SetVideoSimulcastDisabled(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:67


    SetVideoSimulcastEncodingCount

    ▸ SetVideoSimulcastEncodingCount(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:68


    SetVideoSimulcastPreferredBitrate

    ▸ SetVideoSimulcastPreferredBitrate(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

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


    SetVideoSourceInput

    ▸ SetVideoSourceInput(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:70


    Start

    ▸ Start(promise: Object): void

    Parameters:

    Name Type
    promise Object

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:71


    Stop

    ▸ Stop(promise: Object): void

    Parameters:

    Name Type
    promise Object

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:72

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