/ 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:769

_logContext

• Private _logContext: LogContext

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

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

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

dtmfSender

• Private dtmfSender: RTCDTMFSender= null

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

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

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

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

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

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

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

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

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

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

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

addOnRoundTripTime

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

Adds a handler that is raised when a new round trip time is calculated.

Parameters:

Name Type
value IAction1<number>

Returns: void

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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

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

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

addStreamInternal

▸ PrivateaddStreamInternal(stream: WebRtcStream): void

Parameters:

Name Type
stream WebRtcStream

Returns: void

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

addStreamsInternal

▸ PrivateaddStreamsInternal(streams: WebRtcStream[]): void

Parameters:

Name Type
streams WebRtcStream[]

Returns: void

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

addToWebSocketConnection

▸ addToWebSocketConnection(openArgs: WssServiceOpenArgs): void

Parameters:

Name Type
openArgs WssServiceOpenArgs

Returns: void

Implementation of: IInternalConnection

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

assignRemoteDescriptionInternal

▸ ProtectedassignRemoteDescriptionInternal(sessionDescription: SessionDescription): void

Parameters:

Name Type
sessionDescription SessionDescription

Returns: void

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

close

▸ close(): boolean

Returns: boolean

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

constraintMax

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

Parameters:

Name Type
num1 number
num2 number

Returns: number

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

constraintMin

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

Parameters:

Name Type
num1 number
num2 number

Returns: number

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

createAnswer

▸ createAnswer(): Future<SessionDescription>

Creates an answer.

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

createOffer

▸ createOffer(): Future<SessionDescription>

Creates an offer.

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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

doClose

▸ PrivatedoClose(): void

Returns: void

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

doCreate

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

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: void

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

doCreateAnswer

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

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: void

Overrides: WebRtcConnectionBase

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

doCreateOffer

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

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: boolean

Overrides: WebRtcConnectionBase

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

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

doSendCachedLocalCandidates

▸ ProtecteddoSendCachedLocalCandidates(): void

Returns: void

Overrides: WebRtcConnectionBase

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

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

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

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

finalizeBitrateChange

▸ PrivatefinalizeBitrateChange(): void

Returns: void

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

getActiveCandidatePair

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

Parameters:

Name Type
connectionStats ConnectionStats
attemptsLeft number

Returns: string

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

getAudioStream

▸ getAudioStream(): WebRtcAudioStream

Gets the first audio stream.

Returns: WebRtcAudioStream

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getAudioStreams

▸ getAudioStreams(): WebRtcAudioStream[]

Returns: WebRtcAudioStream[]

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getBundlePolicy

▸ getBundlePolicy(): BundlePolicy

Gets the bundle policy.

Returns: BundlePolicy

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getCandidatePairStats

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

Parameters:

Name Type
candidatePairId string
report any

Returns: CandidatePairStats

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

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

getCandidateStats

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

Parameters:

Name Type
candidateId string
report any

Returns: CandidateStats

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

getCandidateType

▸ PrivategetCandidateType(candidateType: CandidateType): string

Parameters:

Name Type
candidateType CandidateType

Returns: string

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

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

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

getCertificateStats

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

Parameters:

Name Type
certificateId string
report any

Returns: CertificateStats

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

getChromeVersion

▸ PrivategetChromeVersion(): number

Returns: number

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

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

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

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

getConnectionDetails

▸ PrivategetConnectionDetails(): Future<ConnectionStats>

Returns: Future<ConnectionStats>

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

getDataStream

▸ getDataStream(): WebRtcDataStream

Gets the first data stream.

Returns: WebRtcDataStream

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getDataStreams

▸ getDataStreams(): WebRtcDataStream[]

Returns: WebRtcDataStream[]

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

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

getDtmfSender

▸ getDtmfSender(): RTCDTMFSender

Returns: RTCDTMFSender

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

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

getExtRtpMapAttributesWithNoDuplicateUri

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

Parameters:

Name Type
newList ExtMapAttribute[]
sessionDescription SessionDescription

Returns: ExtMapAttribute[]

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

getExternalId

▸ getExternalId(): string

Gets the external identifier.

Returns: string

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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

getGatheringState

▸ getGatheringState(): IceGatheringState

Returns: IceGatheringState

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

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

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

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

getIceCandidateProcessingTimeout

▸ getIceCandidateProcessingTimeout(): number

Returns: number

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

getIceConnectionState

▸ getIceConnectionState(): IceConnectionState

Returns: IceConnectionState

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getIceGatherPolicy

▸ getIceGatherPolicy(): IceGatherPolicy

Gets the ICE gather policy.

Returns: IceGatherPolicy

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getIceServer

▸ getIceServer(): IceServer

Gets the ICE server.

Returns: IceServer

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getIceServers

▸ getIceServers(): IceServer[]

Gets the ICE servers.

Returns: IceServer[]

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getId

▸ getId(): string

Gets the identifier.

Returns: string

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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

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

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

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

getLocalDescription

▸ getLocalDescription(): SessionDescription

Returns: SessionDescription

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

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

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

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

getMediaStreams

▸ getMediaStreams(): WebRtcMediaStream<WebRtcMediaTrack>[]

Returns: WebRtcMediaStream<WebRtcMediaTrack>[]

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

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

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

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

getRtpSender

▸ PrivategetRtpSender(streamType: StreamType): RTCRtpSender

Parameters:

Name Type
streamType StreamType

Returns: RTCRtpSender

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

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

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

getStats

▸ getStats(): Future<ConnectionStats>

Returns: Future<ConnectionStats>

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getStream

▸ getStream(): WebRtcStream

Gets the first stream.

Returns: WebRtcStream

Inherited from: WebRtcConnectionBase

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

getStreamTransport

▸ PrivategetStreamTransport(connectionStats: ConnectionStats): TransportStats

Parameters:

Name Type
connectionStats ConnectionStats

Returns: TransportStats

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

getStreams

▸ getStreams(): WebRtcStream[]

Returns: WebRtcStream[]

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getTieBreaker

▸ getTieBreaker(): string

Gets the tie breaker.

Returns: string

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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

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

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

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

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

getVideoStream

▸ getVideoStream(): WebRtcVideoStream

Gets the first video stream.

Returns: WebRtcVideoStream

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getVideoStreams

▸ getVideoStreams(): WebRtcVideoStream[]

Returns: WebRtcVideoStream[]

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getWebRTCBundlePolicyString

▸ PrivategetWebRTCBundlePolicyString(): RTCBundlePolicy

Returns: RTCBundlePolicy

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

getWebRTCIceTransportPolicyString

▸ PrivategetWebRTCIceTransportPolicyString(): RTCIceTransportPolicy

Returns: RTCIceTransportPolicy

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

initialize

▸ Privateinitialize(): void

Returns: void

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

injectDiscoveredCandidatesIntoSdp

▸ PrivateinjectDiscoveredCandidatesIntoSdp(): void

Returns: void

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

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

onIceConnectionStateChange

▸ PrivateonIceConnectionStateChange(): void

Returns: void

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

printActiveCandidatePair

▸ PrivateprintActiveCandidatePair(attemptsLeft: number): void

Parameters:

Name Type
attemptsLeft number

Returns: void

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

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

processIceGatheringStateComplete

▸ PrivateprocessIceGatheringStateComplete(): void

Returns: void

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

processNextSetMaxSendBitrate

▸ PrivateprocessNextSetMaxSendBitrate(): void

Returns: void

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

processStateChange

▸ processStateChange(): void

Returns: void

Overrides: WebRtcConnectionBase

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

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

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

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

raiseRoundTripTime

▸ ProtectedraiseRoundTripTime(roundTripTime: number): void

Raises a round trip time.

Parameters:

Name Type
roundTripTime number

Returns: void

Inherited from: WebRtcConnectionBase

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

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

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

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

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

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

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

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

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

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

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

removeOnRoundTripTime

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

Removes a handler that is raised when a new round trip time is calculated.

Parameters:

Name Type
value IAction1<number>

Returns: void

Inherited from: WebRtcConnectionBase

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

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

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

removeSdesAttributesIfNeeded

▸ PrivateremoveSdesAttributesIfNeeded(remoteDescription: SessionDescription): void

Parameters:

Name Type
remoteDescription SessionDescription

Returns: void

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

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

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

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

sessionDescriptionTypeToEnum

▸ PrivatesessionDescriptionTypeToEnum(typeString: string): SessionDescriptionType

Parameters:

Name Type
typeString string

Returns: SessionDescriptionType

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

sessionDescriptionTypeToString

▸ PrivatesessionDescriptionTypeToString(typeEnum: SessionDescriptionType): string

Parameters:

Name Type
typeEnum SessionDescriptionType

Returns: string

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

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

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

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

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

setGatheringState

▸ ProtectedsetGatheringState(state: IceGatheringState): void

Parameters:

Name Type
state IceGatheringState

Returns: void

Overrides: WebRtcConnectionBase

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

setIceCandidateProcessingTimeout

▸ setIceCandidateProcessingTimeout(value: number): void

Parameters:

Name Type
value number

Returns: void

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

setIceConnectionState

▸ ProtectedsetIceConnectionState(state: IceConnectionState): void

Parameters:

Name Type
state IceConnectionState

Returns: void

Overrides: WebRtcConnectionBase

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

startConnectionTimeout

▸ PrivatestartConnectionTimeout(): void

Returns: void

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

syncStreamsWithRemoteDescription

▸ PrivatesyncStreamsWithRemoteDescription(remoteDescription: SessionDescription): void

Parameters:

Name Type
remoteDescription SessionDescription

Returns: void

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

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

updateLogContext

▸ updateLogContext(value: LogContext): void

Parameters:

Name Type
value LogContext

Returns: void

Implementation of: IInternalConnection

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

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

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

validateCandidate

▸ PrivatevalidateCandidate(candidate: Candidate): boolean

Parameters:

Name Type
candidate Candidate

Returns: boolean

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

webrtcCandidateFromCandidate

▸ PrivatewebrtcCandidateFromCandidate(candidate: Candidate): RTCIceCandidate

Parameters:

Name Type
candidate Candidate

Returns: RTCIceCandidate

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

webrtcSessionDescriptionFromSessionDescription

▸ PrivatewebrtcSessionDescriptionFromSessionDescription(sessionDescription: SessionDescription): WebRtcSessionDescription

Parameters:

Name Type
sessionDescription SessionDescription

Returns: WebRtcSessionDescription

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

webrtcSessionDescriptionToSessionDescription

▸ PrivatewebrtcSessionDescriptionToSessionDescription(webrtcSessionDescription: WebRtcSessionDescription): SessionDescription

Parameters:

Name Type
webrtcSessionDescription WebRtcSessionDescription

Returns: SessionDescription

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

streamTypeToMediaStreamTrackKind

▸ Private StaticstreamTypeToMediaStreamTrackKind(streamType: StreamType): string

Parameters:

Name Type
streamType StreamType

Returns: string

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