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

    Methods

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

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

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

    Parameters:

    Name Type
    streams Stream[]

    Returns: Connection

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

    + new Connection(streams: Stream[], useWebSocketsForMedia: boolean): Connection

    Parameters:

    Name Type
    streams Stream[]
    useWebSocketsForMedia boolean

    Returns: Connection

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

    Methods

    addIceServer

    ▸ addIceServer(iceServer: IceServer): void

    Parameters:

    Name Type
    iceServer IceServer

    Returns: void

    Implementation of: IExternalConnection

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


    addIceServers

    ▸ addIceServers(iceServers: IceServer[]): void

    Parameters:

    Name Type
    iceServers IceServer[]

    Returns: void

    Implementation of: IExternalConnection

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


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


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


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


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


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


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


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


    addOnRoundTripTime

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

    Parameters:

    Name Type
    value IAction1<number>

    Returns: void

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


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


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


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


    addToWebSocketConnection

    ▸ addToWebSocketConnection(openArgs: WssServiceOpenArgs): void

    Parameters:

    Name Type
    openArgs WssServiceOpenArgs

    Returns: void

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


    close

    ▸ close(): boolean

    Returns: boolean

    Implementation of: IExternalConnection

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


    createAnswer

    ▸ createAnswer(): Future<SessionDescription>

    Returns: Future<SessionDescription>

    Implementation of: IExternalConnection

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


    createOffer

    ▸ createOffer(): Future<SessionDescription>

    Returns: Future<SessionDescription>

    Implementation of: IExternalConnection

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


    externalToInternal

    ▸ PrivateexternalToInternal(external: IExternalStream): IInternalStream

    Parameters:

    Name Type
    external IExternalStream

    Returns: IInternalStream

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


    externalsToInternals

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

    Parameters:

    Name Type
    externals IExternalStream[]

    Returns: IInternalStream[]

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


    getAudioStream

    ▸ getAudioStream(): AudioStream

    Returns: AudioStream

    Implementation of: IExternalConnection

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


    getAudioStreams

    ▸ getAudioStreams(): AudioStream[]

    Returns: AudioStream[]

    Implementation of: IExternalConnection

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


    getBundlePolicy

    ▸ getBundlePolicy(): BundlePolicy

    Returns: BundlePolicy

    Implementation of: IExternalConnection

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


    getCanonicalName

    ▸ getCanonicalName(): string

    Returns: string

    Implementation of: IExternalConnection

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


    getDataStream

    ▸ getDataStream(): DataStream

    Returns: DataStream

    Implementation of: IExternalConnection

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


    getDataStreams

    ▸ getDataStreams(): DataStream[]

    Returns: DataStream[]

    Implementation of: IExternalConnection

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


    getDeadStreamTimeout

    ▸ getDeadStreamTimeout(): number

    Returns: number

    Implementation of: IExternalConnection

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


    getDiagnosticsConfig

    ▸ getDiagnosticsConfig(): DiagnosticsConfig

    Returns: DiagnosticsConfig

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


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


    getError

    ▸ getError(): Error

    Returns: Error

    Implementation of: IExternalConnection

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


    getExternalId

    ▸ getExternalId(): string

    Returns: string

    Implementation of: IExternalConnection

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


    getGatheringState

    ▸ getGatheringState(): IceGatheringState

    Returns: IceGatheringState

    Implementation of: IExternalConnection

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


    getHasAudio

    ▸ getHasAudio(): boolean

    Returns: boolean

    Implementation of: IExternalConnection

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


    getHasData

    ▸ getHasData(): boolean

    Returns: boolean

    Implementation of: IExternalConnection

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


    getHasVideo

    ▸ getHasVideo(): boolean

    Returns: boolean

    Implementation of: IExternalConnection

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


    getIceConnectionState

    ▸ getIceConnectionState(): IceConnectionState

    Returns: IceConnectionState

    Implementation of: IExternalConnection

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


    getIceGatherPolicy

    ▸ getIceGatherPolicy(): IceGatherPolicy

    Returns: IceGatherPolicy

    Implementation of: IExternalConnection

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


    getIceServer

    ▸ getIceServer(): IceServer

    Returns: IceServer

    Implementation of: IExternalConnection

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


    getIceServers

    ▸ getIceServers(): IceServer[]

    Returns: IceServer[]

    Implementation of: IExternalConnection

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


    getId

    ▸ getId(): string

    Returns: string

    Implementation of: IExternalConnection

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


    getLegacyTimeout

    ▸ getLegacyTimeout(): boolean

    Returns: boolean

    Implementation of: IExternalConnection

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


    getLocalDescription

    ▸ getLocalDescription(): SessionDescription

    Returns: SessionDescription

    Implementation of: IExternalConnection

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


    getMediaProtocol

    ▸ getMediaProtocol(): MediaProtocol

    Returns: MediaProtocol

    Implementation of: IExternalConnection

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


    getRemoteDescription

    ▸ getRemoteDescription(): SessionDescription

    Returns: SessionDescription

    Implementation of: IExternalConnection

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


    getRemoteMedia

    ▸ getRemoteMedia(): RemoteMedia

    Returns: RemoteMedia

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


    getSignallingState

    ▸ getSignallingState(): SignallingState

    Returns: SignallingState

    Implementation of: IExternalConnection

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


    getState

    ▸ getState(): ConnectionState

    Returns: ConnectionState

    Implementation of: IExternalConnection

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


    getStats

    ▸ getStats(): Future<ConnectionStats>

    Returns: Future<ConnectionStats>

    Implementation of: IExternalConnection

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


    getStreams

    ▸ getStreams(): Stream[]

    Returns: Stream[]

    Implementation of: IExternalConnection

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


    getTieBreaker

    ▸ getTieBreaker(): string

    Returns: string

    Implementation of: IExternalConnection

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


    getTimeout

    ▸ getTimeout(): number

    Returns: number

    Implementation of: IExternalConnection

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


    getTrickleIcePolicy

    ▸ getTrickleIcePolicy(): TrickleIcePolicy

    Returns: TrickleIcePolicy

    Implementation of: IExternalConnection

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


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Dynamic

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


    getVideoEnabledUpdateConnectionPolicy

    ▸ getVideoEnabledUpdateConnectionPolicy(): IFunction1<number, number>

    Returns: IFunction1<number, number>

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


    getVideoRetentionPolicy

    ▸ getVideoRetentionPolicy(): VideoRetentionPolicy

    Returns: VideoRetentionPolicy

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


    getVideoStream

    ▸ getVideoStream(): VideoStream

    Returns: VideoStream

    Implementation of: IExternalConnection

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


    getVideoStreams

    ▸ getVideoStreams(): VideoStream[]

    Returns: VideoStream[]

    Implementation of: IExternalConnection

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


    internalToExternal

    ▸ PrivateinternalToExternal(internal: IInternalStream): IExternalStream

    Parameters:

    Name Type
    internal IInternalStream

    Returns: IExternalStream

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


    internalsToExternals

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

    Parameters:

    Name Type
    internals IInternalStream[]

    Returns: IExternalStream[]

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


    removeIceServer

    ▸ removeIceServer(iceServer: IceServer): void

    Parameters:

    Name Type
    iceServer IceServer

    Returns: void

    Implementation of: IExternalConnection

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


    removeIceServers

    ▸ removeIceServers(iceServers: IceServer[]): void

    Parameters:

    Name Type
    iceServers IceServer[]

    Returns: void

    Implementation of: IExternalConnection

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


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


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


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


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


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


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


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


    removeOnRoundTripTime

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

    Parameters:

    Name Type
    value IAction1<number>

    Returns: void

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


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


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


    setBundlePolicy

    ▸ setBundlePolicy(value: BundlePolicy): void

    Parameters:

    Name Type
    value BundlePolicy

    Returns: void

    Implementation of: IExternalConnection

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


    setDeadStreamTimeout

    ▸ setDeadStreamTimeout(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IExternalConnection

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


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


    setError

    ▸ setError(value: Error): void

    Parameters:

    Name Type
    value Error

    Returns: void

    Implementation of: IExternalConnection

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


    setExternalId

    ▸ setExternalId(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Implementation of: IExternalConnection

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


    setIceGatherPolicy

    ▸ setIceGatherPolicy(value: IceGatherPolicy): void

    Parameters:

    Name Type
    value IceGatherPolicy

    Returns: void

    Implementation of: IExternalConnection

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


    setIceServer

    ▸ setIceServer(value: IceServer): void

    Parameters:

    Name Type
    value IceServer

    Returns: void

    Implementation of: IExternalConnection

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


    setIceServers

    ▸ setIceServers(value: IceServer[]): void

    Parameters:

    Name Type
    value IceServer[]

    Returns: void

    Implementation of: IExternalConnection

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


    setLegacyTimeout

    ▸ setLegacyTimeout(legacyTimeout: boolean): void

    Parameters:

    Name Type
    legacyTimeout boolean

    Returns: void

    Implementation of: IExternalConnection

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


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


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


    setState

    ▸ setState(state: ConnectionState, error: Error): void

    Parameters:

    Name Type
    state ConnectionState
    error Error

    Returns: void

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


    setTieBreaker

    ▸ setTieBreaker(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Implementation of: IExternalConnection

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


    setTimeout

    ▸ setTimeout(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IExternalConnection

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


    setTrickleIcePolicy

    ▸ setTrickleIcePolicy(value: TrickleIcePolicy): void

    Parameters:

    Name Type
    value TrickleIcePolicy

    Returns: void

    Implementation of: IExternalConnection

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


    setVideoEnabledUpdateConnectionPolicy

    ▸ setVideoEnabledUpdateConnectionPolicy(value: IFunction1<number, number>): void

    Parameters:

    Name Type
    value IFunction1<number, number>

    Returns: void

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


    setVideoRetentionPolicy

    ▸ setVideoRetentionPolicy(value: VideoRetentionPolicy): void

    Parameters:

    Name Type
    value VideoRetentionPolicy

    Returns: void

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


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


    updateLogContext

    ▸ updateLogContext(logContext: LogContext): void

    Parameters:

    Name Type
    logContext LogContext

    Returns: void

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


    updateWebSocketConnection

    ▸ updateWebSocketConnection(config: ConnectionConfig, promise: Promise<object>): void

    Parameters:

    Name Type
    config ConnectionConfig
    promise Promise<object>

    Returns: void

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

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