Search Results for

    / fm / liveswitch / WebRtcConnection

    Class: WebRtcConnection

    fm.liveswitch.WebRtcConnection

    Hierarchy

    • WebRtcConnectionBase<WebRtcConnection, WebRtcStream, WebRtcAudioStream, WebRtcVideoStream, WebRtcDataStream, WebRtcDataChannel>

      ↳ WebRtcConnection

    Implements

    • IInternalConnection

    Table of contents

    Constructors

    • constructor

    Properties

    • _dataStreamsReady
    • _lastMediaComponentFrameStatsCollection
    • _mediaStreamsReady
    • _processingMaxSendBitrate
    • _remoteMediaTrackCount
    • _setMaxSendBitrateQueue
    • dtmfSender

    Methods

    • addExtRtpMapAttributesOnRenegotiationOffer
    • addIceServer
    • addIceServers
    • addOnExternalIdChange
    • addOnGatheringStateChange
    • addOnIceConnectionStateChange
    • addOnLocalCandidate
    • addOnLocalDescription
    • addOnRemoteCandidate
    • addOnRemoteDescription
    • addOnSignallingStateChange
    • addOnStateChange
    • addRemoteCandidate
    • addStreamInternal
    • addStreamsInternal
    • assignRemoteDescriptionInternal
    • close
    • constraintMax
    • constraintMin
    • createAnswer
    • createOffer
    • doAddRemoteCandidate
    • doClose
    • doCreate
    • doCreateAnswer
    • doCreateOffer
    • doProcessDescription
    • doSendCachedLocalCandidates
    • doSetLocalDescription
    • doSetMaxSendBitrate
    • doSetRemoteDescription
    • finalizeBitrateChange
    • getAudioStream
    • getAudioStreams
    • getBundlePolicy
    • getCandidatePairStats
    • getCandidateStats
    • getCanonicalName
    • getCertificateStats
    • getChromeVersion
    • getClosed
    • getCodecStats
    • getConnected
    • getDataStream
    • getDataStreams
    • getDeadStreamTimeout
    • getDtmfSender
    • getDynamicProperties
    • getDynamicValue
    • getError
    • getExtRtpMapAttributesWithNoDuplicateUri
    • getExternalId
    • getFailed
    • getGatheringState
    • getHasAudio
    • getHasData
    • getHasVideo
    • getIceCandidateProcessingTimeout
    • getIceConnectionState
    • getIceGatherPolicy
    • getIceServer
    • getIceServers
    • getId
    • getInstance
    • getIsTerminated
    • getIsTerminating
    • getIsTerminatingOrTerminated
    • getLegacyTimeout
    • getLocalDescription
    • getMediaReceiverStats
    • getMediaSenderStats
    • getMediaStreams
    • getMediaTrackStats
    • getNativePeerConnection
    • getRemoteDescription
    • getRemoteMedia
    • getRemoteReceiverStats
    • getRtpSender
    • getSignallingState
    • getState
    • getStats
    • getStream
    • getStreams
    • getTieBreaker
    • getTimeout
    • getTransportStats
    • getTrickleIcePolicy
    • getTypeString
    • getVideoStream
    • getVideoStreams
    • getWebRTCBundlePolicyString
    • getWebRTCIceTransportPolicyString
    • initialize
    • injectDiscoveredCandidatesIntoSdp
    • modifyExtRtpMapId
    • onIceConnectionStateChange
    • processDescription
    • processIceGatheringStateComplete
    • processNextSetMaxSendBitrate
    • processStateChange
    • raiseGatheringStateChange
    • raiseIceConnectionStateChange
    • raiseLocalCandidate
    • reallocateRtpExtMapId
    • removeIceServer
    • removeIceServers
    • removeOnExternalIdChange
    • removeOnGatheringStateChange
    • removeOnIceConnectionStateChange
    • removeOnLocalCandidate
    • removeOnLocalDescription
    • removeOnRemoteCandidate
    • removeOnRemoteDescription
    • removeOnSignallingStateChange
    • removeOnStateChange
    • removeSdesAttributesIfNeeded
    • reorderExtRtpMapIdsOnRenegotiationOffer
    • replaceLocalTrack
    • replaceRemoteTrack
    • sessionDescriptionTypeToEnum
    • sessionDescriptionTypeToString
    • setBundlePolicy
    • setDeadStreamTimeout
    • setDynamicValue
    • setError
    • setExternalId
    • setGatheringState
    • setIceCandidateProcessingTimeout
    • setIceConnectionState
    • setIceGatherPolicy
    • setIceServer
    • setIceServers
    • setLegacyTimeout
    • setLocalDescription
    • setMaxSendBitrate
    • setNativeDescriptionSuccess
    • setRemoteDescription
    • setSignallingState
    • setTieBreaker
    • setTimeout
    • setTrickleIcePolicy
    • setupTransceivers
    • startConnectionTimeout
    • syncStreamsWithRemoteDescription
    • unsetDynamicValue
    • updateLocalDescription
    • updateMaxBitrateRemoteSdpMessage
    • validateCandidate
    • webrtcCandidateFromCandidate
    • webrtcSessionDescriptionFromSessionDescription
    • webrtcSessionDescriptionToSessionDescription

    Constructors

    constructor

    + new WebRtcConnection(external: IExternalConnection, streams: WebRtcStream[], remoteMedia: WebRtcRemoteMedia): WebRtcConnection

    Parameters:

    Name Type
    external IExternalConnection
    streams WebRtcStream[]
    remoteMedia WebRtcRemoteMedia

    Returns: WebRtcConnection

    Inherited from: WebRtcConnectionBase

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

    Properties

    _dataStreamsReady

    • Private _dataStreamsReady: boolean= false

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


    _lastMediaComponentFrameStatsCollection

    • Private _lastMediaComponentFrameStatsCollection: any

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:756


    _mediaStreamsReady

    • Private _mediaStreamsReady: boolean= false

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


    _processingMaxSendBitrate

    • Private _processingMaxSendBitrate: boolean= false

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2430


    _remoteMediaTrackCount

    • Private _remoteMediaTrackCount: number= 0

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


    _setMaxSendBitrateQueue

    • Private _setMaxSendBitrateQueue: any[]

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2429


    dtmfSender

    • Private dtmfSender: RTCDTMFSender= null

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2330

    Methods

    addExtRtpMapAttributesOnRenegotiationOffer

    ▸ PrivateaddExtRtpMapAttributesOnRenegotiationOffer(localDescription: SessionDescription, remoteDescription: SessionDescription): void

    Parameters:

    Name Type
    localDescription SessionDescription
    remoteDescription SessionDescription

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1572


    addIceServer

    ▸ addIceServer(iceServer: IceServer): void

    Adds an ICE server.

    Parameters:

    Name Type Description
    iceServer IceServer The ICE server.

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:160


    addIceServers

    ▸ addIceServers(iceServers: IceServer[]): void

    Adds some ICE servers.

    Parameters:

    Name Type Description
    iceServers IceServer[] The ICE servers.

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

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


    addOnExternalIdChange

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

    Adds a handler that is raised when external Id of this connection changes. Old external Id as well as internal Id are raised.

    Parameters:

    Name Type
    value IAction2<string, string>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

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


    addOnGatheringStateChange

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

    Adds a handler that is raised when the gathering state changes.

    Parameters:

    Name Type
    value IAction1<WebRtcConnection>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

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


    addOnIceConnectionStateChange

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

    Adds a handler that is raised when the ice connection state changes.

    Parameters:

    Name Type
    value IAction1<WebRtcConnection>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

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


    addOnLocalCandidate

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

    Adds a handler that is raised when a local candidate is added.

    Parameters:

    Name Type
    value IAction2<WebRtcConnection, Candidate>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

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


    addOnLocalDescription

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

    Adds a handler that is raised when a local description is set.

    Parameters:

    Name Type
    value IAction2<WebRtcConnection, SessionDescription>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

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


    addOnRemoteCandidate

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

    Adds a handler that is raised when a remote description is added.

    Parameters:

    Name Type
    value IAction2<WebRtcConnection, Candidate>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

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


    addOnRemoteDescription

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

    Adds a handler that is raised when a remote description is set.

    Parameters:

    Name Type
    value IAction2<WebRtcConnection, SessionDescription>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

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


    addOnSignallingStateChange

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

    Adds a handler that is raised when the signalling state changes.

    Parameters:

    Name Type
    value IAction1<WebRtcConnection>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

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


    addOnStateChange

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

    Adds a handler that is raised when the connection state changes.

    Parameters:

    Name Type
    value IAction1<WebRtcConnection>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

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


    addRemoteCandidate

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

    Adds the remote candidate.

    Parameters:

    Name Type Description
    remoteCandidate Candidate The remote candidate.

    Returns: Future<Candidate>

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

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


    addStreamInternal

    ▸ PrivateaddStreamInternal(stream: WebRtcStream): void

    Parameters:

    Name Type
    stream WebRtcStream

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:109


    addStreamsInternal

    ▸ PrivateaddStreamsInternal(streams: WebRtcStream[]): void

    Parameters:

    Name Type
    streams WebRtcStream[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:127


    assignRemoteDescriptionInternal

    ▸ ProtectedassignRemoteDescriptionInternal(sessionDescription: SessionDescription): void

    Parameters:

    Name Type
    sessionDescription SessionDescription

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2311


    close

    ▸ close(): boolean

    Returns: boolean

    Implementation of: IInternalConnection

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2314


    constraintMax

    ▸ PrivateconstraintMax(num1: number, num2: number): number

    Parameters:

    Name Type
    num1 number
    num2 number

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:178


    constraintMin

    ▸ PrivateconstraintMin(num1: number, num2: number): number

    Parameters:

    Name Type
    num1 number
    num2 number

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:168


    createAnswer

    ▸ createAnswer(): Future<SessionDescription>

    Creates an answer.

    Returns: Future<SessionDescription>

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:351


    createOffer

    ▸ createOffer(): Future<SessionDescription>

    Creates an offer.

    Returns: Future<SessionDescription>

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

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


    doAddRemoteCandidate

    ▸ ProtecteddoAddRemoteCandidate(promise: Promise<Candidate>, remoteCandidate: Candidate): void

    Parameters:

    Name Type
    promise Promise<Candidate>
    remoteCandidate Candidate

    Returns: void

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2290


    doClose

    ▸ PrivatedoClose(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2322


    doCreate

    ▸ PrivatedoCreate(promise: Promise<SessionDescription>): void

    Parameters:

    Name Type
    promise Promise<SessionDescription>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1637


    doCreateAnswer

    ▸ ProtecteddoCreateAnswer(promise: Promise<SessionDescription>): void

    Parameters:

    Name Type
    promise Promise<SessionDescription>

    Returns: void

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1397


    doCreateOffer

    ▸ ProtecteddoCreateOffer(promise: Promise<SessionDescription>): boolean

    Parameters:

    Name Type
    promise Promise<SessionDescription>

    Returns: boolean

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1392


    doProcessDescription

    ▸ ProtecteddoProcessDescription(description: SessionDescription, isLocalDescription: boolean): Error

    Processes a session description.

    Parameters:

    Name Type Description
    description SessionDescription The session description.
    isLocalDescription boolean Whether this is a local session description.

    Returns: Error

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:455


    doSendCachedLocalCandidates

    ▸ ProtecteddoSendCachedLocalCandidates(): void

    Returns: void

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2288


    doSetLocalDescription

    ▸ ProtecteddoSetLocalDescription(promise: Promise<SessionDescription>, localDescription: SessionDescription): void

    Parameters:

    Name Type
    promise Promise<SessionDescription>
    localDescription SessionDescription

    Returns: void

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2047


    doSetMaxSendBitrate

    ▸ PrivatedoSetMaxSendBitrate(bitrate: number, streamType: StreamType, promise: Promise<object>): void

    Parameters:

    Name Type
    bitrate number
    streamType StreamType
    promise Promise<object>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2456


    doSetRemoteDescription

    ▸ ProtecteddoSetRemoteDescription(promise: Promise<SessionDescription>, remoteDescription: SessionDescription): void

    Parameters:

    Name Type
    promise Promise<SessionDescription>
    remoteDescription SessionDescription

    Returns: void

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2153


    finalizeBitrateChange

    ▸ PrivatefinalizeBitrateChange(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2451


    getAudioStream

    ▸ getAudioStream(): WebRtcAudioStream

    Gets the first audio stream.

    Returns: WebRtcAudioStream

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:543


    getAudioStreams

    ▸ getAudioStreams(): WebRtcAudioStream[]

    Returns: WebRtcAudioStream[]

    Implementation of: IInternalConnection

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:158


    getBundlePolicy

    ▸ getBundlePolicy(): BundlePolicy

    Gets the bundle policy.

    Returns: BundlePolicy

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:565


    getCandidatePairStats

    ▸ PrivategetCandidatePairStats(candidatePairId: string, report: any): CandidatePairStats

    Parameters:

    Name Type
    candidatePairId string
    report any

    Returns: CandidatePairStats

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:641


    getCandidateStats

    ▸ PrivategetCandidateStats(candidateId: string, report: any): CandidateStats

    Parameters:

    Name Type
    candidateId string
    report any

    Returns: CandidateStats

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:594


    getCanonicalName

    ▸ getCanonicalName(): string

    Gets the canonical name.

    deprecated Use MediaStream.LocalCanonicalName instead.

    Returns: string

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:578


    getCertificateStats

    ▸ PrivategetCertificateStats(certificateId: string, report: any): CertificateStats

    Parameters:

    Name Type
    certificateId string
    report any

    Returns: CertificateStats

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:575


    getChromeVersion

    ▸ PrivategetChromeVersion(): number

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:497


    getClosed

    ▸ getClosed(): Future<Object>

    Gets a future that resolves if the connection enters the Closed state or rejects if the connection enters the Failed state before that happens.

    Returns: Future<Object>

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:591


    getCodecStats

    ▸ PrivategetCodecStats(codecId: string, report: any, sender: boolean): CodecStats

    Parameters:

    Name Type
    codecId string
    report any
    sender boolean

    Returns: CodecStats

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:687


    getConnected

    ▸ getConnected(): Future<Object>

    Gets a future that resolves if the connection enters the Connected state or rejects if the connection enters the Failed state before that happens.

    Returns: Future<Object>

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:604


    getDataStream

    ▸ getDataStream(): WebRtcDataStream

    Gets the first data stream.

    Returns: WebRtcDataStream

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:633


    getDataStreams

    ▸ getDataStreams(): WebRtcDataStream[]

    Returns: WebRtcDataStream[]

    Implementation of: IInternalConnection

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:164


    getDeadStreamTimeout

    ▸ getDeadStreamTimeout(): number

    Gets the amount of time (in milliseconds) to wait for connectivity checks to re-establish after they start to fail on a live connection. Defaults to 15,000.

    Returns: number

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:658


    getDtmfSender

    ▸ getDtmfSender(): RTCDTMFSender

    Returns: RTCDTMFSender

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2331


    getDynamicProperties

    ▸ getDynamicProperties(): Hash<string, Object>

    Gets all dynamic properties on this instance.

    Returns: Hash<string, Object>

    Inherited from: WebRtcConnectionBase

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

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


    getError

    ▸ getError(): Error

    Gets the error.

    Returns: Error

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:670


    getExtRtpMapAttributesWithNoDuplicateUri

    ▸ PrivategetExtRtpMapAttributesWithNoDuplicateUri(newList: ExtMapAttribute[], sessionDescription: SessionDescription): ExtMapAttribute[]

    Parameters:

    Name Type
    newList ExtMapAttribute[]
    sessionDescription SessionDescription

    Returns: ExtMapAttribute[]

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1500


    getExternalId

    ▸ getExternalId(): string

    Gets the external identifier.

    Returns: string

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:682


    getFailed

    ▸ getFailed(): Future<Object>

    Gets a future that resolves if the connection enters the Failed state or rejects if the connection enters the Closed state before that happens.

    Returns: Future<Object>

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:695


    getGatheringState

    ▸ getGatheringState(): IceGatheringState

    Returns: IceGatheringState

    Implementation of: IInternalConnection

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1829


    getHasAudio

    ▸ getHasAudio(): boolean

    Gets whether this connection has an audio stream.

    Returns: boolean

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:713


    getHasData

    ▸ getHasData(): boolean

    Gets whether this connection has a data stream.

    Returns: boolean

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:725


    getHasVideo

    ▸ getHasVideo(): boolean

    Gets whether this connection has a video stream.

    Returns: boolean

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:737


    getIceCandidateProcessingTimeout

    ▸ getIceCandidateProcessingTimeout(): number

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1379


    getIceConnectionState

    ▸ getIceConnectionState(): IceConnectionState

    Returns: IceConnectionState

    Implementation of: IInternalConnection

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1832


    getIceGatherPolicy

    ▸ getIceGatherPolicy(): IceGatherPolicy

    Gets the ICE gather policy.

    Returns: IceGatherPolicy

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:755


    getIceServer

    ▸ getIceServer(): IceServer

    Gets the ICE server.

    Returns: IceServer

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:767


    getIceServers

    ▸ getIceServers(): IceServer[]

    Gets the ICE servers.

    Returns: IceServer[]

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:779


    getId

    ▸ getId(): string

    Gets the identifier.

    Returns: string

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:791


    getInstance

    ▸ getInstance(): WebRtcConnection

    Returns: WebRtcConnection

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:105


    getIsTerminated

    ▸ getIsTerminated(): boolean

    Gets a value indicating whether the connection is currently closed or failed.

    Returns: boolean

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:809


    getIsTerminating

    ▸ getIsTerminating(): boolean

    Gets a value indicating whether the connection is currently closing or failing.

    Returns: boolean

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:821


    getIsTerminatingOrTerminated

    ▸ getIsTerminatingOrTerminated(): boolean

    Gets a value indicating whether the connection is currently closing, failing, closed, or failed.

    Returns: boolean

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:833


    getLegacyTimeout

    ▸ getLegacyTimeout(): boolean

    Gets a value indicating whether legacy Connection.Timeout should be used. When disabled, Connection.Timeout only accounts for the time spent trying to establish connectivity (i.e. time it takes to transition from the Connecting to the Connected state; from the time point when both offer and answer had been set to the connection being fully established). When enabled, Connection.Timeout accounts for the time spent from receiving an offer (or creating an offer) to establishing connectivity (i.e. time it takes to transition from Initializing to Connected state). By default, LegacyTimeout is set to true, so that existing behavior is preserved. However, in the future default will be updated to false. This means that IL will not account for any signalling delays that may occur while establishing connectivity. This option will be later deprecated.

    Returns: boolean

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:855


    getLocalDescription

    ▸ getLocalDescription(): SessionDescription

    Returns: SessionDescription

    Implementation of: IInternalConnection

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1826


    getMediaReceiverStats

    ▸ PrivategetMediaReceiverStats(mediaReceiverId: string, report: any, _mediaStream: WebRtcMediaStream<WebRtcMediaTrack>): MediaReceiverStats

    Parameters:

    Name Type
    mediaReceiverId string
    report any
    _mediaStream WebRtcMediaStream<WebRtcMediaTrack>

    Returns: MediaReceiverStats

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:454


    getMediaSenderStats

    ▸ PrivategetMediaSenderStats(mediaSenderId: string, report: any, _mediaStream: WebRtcMediaStream<WebRtcMediaTrack>, remoteInboundRtp: any): MediaSenderStats

    Parameters:

    Name Type
    mediaSenderId string
    report any
    _mediaStream WebRtcMediaStream<WebRtcMediaTrack>
    remoteInboundRtp any

    Returns: MediaSenderStats

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:426


    getMediaStreams

    ▸ getMediaStreams(): WebRtcMediaStream<WebRtcMediaTrack>[]

    Returns: WebRtcMediaStream<WebRtcMediaTrack>[]

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:155


    getMediaTrackStats

    ▸ PrivategetMediaTrackStats(mediaTrackId: string, report: any, _mediaTrack: WebRtcMediaTrack, mediaComponent: any, _mediaStream: WebRtcMediaStream<WebRtcMediaTrack>, local: boolean): MediaTrackStats

    Parameters:

    Name Type
    mediaTrackId string
    report any
    _mediaTrack WebRtcMediaTrack
    mediaComponent any
    _mediaStream WebRtcMediaStream<WebRtcMediaTrack>
    local boolean

    Returns: MediaTrackStats

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:757


    getNativePeerConnection

    ▸ getNativePeerConnection(): RTCPeerConnection

    Returns: RTCPeerConnection

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


    getRemoteDescription

    ▸ getRemoteDescription(): SessionDescription

    Returns: SessionDescription

    Implementation of: IInternalConnection

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1850


    getRemoteMedia

    ▸ getRemoteMedia(): WebRtcRemoteMedia

    Returns: WebRtcRemoteMedia

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


    getRemoteReceiverStats

    ▸ PrivategetRemoteReceiverStats(remoteInboundRtp: any): RemoteReceiverStats

    Parameters:

    Name Type
    remoteInboundRtp any

    Returns: RemoteReceiverStats

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:895


    getRtpSender

    ▸ PrivategetRtpSender(mediaStreamIndex: number): RTCRtpSender

    Parameters:

    Name Type
    mediaStreamIndex number

    Returns: RTCRtpSender

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2412


    getSignallingState

    ▸ getSignallingState(): SignallingState

    Gets the state of the signalling.

    Returns: SignallingState

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:881


    getState

    ▸ getState(): ConnectionState

    Gets the state of the connection.

    Returns: ConnectionState

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:893


    getStats

    ▸ getStats(): Future<ConnectionStats>

    Returns: Future<ConnectionStats>

    Implementation of: IInternalConnection

    Overrides: WebRtcConnectionBase

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


    getStream

    ▸ getStream(): WebRtcStream

    Gets the first stream.

    Returns: WebRtcStream

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:911


    getStreams

    ▸ getStreams(): WebRtcStream[]

    Returns: WebRtcStream[]

    Implementation of: IInternalConnection

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:152


    getTieBreaker

    ▸ getTieBreaker(): string

    Gets the tie breaker.

    Returns: string

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:933


    getTimeout

    ▸ getTimeout(): number

    Gets the amount of time (in milliseconds) to wait for a connection to establish before giving up and closing it. Defaults to 30,000.

    Returns: number

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:947


    getTransportStats

    ▸ PrivategetTransportStats(transportId: string, report: any, mediaSenderStats: MediaSenderStats, mediaReceiverStats: MediaReceiverStats): TransportStats

    Parameters:

    Name Type
    transportId string
    report any
    mediaSenderStats MediaSenderStats
    mediaReceiverStats MediaReceiverStats

    Returns: TransportStats

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:502


    getTrickleIcePolicy

    ▸ getTrickleIcePolicy(): TrickleIcePolicy

    Gets Trickle Ice Support Policy. Cf. https://tools.ietf.org/html/draft-ietf-ice-trickle-05

    Returns: TrickleIcePolicy

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:959


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: WebRtcConnectionBase

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


    getVideoStream

    ▸ getVideoStream(): WebRtcVideoStream

    Gets the first video stream.

    Returns: WebRtcVideoStream

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:979


    getVideoStreams

    ▸ getVideoStreams(): WebRtcVideoStream[]

    Returns: WebRtcVideoStream[]

    Implementation of: IInternalConnection

    Overrides: WebRtcConnectionBase

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


    getWebRTCBundlePolicyString

    ▸ PrivategetWebRTCBundlePolicyString(): RTCBundlePolicy

    Returns: RTCBundlePolicy

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:722


    getWebRTCIceTransportPolicyString

    ▸ PrivategetWebRTCIceTransportPolicyString(): RTCIceTransportPolicy

    Returns: RTCIceTransportPolicy

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:738


    initialize

    ▸ Privateinitialize(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:908


    injectDiscoveredCandidatesIntoSdp

    ▸ PrivateinjectDiscoveredCandidatesIntoSdp(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1409


    modifyExtRtpMapId

    ▸ PrivatemodifyExtRtpMapId(newId: number, oldId: number, sdpMessage: Message): void

    Parameters:

    Name Type
    newId number
    oldId number
    sdpMessage Message

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1490


    onIceConnectionStateChange

    ▸ PrivateonIceConnectionStateChange(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1255


    processDescription

    ▸ ProtectedprocessDescription(description: SessionDescription, isLocalDescription: boolean): Error

    Processes a session description.

    Parameters:

    Name Type Description
    description SessionDescription The session description.
    isLocalDescription boolean Whether this is a local session description.

    Returns: Error

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1013


    processIceGatheringStateComplete

    ▸ PrivateprocessIceGatheringStateComplete(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1402


    processNextSetMaxSendBitrate

    ▸ PrivateprocessNextSetMaxSendBitrate(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2441


    processStateChange

    ▸ processStateChange(): void

    Returns: void

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:133


    raiseGatheringStateChange

    ▸ ProtectedraiseGatheringStateChange(connection: WebRtcConnection): void

    Raises gathering state change.

    Parameters:

    Name Type
    connection WebRtcConnection

    Returns: void

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1090


    raiseIceConnectionStateChange

    ▸ ProtectedraiseIceConnectionStateChange(connection: WebRtcConnection): void

    Raises ICE connection state change.

    Parameters:

    Name Type
    connection WebRtcConnection

    Returns: void

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1110


    raiseLocalCandidate

    ▸ ProtectedraiseLocalCandidate(localCandidate: Candidate): void

    Raises a local candidate but only if it has not been already raised.

    Parameters:

    Name Type Description
    localCandidate Candidate The local candidate.

    Returns: void

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1131


    reallocateRtpExtMapId

    ▸ PrivatereallocateRtpExtMapId(id: number, sdpMessage: Message, extMapAttributes: ExtMapAttribute[], extMapReservedIds: ExtMapAttribute[]): void

    Parameters:

    Name Type
    id number
    sdpMessage Message
    extMapAttributes ExtMapAttribute[]
    extMapReservedIds ExtMapAttribute[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1538


    removeIceServer

    ▸ removeIceServer(iceServer: IceServer): void

    Removes an ICE server.

    Parameters:

    Name Type Description
    iceServer IceServer The ICE server.

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1293


    removeIceServers

    ▸ removeIceServers(iceServers: IceServer[]): void

    Removes some ICE servers.

    Parameters:

    Name Type Description
    iceServers IceServer[] The ICE servers.

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1306


    removeOnExternalIdChange

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

    Removes a handler that is raised when external Id of this connection changes. Old external Id as well as internal Id are raised.

    Parameters:

    Name Type
    value IAction2<string, string>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1318


    removeOnGatheringStateChange

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

    Removes a handler that is raised when the gathering state changes.

    Parameters:

    Name Type
    value IAction1<WebRtcConnection>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1330


    removeOnIceConnectionStateChange

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

    Removes a handler that is raised when the ice connection state changes.

    Parameters:

    Name Type
    value IAction1<WebRtcConnection>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1342


    removeOnLocalCandidate

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

    Removes a handler that is raised when a local candidate is added.

    Parameters:

    Name Type
    value IAction2<WebRtcConnection, Candidate>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1354


    removeOnLocalDescription

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

    Removes a handler that is raised when a local description is set.

    Parameters:

    Name Type
    value IAction2<WebRtcConnection, SessionDescription>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1366


    removeOnRemoteCandidate

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

    Removes a handler that is raised when a remote description is added.

    Parameters:

    Name Type
    value IAction2<WebRtcConnection, Candidate>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1378


    removeOnRemoteDescription

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

    Removes a handler that is raised when a remote description is set.

    Parameters:

    Name Type
    value IAction2<WebRtcConnection, SessionDescription>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1390


    removeOnSignallingStateChange

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

    Removes a handler that is raised when the signalling state changes.

    Parameters:

    Name Type
    value IAction1<WebRtcConnection>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1402


    removeOnStateChange

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

    Removes a handler that is raised when the connection state changes.

    Parameters:

    Name Type
    value IAction1<WebRtcConnection>

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1414


    removeSdesAttributesIfNeeded

    ▸ PrivateremoveSdesAttributesIfNeeded(remoteDescription: SessionDescription): void

    Parameters:

    Name Type
    remoteDescription SessionDescription

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2126


    reorderExtRtpMapIdsOnRenegotiationOffer

    ▸ PrivatereorderExtRtpMapIdsOnRenegotiationOffer(newOffer: SessionDescription, lastLocalDescription: SessionDescription, lastRemoteDescription: SessionDescription): void

    Parameters:

    Name Type
    newOffer SessionDescription
    lastLocalDescription SessionDescription
    lastRemoteDescription SessionDescription

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1598


    replaceLocalTrack

    ▸ replaceLocalTrack(localTrack: WebRtcMediaTrack, mediaStream: WebRtcMediaStream<WebRtcMediaTrack>): Future<object>

    Parameters:

    Name Type
    localTrack WebRtcMediaTrack
    mediaStream WebRtcMediaStream<WebRtcMediaTrack>

    Returns: Future<object>

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2379


    replaceRemoteTrack

    ▸ replaceRemoteTrack(remoteTrack: WebRtcMediaTrack, mediaStream: WebRtcMediaStream<WebRtcMediaTrack>): Future<object>

    Parameters:

    Name Type
    remoteTrack WebRtcMediaTrack
    mediaStream WebRtcMediaStream<WebRtcMediaTrack>

    Returns: Future<object>

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2408


    sessionDescriptionTypeToEnum

    ▸ PrivatesessionDescriptionTypeToEnum(typeString: string): SessionDescriptionType

    Parameters:

    Name Type
    typeString string

    Returns: SessionDescriptionType

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1347


    sessionDescriptionTypeToString

    ▸ PrivatesessionDescriptionTypeToString(typeEnum: SessionDescriptionType): string

    Parameters:

    Name Type
    typeEnum SessionDescriptionType

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1343


    setBundlePolicy

    ▸ setBundlePolicy(value: BundlePolicy): void

    Sets the bundle policy.

    Parameters:

    Name Type
    value BundlePolicy

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1447


    setDeadStreamTimeout

    ▸ setDeadStreamTimeout(value: number): void

    Sets the amount of time (in milliseconds) to wait for connectivity checks to re-establish after they start to fail on a live connection. Defaults to 15,000.

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1466


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

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:95


    setError

    ▸ setError(value: Error): void

    Sets the error.

    Parameters:

    Name Type
    value Error

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1479


    setExternalId

    ▸ setExternalId(value: string): void

    Sets the external identifier.

    Parameters:

    Name Type
    value string

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1491


    setGatheringState

    ▸ ProtectedsetGatheringState(state: IceGatheringState): void

    Parameters:

    Name Type
    state IceGatheringState

    Returns: void

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1835


    setIceCandidateProcessingTimeout

    ▸ setIceCandidateProcessingTimeout(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1383


    setIceConnectionState

    ▸ ProtectedsetIceConnectionState(state: IceConnectionState): void

    Parameters:

    Name Type
    state IceConnectionState

    Returns: void

    Overrides: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1844


    setIceGatherPolicy

    ▸ setIceGatherPolicy(value: IceGatherPolicy): void

    Sets the ICE gather policy.

    Parameters:

    Name Type
    value IceGatherPolicy

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1527


    setIceServer

    ▸ setIceServer(value: IceServer): void

    Sets the ICE server.

    Parameters:

    Name Type
    value IceServer

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1539


    setIceServers

    ▸ setIceServers(value: IceServer[]): void

    Sets the ICE servers.

    Parameters:

    Name Type
    value IceServer[]

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1551


    setLegacyTimeout

    ▸ setLegacyTimeout(value: boolean): void

    Sets a value indicating whether legacy Connection.Timeout should be used. When disabled, Connection.Timeout only accounts for the time spent trying to establish connectivity (i.e. time it takes to transition from the Connecting to the Connected state; from the time point when both offer and answer had been set to the connection being fully established). When enabled, Connection.Timeout accounts for the time spent from receiving an offer (or creating an offer) to establishing connectivity (i.e. time it takes to transition from Initializing to Connected state). By default, LegacyTimeout is set to true, so that existing behavior is preserved. However, in the future default will be updated to false. This means that IL will not account for any signalling delays that may occur while establishing connectivity. This option will be later deprecated.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1573


    setLocalDescription

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

    Sets the local description.

    Parameters:

    Name Type Description
    localDescription SessionDescription The local description.

    Returns: Future<SessionDescription>

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1586


    setMaxSendBitrate

    ▸ setMaxSendBitrate(bitrate: number, streamType: StreamType): Future<object>

    Parameters:

    Name Type
    bitrate number
    streamType StreamType

    Returns: Future<object>

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2431


    setNativeDescriptionSuccess

    ▸ PrivatesetNativeDescriptionSuccess(sessionDescription: SessionDescription, promise: Promise<SessionDescription>): void

    Parameters:

    Name Type
    sessionDescription SessionDescription
    promise Promise<SessionDescription>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1471


    setRemoteDescription

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

    Sets the remote description.

    Parameters:

    Name Type Description
    remoteDescription SessionDescription The remote description.

    Returns: Future<SessionDescription>

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1642


    setSignallingState

    ▸ ProtectedsetSignallingState(value: SignallingState): void

    Sets the state of the signalling.

    Parameters:

    Name Type
    value SignallingState

    Returns: void

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1701


    setTieBreaker

    ▸ setTieBreaker(value: string): void

    Sets the tie breaker.

    Parameters:

    Name Type
    value string

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1787


    setTimeout

    ▸ setTimeout(value: number): void

    Sets the amount of time (in milliseconds) to wait for a connection to establish before giving up and closing it. Defaults to 30,000.

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1801


    setTrickleIcePolicy

    ▸ setTrickleIcePolicy(value: TrickleIcePolicy): void

    Sets Trickle Ice Support Policy. Cf. https://tools.ietf.org/html/draft-ietf-ice-trickle-05

    Parameters:

    Name Type
    value TrickleIcePolicy

    Returns: void

    Implementation of: IInternalConnection

    Inherited from: WebRtcConnectionBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1814


    setupTransceivers

    ▸ PrivatesetupTransceivers(useAddTransceiver: boolean, useAddTrack: boolean, nativeMediaStreamTrack: MediaStreamTrack, nativeMediaStream: any, mediaStream: WebRtcMediaStream<WebRtcMediaTrack>): void

    Parameters:

    Name Type
    useAddTransceiver boolean
    useAddTrack boolean
    nativeMediaStreamTrack MediaStreamTrack
    nativeMediaStream any
    mediaStream WebRtcMediaStream<WebRtcMediaTrack>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1281


    startConnectionTimeout

    ▸ PrivatestartConnectionTimeout(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:141


    syncStreamsWithRemoteDescription

    ▸ PrivatesyncStreamsWithRemoteDescription(remoteDescription: SessionDescription): void

    Parameters:

    Name Type
    remoteDescription SessionDescription

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2275


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

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:122


    updateLocalDescription

    ▸ PrivateupdateLocalDescription(localDescription: SessionDescription): SessionDescription

    Parameters:

    Name Type
    localDescription SessionDescription

    Returns: SessionDescription

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1868


    updateMaxBitrateRemoteSdpMessage

    ▸ PrivateupdateMaxBitrateRemoteSdpMessage(bitrate: number, stream: WebRtcAudioStream | WebRtcVideoStream, sdpMediaDescription: MediaDescription): boolean

    Parameters:

    Name Type
    bitrate number
    stream WebRtcAudioStream | WebRtcVideoStream
    sdpMediaDescription MediaDescription

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2549


    validateCandidate

    ▸ PrivatevalidateCandidate(candidate: Candidate): boolean

    Parameters:

    Name Type
    candidate Candidate

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1334


    webrtcCandidateFromCandidate

    ▸ PrivatewebrtcCandidateFromCandidate(candidate: Candidate): RTCIceCandidate

    Parameters:

    Name Type
    candidate Candidate

    Returns: RTCIceCandidate

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1351


    webrtcSessionDescriptionFromSessionDescription

    ▸ PrivatewebrtcSessionDescriptionFromSessionDescription(sessionDescription: SessionDescription): WebRtcSessionDescription

    Parameters:

    Name Type
    sessionDescription SessionDescription

    Returns: WebRtcSessionDescription

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1366


    webrtcSessionDescriptionToSessionDescription

    ▸ PrivatewebrtcSessionDescriptionToSessionDescription(webrtcSessionDescription: WebRtcSessionDescription): SessionDescription

    Parameters:

    Name Type
    webrtcSessionDescription WebRtcSessionDescription

    Returns: SessionDescription

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1358

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