Search Results for

    / fm / liveswitch / Connection

    Class: Connection

    fm.liveswitch.Connection

    Hierarchy

    • Dynamic

      ↳ Connection

    Implements

    • IConnection<Connection, Stream, AudioStream, VideoStream, DataStream>
    • IExternalConnection

    Table of contents

    Constructors

    • constructor

    Properties

    • _onExternalIdChangeValues

    Methods

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

    Constructors

    constructor

    + new Connection(stream: Stream): Connection

    Parameters:

    Name Type
    stream Stream

    Returns: Connection

    Inherited from: Dynamic

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

    + new Connection(streams: Stream[]): Connection

    Parameters:

    Name Type
    streams Stream[]

    Returns: Connection

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

    Properties

    _onExternalIdChangeValues

    • Private _onExternalIdChangeValues: IAction2<string, string>[]

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

    Methods

    addIceServer

    ▸ addIceServer(iceServer: IceServer): void

    Parameters:

    Name Type
    iceServer IceServer

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:143


    addIceServers

    ▸ addIceServers(iceServers: IceServer[]): void

    Parameters:

    Name Type
    iceServers IceServer[]

    Returns: void

    Implementation of: IExternalConnection

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


    addOnExternalIdChange

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

    Parameters:

    Name Type
    value IAction2<string, string>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:368


    addOnGatheringStateChange

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

    Parameters:

    Name Type
    value IAction1<Connection>

    Returns: void

    Implementation of: IExternalConnection

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


    addOnIceConnectionStateChange

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

    Parameters:

    Name Type
    value IAction1<Connection>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:154


    addOnLocalCandidate

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

    Parameters:

    Name Type
    value IAction2<Connection, Candidate>

    Returns: void

    Implementation of: IExternalConnection

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


    addOnLocalDescription

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

    Parameters:

    Name Type
    value IAction2<Connection, SessionDescription>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:161


    addOnRemoteCandidate

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

    Parameters:

    Name Type
    value IAction2<Connection, Candidate>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:165


    addOnRemoteDescription

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

    Parameters:

    Name Type
    value IAction2<Connection, SessionDescription>

    Returns: void

    Implementation of: IExternalConnection

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


    addOnSignallingStateChange

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

    Parameters:

    Name Type
    value IAction1<Connection>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:173


    addOnStateChange

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

    Parameters:

    Name Type
    value IAction1<Connection>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:177


    addRemoteCandidate

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

    Parameters:

    Name Type
    remoteCandidate Candidate

    Returns: Future<Candidate>

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:181


    close

    ▸ close(): boolean

    Returns: boolean

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:185


    createAnswer

    ▸ createAnswer(): Future<SessionDescription>

    Returns: Future<SessionDescription>

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:189


    createOffer

    ▸ createOffer(): Future<SessionDescription>

    Returns: Future<SessionDescription>

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:193


    externalToInternal

    ▸ PrivateexternalToInternal(external: IExternalStream): IInternalStream

    Parameters:

    Name Type
    external IExternalStream

    Returns: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:427


    externalsToInternals

    ▸ PrivateexternalsToInternals(externals: IExternalStream[]): IInternalStream[]

    Parameters:

    Name Type
    externals IExternalStream[]

    Returns: IInternalStream[]

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:421


    getAudioStream

    ▸ getAudioStream(): AudioStream

    Returns: AudioStream

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:293


    getAudioStreams

    ▸ getAudioStreams(): AudioStream[]

    Returns: AudioStream[]

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:297


    getBundlePolicy

    ▸ getBundlePolicy(): BundlePolicy

    Returns: BundlePolicy

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:209


    getCanonicalName

    ▸ getCanonicalName(): string

    Returns: string

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:237


    getDataStream

    ▸ getDataStream(): DataStream

    Returns: DataStream

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:309


    getDataStreams

    ▸ getDataStreams(): DataStream[]

    Returns: DataStream[]

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:313


    getDeadStreamTimeout

    ▸ getDeadStreamTimeout(): number

    Returns: number

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:197


    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


    getError

    ▸ getError(): Error

    Returns: Error

    Implementation of: IExternalConnection

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


    getExternalId

    ▸ getExternalId(): string

    Returns: string

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:205


    getGatheringState

    ▸ getGatheringState(): IceGatheringState

    Returns: IceGatheringState

    Implementation of: IExternalConnection

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


    getHasAudio

    ▸ getHasAudio(): boolean

    Returns: boolean

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:281


    getHasData

    ▸ getHasData(): boolean

    Returns: boolean

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:289


    getHasVideo

    ▸ getHasVideo(): boolean

    Returns: boolean

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:285


    getIceConnectionState

    ▸ getIceConnectionState(): IceConnectionState

    Returns: IceConnectionState

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:225


    getIceGatherPolicy

    ▸ getIceGatherPolicy(): IceGatherPolicy

    Returns: IceGatherPolicy

    Implementation of: IExternalConnection

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


    getIceServer

    ▸ getIceServer(): IceServer

    Returns: IceServer

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:217


    getIceServers

    ▸ getIceServers(): IceServer[]

    Returns: IceServer[]

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:229


    getId

    ▸ getId(): string

    Returns: string

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:233


    getLegacyTimeout

    ▸ getLegacyTimeout(): boolean

    Returns: boolean

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:269


    getLocalDescription

    ▸ getLocalDescription(): SessionDescription

    Returns: SessionDescription

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:241


    getRemoteDescription

    ▸ getRemoteDescription(): SessionDescription

    Returns: SessionDescription

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:245


    getRemoteMedia

    ▸ getRemoteMedia(): RemoteMedia

    Returns: RemoteMedia

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:416


    getSignallingState

    ▸ getSignallingState(): SignallingState

    Returns: SignallingState

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:249


    getState

    ▸ getState(): ConnectionState

    Returns: ConnectionState

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:253


    getStats

    ▸ getStats(): Future<ConnectionStats>

    Returns: Future<ConnectionStats>

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:257


    getStreams

    ▸ getStreams(): Stream[]

    Returns: Stream[]

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:261


    getTieBreaker

    ▸ getTieBreaker(): string

    Returns: string

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:265


    getTimeout

    ▸ getTimeout(): number

    Returns: number

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:273


    getTrickleIcePolicy

    ▸ getTrickleIcePolicy(): TrickleIcePolicy

    Returns: TrickleIcePolicy

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:277


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:4


    getVideoStream

    ▸ getVideoStream(): VideoStream

    Returns: VideoStream

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:301


    getVideoStreams

    ▸ getVideoStreams(): VideoStream[]

    Returns: VideoStream[]

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:305


    internalToExternal

    ▸ PrivateinternalToExternal(internal: IInternalStream): IExternalStream

    Parameters:

    Name Type
    internal IInternalStream

    Returns: IExternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:437


    internalsToExternals

    ▸ PrivateinternalsToExternals(internals: IInternalStream[]): IExternalStream[]

    Parameters:

    Name Type
    internals IInternalStream[]

    Returns: IExternalStream[]

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:431


    removeIceServer

    ▸ removeIceServer(iceServer: IceServer): void

    Parameters:

    Name Type
    iceServer IceServer

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:317


    removeIceServers

    ▸ removeIceServers(iceServers: IceServer[]): void

    Parameters:

    Name Type
    iceServers IceServer[]

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:321


    removeOnExternalIdChange

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

    Parameters:

    Name Type
    value IAction2<string, string>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:372


    removeOnGatheringStateChange

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

    Parameters:

    Name Type
    value IAction1<Connection>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:325


    removeOnIceConnectionStateChange

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

    Parameters:

    Name Type
    value IAction1<Connection>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:328


    removeOnLocalCandidate

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

    Parameters:

    Name Type
    value IAction2<Connection, Candidate>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:332


    removeOnLocalDescription

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

    Parameters:

    Name Type
    value IAction2<Connection, SessionDescription>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:336


    removeOnRemoteCandidate

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

    Parameters:

    Name Type
    value IAction2<Connection, Candidate>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:340


    removeOnRemoteDescription

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

    Parameters:

    Name Type
    value IAction2<Connection, SessionDescription>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:344


    removeOnSignallingStateChange

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

    Parameters:

    Name Type
    value IAction1<Connection>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:348


    removeOnStateChange

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

    Parameters:

    Name Type
    value IAction1<Connection>

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:352


    setBundlePolicy

    ▸ setBundlePolicy(value: BundlePolicy): void

    Parameters:

    Name Type
    value BundlePolicy

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:376


    setDeadStreamTimeout

    ▸ setDeadStreamTimeout(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:356


    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


    setError

    ▸ setError(value: Error): void

    Parameters:

    Name Type
    value Error

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:364


    setExternalId

    ▸ setExternalId(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:360


    setIceGatherPolicy

    ▸ setIceGatherPolicy(value: IceGatherPolicy): void

    Parameters:

    Name Type
    value IceGatherPolicy

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:380


    setIceServer

    ▸ setIceServer(value: IceServer): void

    Parameters:

    Name Type
    value IceServer

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:384


    setIceServers

    ▸ setIceServers(value: IceServer[]): void

    Parameters:

    Name Type
    value IceServer[]

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:388


    setLegacyTimeout

    ▸ setLegacyTimeout(legacyTimeout: boolean): void

    Parameters:

    Name Type
    legacyTimeout boolean

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:396


    setLocalDescription

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

    Parameters:

    Name Type
    localDescription SessionDescription

    Returns: Future<SessionDescription>

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:392


    setRemoteDescription

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

    Parameters:

    Name Type
    remoteDescription SessionDescription

    Returns: Future<SessionDescription>

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:400


    setTieBreaker

    ▸ setTieBreaker(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:412


    setTimeout

    ▸ setTimeout(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:404


    setTrickleIcePolicy

    ▸ setTrickleIcePolicy(value: TrickleIcePolicy): void

    Parameters:

    Name Type
    value TrickleIcePolicy

    Returns: void

    Implementation of: IExternalConnection

    Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:408


    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