Search Results for

    / fm / liveswitch / IPluginAudioStream

    Interface: IPluginAudioStream

    fm.liveswitch.IPluginAudioStream

    An interface for COM usage.

    Table of contents

    Methods

    • ChangeDirection
    • GetCodecDisabled
    • GetControlTransportInfo
    • GetDirection
    • GetExternalId
    • GetG722Disabled
    • GetHandle
    • GetId
    • GetInfo
    • GetInputMuted
    • GetLabel
    • GetLocalBandwidth
    • GetLocalCanonicalName
    • GetLocalDirection
    • GetLocalReceive
    • GetLocalSend
    • GetMaxReceiveBitrate
    • GetMaxSendBitrate
    • GetMediaDescriptionId
    • GetOpusDisabled
    • GetOutputMuted
    • GetPcmaDisabled
    • GetPcmuDisabled
    • GetPreferredCodecs
    • GetRemoteBandwidth
    • GetRemoteCanonicalName
    • GetRemoteDirection
    • GetRemoteEncoding
    • GetRemoteMuted
    • GetRemoteReceive
    • GetRemoteSend
    • GetSimulcastMode
    • GetTag
    • GetTransportInfo
    • Initialize
    • InsertDtmfTone
    • InsertDtmfTones
    • RaiseBitrateNotification
    • RaiseBitrateRequest
    • SetCodecDisabled
    • SetExternalId
    • SetG722Disabled
    • SetInputMuted
    • SetLocalBandwidth
    • SetLocalDirection
    • SetLocalReceive
    • SetLocalSend
    • SetMaxReceiveBitrate
    • SetMaxSendBitrate
    • SetOnDirectionChange
    • SetOnDiscardBitrateNotification
    • SetOnDiscardBitrateRequest
    • SetOnLocalEncodingDisabled
    • SetOnLocalEncodingEnabled
    • SetOnReceiveDtmfTone
    • SetOnReceiveDtmfToneChange
    • SetOnSendDtmfTone
    • SetOnSendDtmfToneChange
    • SetOnStateChange
    • SetOpusDisabled
    • SetOutputMuted
    • SetPcmaDisabled
    • SetPcmuDisabled
    • SetPreferredCodecs
    • SetRemoteEncoding
    • SetRemoteMuted
    • SetSimulcastMode
    • SetTag

    Methods

    ChangeDirection

    ▸ ChangeDirection(newDirection: number): string

    Parameters:

    Name Type
    newDirection number

    Returns: string

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


    GetCodecDisabled

    ▸ GetCodecDisabled(name: string): boolean

    Parameters:

    Name Type
    name string

    Returns: boolean

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


    GetControlTransportInfo

    ▸ GetControlTransportInfo(): string

    Returns: string

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


    GetDirection

    ▸ GetDirection(): number

    Returns: number

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


    GetExternalId

    ▸ GetExternalId(): string

    Returns: string

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


    GetG722Disabled

    ▸ GetG722Disabled(): boolean

    Returns: boolean

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


    GetHandle

    ▸ GetHandle(): number

    Returns: number

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


    GetId

    ▸ GetId(): string

    Returns: string

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


    GetInfo

    ▸ GetInfo(): string

    Returns: string

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


    GetInputMuted

    ▸ GetInputMuted(): boolean

    Returns: boolean

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


    GetLabel

    ▸ GetLabel(): string

    Returns: string

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


    GetLocalBandwidth

    ▸ GetLocalBandwidth(): number

    Returns: number

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


    GetLocalCanonicalName

    ▸ GetLocalCanonicalName(): string

    Returns: string

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


    GetLocalDirection

    ▸ GetLocalDirection(): number

    Returns: number

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


    GetLocalReceive

    ▸ GetLocalReceive(): boolean

    Returns: boolean

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


    GetLocalSend

    ▸ GetLocalSend(): boolean

    Returns: boolean

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


    GetMaxReceiveBitrate

    ▸ GetMaxReceiveBitrate(): number

    Returns: number

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


    GetMaxSendBitrate

    ▸ GetMaxSendBitrate(): number

    Returns: number

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


    GetMediaDescriptionId

    ▸ GetMediaDescriptionId(): string

    Returns: string

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


    GetOpusDisabled

    ▸ GetOpusDisabled(): boolean

    Returns: boolean

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


    GetOutputMuted

    ▸ GetOutputMuted(): boolean

    Returns: boolean

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


    GetPcmaDisabled

    ▸ GetPcmaDisabled(): boolean

    Returns: boolean

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


    GetPcmuDisabled

    ▸ GetPcmuDisabled(): boolean

    Returns: boolean

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


    GetPreferredCodecs

    ▸ GetPreferredCodecs(): string[]

    Returns: string[]

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


    GetRemoteBandwidth

    ▸ GetRemoteBandwidth(): number

    Returns: number

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


    GetRemoteCanonicalName

    ▸ GetRemoteCanonicalName(): string

    Returns: string

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


    GetRemoteDirection

    ▸ GetRemoteDirection(): number

    Returns: number

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


    GetRemoteEncoding

    ▸ GetRemoteEncoding(): string

    Returns: string

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


    GetRemoteMuted

    ▸ GetRemoteMuted(): boolean

    Returns: boolean

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


    GetRemoteReceive

    ▸ GetRemoteReceive(): boolean

    Returns: boolean

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


    GetRemoteSend

    ▸ GetRemoteSend(): boolean

    Returns: boolean

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


    GetSimulcastMode

    ▸ GetSimulcastMode(): number

    Returns: number

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


    GetTag

    ▸ GetTag(): string

    Returns: string

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


    GetTransportInfo

    ▸ GetTransportInfo(): string

    Returns: string

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


    Initialize

    ▸ Initialize(localMediaHandle: number, remoteMediaHandle: number): void

    Parameters:

    Name Type
    localMediaHandle number
    remoteMediaHandle number

    Returns: void

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


    InsertDtmfTone

    ▸ InsertDtmfTone(dtmfToneJson: string): boolean

    Parameters:

    Name Type
    dtmfToneJson string

    Returns: boolean

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


    InsertDtmfTones

    ▸ InsertDtmfTones(dtmfTonesJson: string): boolean

    Parameters:

    Name Type
    dtmfTonesJson string

    Returns: boolean

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


    RaiseBitrateNotification

    ▸ RaiseBitrateNotification(bitrateNotificationJson: string): boolean

    Parameters:

    Name Type
    bitrateNotificationJson string

    Returns: boolean

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


    RaiseBitrateRequest

    ▸ RaiseBitrateRequest(bitrateRequestJson: string): boolean

    Parameters:

    Name Type
    bitrateRequestJson string

    Returns: boolean

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


    SetCodecDisabled

    ▸ SetCodecDisabled(name: string, disabled: boolean): void

    Parameters:

    Name Type
    name string
    disabled boolean

    Returns: void

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


    SetExternalId

    ▸ SetExternalId(externalId: string): void

    Parameters:

    Name Type
    externalId string

    Returns: void

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


    SetG722Disabled

    ▸ SetG722Disabled(disabled: boolean): void

    Parameters:

    Name Type
    disabled boolean

    Returns: void

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


    SetInputMuted

    ▸ SetInputMuted(muted: boolean): void

    Parameters:

    Name Type
    muted boolean

    Returns: void

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


    SetLocalBandwidth

    ▸ SetLocalBandwidth(bandwidth: number): void

    Parameters:

    Name Type
    bandwidth number

    Returns: void

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


    SetLocalDirection

    ▸ SetLocalDirection(direction: number): void

    Parameters:

    Name Type
    direction number

    Returns: void

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


    SetLocalReceive

    ▸ SetLocalReceive(localReceiveEnabled: boolean): void

    Parameters:

    Name Type
    localReceiveEnabled boolean

    Returns: void

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


    SetLocalSend

    ▸ SetLocalSend(localSendEnabled: boolean): void

    Parameters:

    Name Type
    localSendEnabled boolean

    Returns: void

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


    SetMaxReceiveBitrate

    ▸ SetMaxReceiveBitrate(bandwidth: number): void

    Parameters:

    Name Type
    bandwidth number

    Returns: void

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


    SetMaxSendBitrate

    ▸ SetMaxSendBitrate(bandwidth: number): void

    Parameters:

    Name Type
    bandwidth number

    Returns: void

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


    SetOnDirectionChange

    ▸ SetOnDirectionChange(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnDiscardBitrateNotification

    ▸ SetOnDiscardBitrateNotification(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnDiscardBitrateRequest

    ▸ SetOnDiscardBitrateRequest(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnLocalEncodingDisabled

    ▸ SetOnLocalEncodingDisabled(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnLocalEncodingEnabled

    ▸ SetOnLocalEncodingEnabled(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnReceiveDtmfTone

    ▸ SetOnReceiveDtmfTone(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnReceiveDtmfToneChange

    ▸ SetOnReceiveDtmfToneChange(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnSendDtmfTone

    ▸ SetOnSendDtmfTone(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnSendDtmfToneChange

    ▸ SetOnSendDtmfToneChange(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOnStateChange

    ▸ SetOnStateChange(callback: Object): void

    Parameters:

    Name Type
    callback Object

    Returns: void

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


    SetOpusDisabled

    ▸ SetOpusDisabled(disabled: boolean): void

    Parameters:

    Name Type
    disabled boolean

    Returns: void

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


    SetOutputMuted

    ▸ SetOutputMuted(muted: boolean): void

    Parameters:

    Name Type
    muted boolean

    Returns: void

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


    SetPcmaDisabled

    ▸ SetPcmaDisabled(disabled: boolean): void

    Parameters:

    Name Type
    disabled boolean

    Returns: void

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


    SetPcmuDisabled

    ▸ SetPcmuDisabled(disabled: boolean): void

    Parameters:

    Name Type
    disabled boolean

    Returns: void

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


    SetPreferredCodecs

    ▸ SetPreferredCodecs(names: string[]): void

    Parameters:

    Name Type
    names string[]

    Returns: void

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


    SetRemoteEncoding

    ▸ SetRemoteEncoding(remoteEncodingJson: string): void

    Parameters:

    Name Type
    remoteEncodingJson string

    Returns: void

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


    SetRemoteMuted

    ▸ SetRemoteMuted(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginAudioStream.ts:74


    SetSimulcastMode

    ▸ SetSimulcastMode(simulcastMode: number): void

    Parameters:

    Name Type
    simulcastMode number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/IPluginAudioStream.ts:75


    SetTag

    ▸ SetTag(tag: string): void

    Parameters:

    Name Type
    tag string

    Returns: void

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

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