/ fm / liveswitch / WebRtcConnection

Class: WebRtcConnection

fm.liveswitch.WebRtcConnection

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

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

_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:2597

_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:2596

dtmfSender

• Private dtmfSender: RTCDTMFSender= null

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

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

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

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

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

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

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

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

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

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

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

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

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

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

addStreamInternal

▸ PrivateaddStreamInternal(stream: WebRtcStream): void

Parameters:

Name Type
stream WebRtcStream

Returns: void

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

addStreamsInternal

▸ PrivateaddStreamsInternal(streams: WebRtcStream[]): void

Parameters:

Name Type
streams WebRtcStream[]

Returns: void

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

addToWebSocketConnection

▸ addToWebSocketConnection(openArgs: WssServiceOpenArgs): void

Parameters:

Name Type
openArgs WssServiceOpenArgs

Returns: void

Implementation of: IInternalConnection

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

assignRemoteDescriptionInternal

▸ ProtectedassignRemoteDescriptionInternal(sessionDescription: SessionDescription): void

Parameters:

Name Type
sessionDescription SessionDescription

Returns: void

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

close

▸ close(): boolean

Returns: boolean

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

constraintMax

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

Parameters:

Name Type
num1 number
num2 number

Returns: number

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

constraintMin

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

Parameters:

Name Type
num1 number
num2 number

Returns: number

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

createAnswer

▸ createAnswer(): Future<SessionDescription>

Creates an answer.

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

createOffer

▸ createOffer(): Future<SessionDescription>

Creates an offer.

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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

doClose

▸ PrivatedoClose(): void

Returns: void

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

doCreate

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

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: void

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

doCreateAnswer

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

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: void

Overrides: WebRtcConnectionBase

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

doCreateOffer

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

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: boolean

Overrides: WebRtcConnectionBase

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

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

doSendCachedLocalCandidates

▸ ProtecteddoSendCachedLocalCandidates(): void

Returns: void

Overrides: WebRtcConnectionBase

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

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

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

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

finalizeBitrateChange

▸ PrivatefinalizeBitrateChange(): void

Returns: void

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

getActiveCandidatePair

▸ PrivategetActiveCandidatePair(connectionStats: ConnectionStats, attemptsLeft: number): string

Parameters:

Name Type
connectionStats ConnectionStats
attemptsLeft number

Returns: string

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

getAudioStream

▸ getAudioStream(): WebRtcAudioStream

Gets the first audio stream.

Returns: WebRtcAudioStream

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getAudioStreams

▸ getAudioStreams(): WebRtcAudioStream[]

Returns: WebRtcAudioStream[]

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getBundlePolicy

▸ getBundlePolicy(): BundlePolicy

Gets the bundle policy.

Returns: BundlePolicy

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getCandidatePairStats

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

Parameters:

Name Type
candidatePairId string
report any

Returns: CandidatePairStats

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

getCandidatePairString

▸ PrivategetCandidatePairString(local: CandidateStats, remote: CandidateStats, attemptsLeft: number): string

Parameters:

Name Type
local CandidateStats
remote CandidateStats
attemptsLeft number

Returns: string

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

getCandidateStats

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

Parameters:

Name Type
candidateId string
report any

Returns: CandidateStats

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

getCandidateType

▸ PrivategetCandidateType(candidateType: CandidateType): string

Parameters:

Name Type
candidateType CandidateType

Returns: string

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

getCandidates

▸ PrivategetCandidates(transportStats: TransportStats, local: boolean): ManagedConcurrentDictionary<string, CandidateStats>

Parameters:

Name Type
transportStats TransportStats
local boolean

Returns: ManagedConcurrentDictionary<string, CandidateStats>

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

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

getCertificateStats

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

Parameters:

Name Type
certificateId string
report any

Returns: CertificateStats

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

getChromeVersion

▸ PrivategetChromeVersion(): number

Returns: number

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

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

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

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

getConnectionDetails

▸ PrivategetConnectionDetails(): Future<ConnectionStats>

Returns: Future<ConnectionStats>

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

getDataStream

▸ getDataStream(): WebRtcDataStream

Gets the first data stream.

Returns: WebRtcDataStream

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getDataStreams

▸ getDataStreams(): WebRtcDataStream[]

Returns: WebRtcDataStream[]

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

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

getDtmfSender

▸ getDtmfSender(): RTCDTMFSender

Returns: RTCDTMFSender

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

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

getError

▸ getError(): Error

Gets the error.

Returns: Error

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getExtRtpMapAttributesWithNoDuplicateUri

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

Parameters:

Name Type
newList ExtMapAttribute[]
sessionDescription SessionDescription

Returns: ExtMapAttribute[]

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

getExternalId

▸ getExternalId(): string

Gets the external identifier.

Returns: string

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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

getGatheringState

▸ getGatheringState(): IceGatheringState

Returns: IceGatheringState

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

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

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

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

getIceCandidateProcessingTimeout

▸ getIceCandidateProcessingTimeout(): number

Returns: number

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

getIceConnectionState

▸ getIceConnectionState(): IceConnectionState

Returns: IceConnectionState

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getIceGatherPolicy

▸ getIceGatherPolicy(): IceGatherPolicy

Gets the ICE gather policy.

Returns: IceGatherPolicy

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getIceServer

▸ getIceServer(): IceServer

Gets the ICE server.

Returns: IceServer

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getIceServers

▸ getIceServers(): IceServer[]

Gets the ICE servers.

Returns: IceServer[]

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getId

▸ getId(): string

Gets the identifier.

Returns: string

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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

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

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

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

getLocalDescription

▸ getLocalDescription(): SessionDescription

Returns: SessionDescription

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getMediaProtocol

▸ getMediaProtocol(): MediaProtocol

Gets the media protocol in use on this connection.

Returns: MediaProtocol

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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

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

getMediaStreams

▸ getMediaStreams(): WebRtcMediaStream<WebRtcMediaTrack>[]

Returns: WebRtcMediaStream<WebRtcMediaTrack>[]

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

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

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

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

getRtpSender

▸ PrivategetRtpSender(streamType: StreamType): RTCRtpSender

Parameters:

Name Type
streamType StreamType

Returns: RTCRtpSender

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

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

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

getStats

▸ getStats(): Future<ConnectionStats>

Returns: Future<ConnectionStats>

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getStream

▸ getStream(): WebRtcStream

Gets the first stream.

Returns: WebRtcStream

Inherited from: WebRtcConnectionBase

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

getStreamTransport

▸ PrivategetStreamTransport(connectionStats: ConnectionStats): TransportStats

Parameters:

Name Type
connectionStats ConnectionStats

Returns: TransportStats

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

getStreams

▸ getStreams(): WebRtcStream[]

Returns: WebRtcStream[]

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getTieBreaker

▸ getTieBreaker(): string

Gets the tie breaker.

Returns: string

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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

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

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

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: WebRtcConnectionBase

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

getVideoEnabledUpdateConnectionPolicy

▸ getVideoEnabledUpdateConnectionPolicy(): IFunction1<number, number>

Gets a method that determines when to enable video again on a connection that dynamically disables video. Optional. If not set, default policy will be used. Takes in an interger parameter that represents the amount of attempts already tried. Will return an interger value as a time period in seconds for how long to wait for the next attempt or -1 for no more attempts.

Returns: IFunction1<number, number>

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getVideoRetentionPolicy

▸ getVideoRetentionPolicy(): VideoRetentionPolicy

Gets the Video Retention Policy. This will determine how we will handle video on the connection when the connection is poor in quality.

Returns: VideoRetentionPolicy

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getVideoStream

▸ getVideoStream(): WebRtcVideoStream

Gets the first video stream.

Returns: WebRtcVideoStream

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getVideoStreams

▸ getVideoStreams(): WebRtcVideoStream[]

Returns: WebRtcVideoStream[]

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getWebRTCBundlePolicyString

▸ PrivategetWebRTCBundlePolicyString(): RTCBundlePolicy

Returns: RTCBundlePolicy

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

getWebRTCIceTransportPolicyString

▸ PrivategetWebRTCIceTransportPolicyString(): RTCIceTransportPolicy

Returns: RTCIceTransportPolicy

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

initialize

▸ Privateinitialize(): void

Returns: void

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

injectDiscoveredCandidatesIntoSdp

▸ PrivateinjectDiscoveredCandidatesIntoSdp(): void

Returns: void

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

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

onIceConnectionStateChange

▸ PrivateonIceConnectionStateChange(): void

Returns: void

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

printActiveCandidatePair

▸ PrivateprintActiveCandidatePair(attemptsLeft: number): void

Parameters:

Name Type
attemptsLeft number

Returns: void

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

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

processIceGatheringStateComplete

▸ PrivateprocessIceGatheringStateComplete(): void

Returns: void

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

processNextSetMaxSendBitrate

▸ PrivateprocessNextSetMaxSendBitrate(): void

Returns: void

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

processStateChange

▸ processStateChange(): void

Returns: void

Overrides: WebRtcConnectionBase

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

removeSdesAttributesIfNeeded

▸ PrivateremoveSdesAttributesIfNeeded(remoteDescription: SessionDescription): void

Parameters:

Name Type
remoteDescription SessionDescription

Returns: void

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

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

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

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

sessionDescriptionTypeToEnum

▸ PrivatesessionDescriptionTypeToEnum(typeString: string): SessionDescriptionType

Parameters:

Name Type
typeString string

Returns: SessionDescriptionType

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

sessionDescriptionTypeToString

▸ PrivatesessionDescriptionTypeToString(typeEnum: SessionDescriptionType): string

Parameters:

Name Type
typeEnum SessionDescriptionType

Returns: string

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

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

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

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

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

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

setGatheringState

▸ ProtectedsetGatheringState(state: IceGatheringState): void

Parameters:

Name Type
state IceGatheringState

Returns: void

Overrides: WebRtcConnectionBase

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

setIceCandidateProcessingTimeout

▸ setIceCandidateProcessingTimeout(value: number): void

Parameters:

Name Type
value number

Returns: void

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

setIceConnectionState

▸ ProtectedsetIceConnectionState(state: IceConnectionState): void

Parameters:

Name Type
state IceConnectionState

Returns: void

Overrides: WebRtcConnectionBase

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

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

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

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

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

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

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

setMediaProtocol

▸ setMediaProtocol(value: MediaProtocol): void

Sets the media protocol in use on this connection.

Parameters:

Name Type
value MediaProtocol

Returns: void

Inherited from: WebRtcConnectionBase

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

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

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

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

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

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

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

setVideoEnabledUpdateConnectionPolicy

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

Sets a method that determines when to enable video again on a connection that dynamically disables video. Optional. If not set, default policy will be used. Takes in an interger parameter that represents the amount of attempts already tried. Will return an interger value as a time period in seconds for how long to wait for the next attempt or -1 for no more attempts.

Parameters:

Name Type
value IFunction1<number, number>

Returns: void

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

setVideoRetentionPolicy

▸ setVideoRetentionPolicy(value: VideoRetentionPolicy): void

Sets the Video Retention Policy. This will determine how we will handle video on the connection when the connection is poor in quality.

Parameters:

Name Type
value VideoRetentionPolicy

Returns: void

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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

startConnectionTimeout

▸ PrivatestartConnectionTimeout(): void

Returns: void

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

syncStreamsWithRemoteDescription

▸ PrivatesyncStreamsWithRemoteDescription(remoteDescription: SessionDescription): void

Parameters:

Name Type
remoteDescription SessionDescription

Returns: void

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

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

updateLocalDescription

▸ PrivateupdateLocalDescription(localDescription: SessionDescription): SessionDescription

Parameters:

Name Type
localDescription SessionDescription

Returns: SessionDescription

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

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

updateWebSocketConnection

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

Parameters:

Name Type
config ConnectionConfig
promise Promise<object>

Returns: void

Implementation of: IInternalConnection

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

validateCandidate

▸ PrivatevalidateCandidate(candidate: Candidate): boolean

Parameters:

Name Type
candidate Candidate

Returns: boolean

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

webrtcCandidateFromCandidate

▸ PrivatewebrtcCandidateFromCandidate(candidate: Candidate): RTCIceCandidate

Parameters:

Name Type
candidate Candidate

Returns: RTCIceCandidate

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

webrtcSessionDescriptionFromSessionDescription

▸ PrivatewebrtcSessionDescriptionFromSessionDescription(sessionDescription: SessionDescription): WebRtcSessionDescription

Parameters:

Name Type
sessionDescription SessionDescription

Returns: WebRtcSessionDescription

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

webrtcSessionDescriptionToSessionDescription

▸ PrivatewebrtcSessionDescriptionToSessionDescription(webrtcSessionDescription: WebRtcSessionDescription): SessionDescription

Parameters:

Name Type
webrtcSessionDescription WebRtcSessionDescription

Returns: SessionDescription

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

streamTypeToMediaStreamTrackKind

▸ Private StaticstreamTypeToMediaStreamTrackKind(streamType: StreamType): string

Parameters:

Name Type
streamType StreamType

Returns: string

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