Search Results for

    / fm / liveswitch / IInternalConnection

    Interface: IInternalConnection

    fm.liveswitch.IInternalConnection

    Hierarchy

    • IConnection<IInternalConnection, IInternalStream, IInternalAudioStream, IInternalVideoStream, IInternalDataStream>

    • IInternal<IExternalConnection>

      ↳ IInternalConnection

    Implemented by

    • PluginConnection
    • WebRtcConnection

    Table of contents

    Methods

    • addIceServer
    • addIceServers
    • addOnExternalIdChange
    • addOnGatheringStateChange
    • addOnIceConnectionStateChange
    • addOnLocalCandidate
    • addOnLocalDescription
    • addOnRemoteCandidate
    • addOnRemoteDescription
    • addOnSignallingStateChange
    • addOnStateChange
    • addRemoteCandidate
    • close
    • createAnswer
    • createOffer
    • getAudioStream
    • getAudioStreams
    • getBundlePolicy
    • getCanonicalName
    • getDataStream
    • getDataStreams
    • getDeadStreamTimeout
    • getError
    • getExternalId
    • getGatheringState
    • getHasAudio
    • getHasData
    • getHasVideo
    • getIceConnectionState
    • getIceGatherPolicy
    • getIceServer
    • getIceServers
    • getId
    • getLegacyTimeout
    • getLocalDescription
    • getRemoteDescription
    • getSignallingState
    • getState
    • getStats
    • getStreams
    • getTieBreaker
    • getTimeout
    • getTrickleIcePolicy
    • getVideoStream
    • getVideoStreams
    • removeIceServer
    • removeIceServers
    • removeOnExternalIdChange
    • removeOnGatheringStateChange
    • removeOnIceConnectionStateChange
    • removeOnLocalCandidate
    • removeOnLocalDescription
    • removeOnRemoteCandidate
    • removeOnRemoteDescription
    • removeOnSignallingStateChange
    • removeOnStateChange
    • setBundlePolicy
    • setDeadStreamTimeout
    • setError
    • setExternalId
    • setIceGatherPolicy
    • setIceServer
    • setIceServers
    • setLegacyTimeout
    • setLocalDescription
    • setRemoteDescription
    • setTieBreaker
    • setTimeout
    • setTrickleIcePolicy

    Methods

    addIceServer

    ▸ addIceServer(iceServer: IceServer): void

    Parameters:

    Name Type
    iceServer IceServer

    Returns: void

    Inherited from: IConnection

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


    addIceServers

    ▸ addIceServers(iceServers: IceServer[]): void

    Parameters:

    Name Type
    iceServers IceServer[]

    Returns: void

    Inherited from: IConnection

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


    addOnExternalIdChange

    ▸ addOnExternalIdChange(value: IAction2<string, string>): void

    Parameters:

    Name Type
    value IAction2<string, string>

    Returns: void

    Inherited from: IConnection

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


    addOnGatheringStateChange

    ▸ addOnGatheringStateChange(value: IAction1<IInternalConnection>): void

    Parameters:

    Name Type
    value IAction1<IInternalConnection>

    Returns: void

    Inherited from: IConnection

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


    addOnIceConnectionStateChange

    ▸ addOnIceConnectionStateChange(value: IAction1<IInternalConnection>): void

    Parameters:

    Name Type
    value IAction1<IInternalConnection>

    Returns: void

    Inherited from: IConnection

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


    addOnLocalCandidate

    ▸ addOnLocalCandidate(value: IAction2<IInternalConnection, Candidate>): void

    Parameters:

    Name Type
    value IAction2<IInternalConnection, Candidate>

    Returns: void

    Inherited from: IConnection

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


    addOnLocalDescription

    ▸ addOnLocalDescription(value: IAction2<IInternalConnection, SessionDescription>): void

    Parameters:

    Name Type
    value IAction2<IInternalConnection, SessionDescription>

    Returns: void

    Inherited from: IConnection

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


    addOnRemoteCandidate

    ▸ addOnRemoteCandidate(value: IAction2<IInternalConnection, Candidate>): void

    Parameters:

    Name Type
    value IAction2<IInternalConnection, Candidate>

    Returns: void

    Inherited from: IConnection

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


    addOnRemoteDescription

    ▸ addOnRemoteDescription(value: IAction2<IInternalConnection, SessionDescription>): void

    Parameters:

    Name Type
    value IAction2<IInternalConnection, SessionDescription>

    Returns: void

    Inherited from: IConnection

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


    addOnSignallingStateChange

    ▸ addOnSignallingStateChange(value: IAction1<IInternalConnection>): void

    Parameters:

    Name Type
    value IAction1<IInternalConnection>

    Returns: void

    Inherited from: IConnection

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


    addOnStateChange

    ▸ addOnStateChange(value: IAction1<IInternalConnection>): void

    Parameters:

    Name Type
    value IAction1<IInternalConnection>

    Returns: void

    Inherited from: IConnection

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


    addRemoteCandidate

    ▸ addRemoteCandidate(remoteCandidate: Candidate): Future<Candidate>

    Parameters:

    Name Type
    remoteCandidate Candidate

    Returns: Future<Candidate>

    Inherited from: IConnection

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


    close

    ▸ close(): boolean

    Returns: boolean

    Inherited from: IConnection

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


    createAnswer

    ▸ createAnswer(): Future<SessionDescription>

    Returns: Future<SessionDescription>

    Inherited from: IConnection

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


    createOffer

    ▸ createOffer(): Future<SessionDescription>

    Returns: Future<SessionDescription>

    Inherited from: IConnection

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


    getAudioStream

    ▸ getAudioStream(): IInternalAudioStream

    Returns: IInternalAudioStream

    Inherited from: IConnection

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


    getAudioStreams

    ▸ getAudioStreams(): IInternalAudioStream[]

    Returns: IInternalAudioStream[]

    Inherited from: IConnection

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


    getBundlePolicy

    ▸ getBundlePolicy(): BundlePolicy

    Returns: BundlePolicy

    Inherited from: IConnection

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


    getCanonicalName

    ▸ getCanonicalName(): string

    Returns: string

    Inherited from: IConnection

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


    getDataStream

    ▸ getDataStream(): IInternalDataStream

    Returns: IInternalDataStream

    Inherited from: IConnection

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


    getDataStreams

    ▸ getDataStreams(): IInternalDataStream[]

    Returns: IInternalDataStream[]

    Inherited from: IConnection

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


    getDeadStreamTimeout

    ▸ getDeadStreamTimeout(): number

    Returns: number

    Inherited from: IConnection

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


    getError

    ▸ getError(): Error

    Returns: Error

    Inherited from: IConnection

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


    getExternalId

    ▸ getExternalId(): string

    Returns: string

    Inherited from: IConnection

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


    getGatheringState

    ▸ getGatheringState(): IceGatheringState

    Returns: IceGatheringState

    Inherited from: IConnection

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


    getHasAudio

    ▸ getHasAudio(): boolean

    Returns: boolean

    Inherited from: IConnection

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


    getHasData

    ▸ getHasData(): boolean

    Returns: boolean

    Inherited from: IConnection

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


    getHasVideo

    ▸ getHasVideo(): boolean

    Returns: boolean

    Inherited from: IConnection

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


    getIceConnectionState

    ▸ getIceConnectionState(): IceConnectionState

    Returns: IceConnectionState

    Inherited from: IConnection

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


    getIceGatherPolicy

    ▸ getIceGatherPolicy(): IceGatherPolicy

    Returns: IceGatherPolicy

    Inherited from: IConnection

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


    getIceServer

    ▸ getIceServer(): IceServer

    Returns: IceServer

    Inherited from: IConnection

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


    getIceServers

    ▸ getIceServers(): IceServer[]

    Returns: IceServer[]

    Inherited from: IConnection

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


    getId

    ▸ getId(): string

    Returns: string

    Inherited from: IConnection

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


    getLegacyTimeout

    ▸ getLegacyTimeout(): boolean

    Returns: boolean

    Inherited from: IConnection

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


    getLocalDescription

    ▸ getLocalDescription(): SessionDescription

    Returns: SessionDescription

    Inherited from: IConnection

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


    getRemoteDescription

    ▸ getRemoteDescription(): SessionDescription

    Returns: SessionDescription

    Inherited from: IConnection

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


    getSignallingState

    ▸ getSignallingState(): SignallingState

    Returns: SignallingState

    Inherited from: IConnection

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


    getState

    ▸ getState(): ConnectionState

    Returns: ConnectionState

    Inherited from: IConnection

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


    getStats

    ▸ getStats(): Future<ConnectionStats>

    Returns: Future<ConnectionStats>

    Inherited from: IConnection

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


    getStreams

    ▸ getStreams(): IInternalStream[]

    Returns: IInternalStream[]

    Inherited from: IConnection

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


    getTieBreaker

    ▸ getTieBreaker(): string

    Returns: string

    Inherited from: IConnection

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


    getTimeout

    ▸ getTimeout(): number

    Returns: number

    Inherited from: IConnection

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


    getTrickleIcePolicy

    ▸ getTrickleIcePolicy(): TrickleIcePolicy

    Returns: TrickleIcePolicy

    Inherited from: IConnection

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


    getVideoStream

    ▸ getVideoStream(): IInternalVideoStream

    Returns: IInternalVideoStream

    Inherited from: IConnection

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


    getVideoStreams

    ▸ getVideoStreams(): IInternalVideoStream[]

    Returns: IInternalVideoStream[]

    Inherited from: IConnection

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


    removeIceServer

    ▸ removeIceServer(iceServer: IceServer): void

    Parameters:

    Name Type
    iceServer IceServer

    Returns: void

    Inherited from: IConnection

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


    removeIceServers

    ▸ removeIceServers(iceServers: IceServer[]): void

    Parameters:

    Name Type
    iceServers IceServer[]

    Returns: void

    Inherited from: IConnection

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


    removeOnExternalIdChange

    ▸ removeOnExternalIdChange(value: IAction2<string, string>): void

    Parameters:

    Name Type
    value IAction2<string, string>

    Returns: void

    Inherited from: IConnection

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


    removeOnGatheringStateChange

    ▸ removeOnGatheringStateChange(value: IAction1<IInternalConnection>): void

    Parameters:

    Name Type
    value IAction1<IInternalConnection>

    Returns: void

    Inherited from: IConnection

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


    removeOnIceConnectionStateChange

    ▸ removeOnIceConnectionStateChange(value: IAction1<IInternalConnection>): void

    Parameters:

    Name Type
    value IAction1<IInternalConnection>

    Returns: void

    Inherited from: IConnection

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


    removeOnLocalCandidate

    ▸ removeOnLocalCandidate(value: IAction2<IInternalConnection, Candidate>): void

    Parameters:

    Name Type
    value IAction2<IInternalConnection, Candidate>

    Returns: void

    Inherited from: IConnection

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


    removeOnLocalDescription

    ▸ removeOnLocalDescription(value: IAction2<IInternalConnection, SessionDescription>): void

    Parameters:

    Name Type
    value IAction2<IInternalConnection, SessionDescription>

    Returns: void

    Inherited from: IConnection

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


    removeOnRemoteCandidate

    ▸ removeOnRemoteCandidate(value: IAction2<IInternalConnection, Candidate>): void

    Parameters:

    Name Type
    value IAction2<IInternalConnection, Candidate>

    Returns: void

    Inherited from: IConnection

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


    removeOnRemoteDescription

    ▸ removeOnRemoteDescription(value: IAction2<IInternalConnection, SessionDescription>): void

    Parameters:

    Name Type
    value IAction2<IInternalConnection, SessionDescription>

    Returns: void

    Inherited from: IConnection

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


    removeOnSignallingStateChange

    ▸ removeOnSignallingStateChange(value: IAction1<IInternalConnection>): void

    Parameters:

    Name Type
    value IAction1<IInternalConnection>

    Returns: void

    Inherited from: IConnection

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


    removeOnStateChange

    ▸ removeOnStateChange(value: IAction1<IInternalConnection>): void

    Parameters:

    Name Type
    value IAction1<IInternalConnection>

    Returns: void

    Inherited from: IConnection

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


    setBundlePolicy

    ▸ setBundlePolicy(value: BundlePolicy): void

    Parameters:

    Name Type
    value BundlePolicy

    Returns: void

    Inherited from: IConnection

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


    setDeadStreamTimeout

    ▸ setDeadStreamTimeout(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Inherited from: IConnection

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


    setError

    ▸ setError(value: Error): void

    Parameters:

    Name Type
    value Error

    Returns: void

    Inherited from: IConnection

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


    setExternalId

    ▸ setExternalId(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Inherited from: IConnection

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


    setIceGatherPolicy

    ▸ setIceGatherPolicy(value: IceGatherPolicy): void

    Parameters:

    Name Type
    value IceGatherPolicy

    Returns: void

    Inherited from: IConnection

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


    setIceServer

    ▸ setIceServer(value: IceServer): void

    Parameters:

    Name Type
    value IceServer

    Returns: void

    Inherited from: IConnection

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


    setIceServers

    ▸ setIceServers(value: IceServer[]): void

    Parameters:

    Name Type
    value IceServer[]

    Returns: void

    Inherited from: IConnection

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


    setLegacyTimeout

    ▸ setLegacyTimeout(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: IConnection

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


    setLocalDescription

    ▸ setLocalDescription(localDescription: SessionDescription): Future<SessionDescription>

    Parameters:

    Name Type
    localDescription SessionDescription

    Returns: Future<SessionDescription>

    Inherited from: IConnection

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


    setRemoteDescription

    ▸ setRemoteDescription(remoteDescription: SessionDescription): Future<SessionDescription>

    Parameters:

    Name Type
    remoteDescription SessionDescription

    Returns: Future<SessionDescription>

    Inherited from: IConnection

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


    setTieBreaker

    ▸ setTieBreaker(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Inherited from: IConnection

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


    setTimeout

    ▸ setTimeout(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Inherited from: IConnection

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


    setTrickleIcePolicy

    ▸ setTrickleIcePolicy(value: TrickleIcePolicy): void

    Parameters:

    Name Type
    value TrickleIcePolicy

    Returns: void

    Inherited from: IConnection

    Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:77

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