/ 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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:143

Properties

_dataStreamsReady

• Private _dataStreamsReady: boolean= false

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

_lastMediaComponentFrameStatsCollection

• Private _lastMediaComponentFrameStatsCollection: any

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

_mediaStreamsReady

• Private _mediaStreamsReady: boolean= false

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

_processingMaxSendBitrate

• Private _processingMaxSendBitrate: boolean= false

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

_remoteMediaTrackCount

• Private _remoteMediaTrackCount: number= 0

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

_setMaxSendBitrateQueue

• Private _setMaxSendBitrateQueue: any[]

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

dtmfSender

• Private dtmfSender: RTCDtmfSender= null

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

Methods

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:154

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:165

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:175

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:185

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:195

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:205

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:215

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:225

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:235

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:245

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:255

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:266

addStreamInternal

▸ PrivateaddStreamInternal(stream: WebRtcStream): void

Parameters:

Name Type
stream WebRtcStream

Returns: void

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

addStreamsInternal

▸ PrivateaddStreamsInternal(streams: WebRtcStream[]): void

Parameters:

Name Type
streams WebRtcStream[]

Returns: void

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

applyMediaFeedbackAttributes

▸ PrivateapplyMediaFeedbackAttributes(codecCap: RTCRtpCodecCapability, mediaFeedbackAttributeList: FeedbackAttribute[]): void

Parameters:

Name Type
codecCap RTCRtpCodecCapability
mediaFeedbackAttributeList FeedbackAttribute[]

Returns: void

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

applyMediaFormatParametersAttributes

▸ PrivateapplyMediaFormatParametersAttributes(codecCap: RTCRtpCodecCapability, mediaFormatParametersList: FormatParametersAttribute[]): void

Parameters:

Name Type
codecCap RTCRtpCodecCapability
mediaFormatParametersList FormatParametersAttribute[]

Returns: void

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

assignRemoteDescriptionInternal

▸ ProtectedassignRemoteDescriptionInternal(sessionDescription: SessionDescription): void

Parameters:

Name Type
sessionDescription SessionDescription

Returns: void

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

close

▸ close(): boolean

Returns: boolean

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

constraintMax

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

Parameters:

Name Type
num1 number
num2 number

Returns: number

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

constraintMin

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

Parameters:

Name Type
num1 number
num2 number

Returns: number

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

createAnswer

▸ createAnswer(): Future<SessionDescription>

Creates an answer.

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

createIceGatherer

▸ PrivatecreateIceGatherer(rtcServers: RTCIceServer[]): RTCIceGatherer

Parameters:

Name Type
rtcServers RTCIceServer[]

Returns: RTCIceGatherer

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

createOffer

▸ createOffer(): Future<SessionDescription>

Creates an offer.

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

doAddRemoteCandidate

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

Parameters:

Name Type
promise Promise<Candidate>
remoteCandidate Candidate

Returns: void

Overrides: WebRtcConnectionBase

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

doClose

▸ PrivatedoClose(): void

Returns: void

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

doCreate

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

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: void

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

doCreateAnswer

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

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: void

Overrides: WebRtcConnectionBase

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

doCreateOffer

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

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: boolean

Overrides: WebRtcConnectionBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:413

doSendCachedLocalCandidates

▸ ProtecteddoSendCachedLocalCandidates(): void

Returns: void

Overrides: WebRtcConnectionBase

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

doSetLocalDescription

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

Parameters:

Name Type
promise Promise<SessionDescription>
localDescription SessionDescription

Returns: void

Overrides: WebRtcConnectionBase

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

doSetMaxSendBitrate

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

Parameters:

Name Type
bitrate number
streamType StreamType
promise Promise<object>

Returns: void

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

doSetRemoteDescription

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

Parameters:

Name Type
promise Promise<SessionDescription>
remoteDescription SessionDescription

Returns: void

Overrides: WebRtcConnectionBase

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

getAudioStream

▸ getAudioStream(): WebRtcAudioStream

Gets the first audio stream.

Returns: WebRtcAudioStream

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getAudioStreams

▸ getAudioStreams(): WebRtcAudioStream[]

Returns: WebRtcAudioStream[]

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getBundlePolicy

▸ getBundlePolicy(): BundlePolicy

Gets the bundle policy.

Returns: BundlePolicy

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getCandidatePairStats

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

Parameters:

Name Type
candidatePairId string
report any

Returns: CandidatePairStats

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

getCandidateStats

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

Parameters:

Name Type
candidateId string
report any

Returns: CandidateStats

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

getCanonicalName

▸ getCanonicalName(): string

Gets the canonical name. Getting the value of Connection.CanonicalName is deprecated. Get the value of MediaStream.LocalCanonicalName instead.

Returns: string

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getCertificateStats

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

Parameters:

Name Type
certificateId string
report any

Returns: CertificateStats

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:532

getCodecStats

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

Parameters:

Name Type
codecId string
report any
sender boolean

Returns: CodecStats

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:542

getDataStream

▸ getDataStream(): WebRtcDataStream

Gets the first data stream.

Returns: WebRtcDataStream

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getDataStreams

▸ getDataStreams(): WebRtcDataStream[]

Returns: WebRtcDataStream[]

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:587

getDtmfSender

▸ getDtmfSender(): RTCDtmfSender

Returns: RTCDtmfSender

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

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: WebRtcConnectionBase

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

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: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:51

getError

▸ getError(): Error

Gets the error.

Returns: Error

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getExtRtpMapAttributesWithNoDuplicateUri

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

Parameters:

Name Type
newList ExtMapAttribute[]
sessionDescription SessionDescription

Returns: ExtMapAttribute[]

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

getExternalId

▸ getExternalId(): string

Gets the external identifier.

Returns: string

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:617

getGatheringState

▸ getGatheringState(): IceGatheringState

Returns: IceGatheringState

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getHasAudio

▸ getHasAudio(): boolean

Gets whether this connection has an audio stream.

Returns: boolean

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getHasData

▸ getHasData(): boolean

Gets whether this connection has a data stream.

Returns: boolean

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getHasVideo

▸ getHasVideo(): boolean

Gets whether this connection has a video stream.

Returns: boolean

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getIceCandidateProcessingTimeout

▸ getIceCandidateProcessingTimeout(): number

Returns: number

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

getIceConnectionState

▸ getIceConnectionState(): IceConnectionState

Returns: IceConnectionState

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getIceGatherPolicy

▸ getIceGatherPolicy(): IceGatherPolicy

Gets the ICE gather policy.

Returns: IceGatherPolicy

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getIceServer

▸ getIceServer(): IceServer

Gets the ICE server.

Returns: IceServer

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getIceServers

▸ getIceServers(): IceServer[]

Gets the ICE servers.

Returns: IceServer[]

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getId

▸ getId(): string

Gets the identifier.

Returns: string

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getInstance

▸ getInstance(): WebRtcConnection

Returns: WebRtcConnection

Overrides: WebRtcConnectionBase

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

getIsTerminated

▸ getIsTerminated(): boolean

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

Returns: boolean

Inherited from: WebRtcConnectionBase

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

getIsTerminating

▸ getIsTerminating(): boolean

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

Returns: boolean

Inherited from: WebRtcConnectionBase

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

getIsTerminatingOrTerminated

▸ getIsTerminatingOrTerminated(): boolean

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

Returns: boolean

Inherited from: WebRtcConnectionBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:739

getLocalDescription

▸ getLocalDescription(): SessionDescription

Returns: SessionDescription

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getMediaReceiverStats

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

Parameters:

Name Type
mediaReceiverId string
report any
_mediaStream WebRtcMediaStream<WebRtcMediaTrack>

Returns: MediaReceiverStats

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

getMediaSenderStats

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

Parameters:

Name Type
mediaSenderId string
report any
_mediaStream WebRtcMediaStream<WebRtcMediaTrack>

Returns: MediaSenderStats

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

getMediaStreams

▸ getMediaStreams(): WebRtcMediaStream<WebRtcMediaTrack>[]

Returns: WebRtcMediaStream<WebRtcMediaTrack>[]

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:785

getNativeDtlsTransports

▸ getNativeDtlsTransports(): RTCDtlsTransport[]

Returns: RTCDtlsTransport[]

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

getNativeIceGatherers

▸ getNativeIceGatherers(): RTCIceGatherer[]

Returns: RTCIceGatherer[]

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

getNativeIceTransports

▸ getNativeIceTransports(): RTCIceTransport[]

Returns: RTCIceTransport[]

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

getNativePeerConnection

▸ getNativePeerConnection(): RTCPeerConnection

Returns: RTCPeerConnection

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

getNativeRtpReceivers

▸ getNativeRtpReceivers(): RTCRtpReceiver[]

Returns: RTCRtpReceiver[]

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

getNativeRtpSenders

▸ getNativeRtpSenders(): RTCRtpSender[]

Returns: RTCRtpSender[]

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

getRemoteDescription

▸ getRemoteDescription(): SessionDescription

Returns: SessionDescription

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getRemoteMedia

▸ getRemoteMedia(): WebRtcRemoteMedia

Returns: WebRtcRemoteMedia

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

getRtpSender

▸ PrivategetRtpSender(mediaStreamIndex: number): RTCRtpSender

Parameters:

Name Type
mediaStreamIndex number

Returns: RTCRtpSender

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

getSignallingState

▸ getSignallingState(): SignallingState

Gets the state of the signalling.

Returns: SignallingState

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getState

▸ getState(): ConnectionState

Gets the state of the connection.

Returns: ConnectionState

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getStats

▸ getStats(): Future<ConnectionStats>

Returns: Future<ConnectionStats>

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getStream

▸ getStream(): WebRtcStream

Gets the first stream.

Returns: WebRtcStream

Inherited from: WebRtcConnectionBase

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

getStreams

▸ getStreams(): WebRtcStream[]

Returns: WebRtcStream[]

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getTieBreaker

▸ getTieBreaker(): string

Gets the tie breaker.

Returns: string

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:811

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:541

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:821

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: WebRtcConnectionBase

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

getVideoStream

▸ getVideoStream(): WebRtcVideoStream

Gets the first video stream.

Returns: WebRtcVideoStream

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

getVideoStreams

▸ getVideoStreams(): WebRtcVideoStream[]

Returns: WebRtcVideoStream[]

Implementation of: IInternalConnection

Overrides: WebRtcConnectionBase

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

getWebRTCBundlePolicyString

▸ PrivategetWebRTCBundlePolicyString(): RTCBundlePolicy

Returns: RTCBundlePolicy

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

initialize

▸ Privateinitialize(): void

Returns: void

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

initializeTrack

▸ PrivateinitializeTrack(element: OrtcMediaElement, rtcServers: RTCIceServer[]): MediaStreamTrack

Parameters:

Name Type
element OrtcMediaElement
rtcServers RTCIceServer[]

Returns: MediaStreamTrack

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

injectDiscoveredCandidatesIntoSdp

▸ PrivateinjectDiscoveredCandidatesIntoSdp(): void

Returns: void

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

modifyExtRtpMapId

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

Parameters:

Name Type
newId number
oldId number
sdpMessage Message

Returns: void

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

ortcCandidateFromCandidate

▸ PrivateortcCandidateFromCandidate(candidate: Candidate): OrtcCandidate

Parameters:

Name Type
candidate Candidate

Returns: OrtcCandidate

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

ortcCandidateToCandidate

▸ PrivateortcCandidateToCandidate(ortcCandidate: OrtcCandidate): Candidate

Parameters:

Name Type
ortcCandidate OrtcCandidate

Returns: Candidate

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

ortcSessionDescriptionFromSessionDescription

▸ PrivateortcSessionDescriptionFromSessionDescription(sessionDescription: SessionDescription): OrtcSessionDescription

Parameters:

Name Type
sessionDescription SessionDescription

Returns: OrtcSessionDescription

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

ortcSessionDescriptionToSessionDescription

▸ PrivateortcSessionDescriptionToSessionDescription(ortcSessionDescription: OrtcSessionDescription): SessionDescription

Parameters:

Name Type
ortcSessionDescription OrtcSessionDescription

Returns: SessionDescription

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:869

processIceGatheringStateComplete

▸ PrivateprocessIceGatheringStateComplete(): void

Returns: void

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

processNextSetMaxSendBitrate

▸ PrivateprocessNextSetMaxSendBitrate(): void

Returns: void

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

processRemoteDescriptionOnRenegotiation

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

Parameters:

Name Type
promise Promise<SessionDescription>
remoteDescription SessionDescription

Returns: void

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

processStateChange

▸ processStateChange(): void

Returns: void

Overrides: WebRtcConnectionBase

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

raiseGatheringStateChange

▸ ProtectedraiseGatheringStateChange(connection: WebRtcConnection): void

Raises gathering state change.

Parameters:

Name Type
connection WebRtcConnection

Returns: void

Inherited from: WebRtcConnectionBase

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

raiseIceConnectionStateChange

▸ ProtectedraiseIceConnectionStateChange(connection: WebRtcConnection): void

Raises ICE connection state change.

Parameters:

Name Type
connection WebRtcConnection

Returns: void

Inherited from: WebRtcConnectionBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:979

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2000

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1139

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1150

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1160

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1170

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1180

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1190

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1200

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1210

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1220

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1230

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1240

removeSdesAttributesIfNeeded

▸ PrivateremoveSdesAttributesIfNeeded(remoteDescription: SessionDescription): void

Parameters:

Name Type
remoteDescription SessionDescription

Returns: void

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

reorderExtRtpMapIdsOnRenegotiationOffer

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

Parameters:

Name Type
newOffer SessionDescription
lastLocalDescription SessionDescription
lastRemoteDescription SessionDescription

Returns: void

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

replaceLocalTrack

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

Parameters:

Name Type
localTrack WebRtcMediaTrack
mediaStream WebRtcMediaStream<WebRtcMediaTrack>

Returns: Future<object>

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

replaceRemoteTrack

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

Parameters:

Name Type
remoteTrack WebRtcMediaTrack
mediaStream WebRtcMediaStream<WebRtcMediaTrack>

Returns: Future<object>

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

rtcCandidateFromSdpCandidateAttribute

▸ PrivatertcCandidateFromSdpCandidateAttribute(sdpCandidateAttribute: CandidateAttribute): RTCIceCandidateDictionary

Parameters:

Name Type
sdpCandidateAttribute CandidateAttribute

Returns: RTCIceCandidateDictionary

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

rtcCandidateToSdpCandidateAttribute

▸ PrivatertcCandidateToSdpCandidateAttribute(rtcCandidate: RTCIceCandidateDictionary): CandidateAttribute

Parameters:

Name Type
rtcCandidate RTCIceCandidateDictionary

Returns: CandidateAttribute

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

selectCodecs

▸ PrivateselectCodecs(mediaIndex: number): RTCRtpCodecParameters[]

Parameters:

Name Type
mediaIndex number

Returns: RTCRtpCodecParameters[]

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

selectEncodings

▸ PrivateselectEncodings(mediaIndex: number, send: boolean): RTCRtpEncodingParameters[]

Parameters:

Name Type
mediaIndex number
send boolean

Returns: RTCRtpEncodingParameters[]

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

selectRtcp

▸ PrivateselectRtcp(mediaIndex: number, send: boolean): any

Parameters:

Name Type
mediaIndex number
send boolean

Returns: any

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

sessionDescriptionTypeToEnum

▸ PrivatesessionDescriptionTypeToEnum(typeString: string): SessionDescriptionType

Parameters:

Name Type
typeString string

Returns: SessionDescriptionType

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

sessionDescriptionTypeToString

▸ PrivatesessionDescriptionTypeToString(typeEnum: SessionDescriptionType): string

Parameters:

Name Type
typeEnum SessionDescriptionType

Returns: string

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

setBundlePolicy

▸ setBundlePolicy(value: BundlePolicy): void

Sets the bundle policy.

Parameters:

Name Type
value BundlePolicy

Returns: void

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1285

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: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:86

setError

▸ setError(value: Error): void

Sets the error.

Parameters:

Name Type
value Error

Returns: void

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

setExternalId

▸ setExternalId(value: string): void

Sets the external identifier.

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

setGatheringState

▸ ProtectedsetGatheringState(state: IceGatheringState): void

Parameters:

Name Type
state IceGatheringState

Returns: void

Overrides: WebRtcConnectionBase

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

setIceCandidateProcessingTimeout

▸ setIceCandidateProcessingTimeout(value: number): void

Parameters:

Name Type
value number

Returns: void

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

setIceConnectionState

▸ ProtectedsetIceConnectionState(state: IceConnectionState): void

Parameters:

Name Type
state IceConnectionState

Returns: void

Overrides: WebRtcConnectionBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1336

setIceServer

▸ setIceServer(value: IceServer): void

Sets the ICE server.

Parameters:

Name Type
value IceServer

Returns: void

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

setIceServers

▸ setIceServers(value: IceServer[]): void

Sets the ICE servers.

Parameters:

Name Type
value IceServer[]

Returns: void

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1366

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1377

setMaxSendBitrate

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

Parameters:

Name Type
bitrate number
streamType StreamType

Returns: Future<object>

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

setNativeDescriptionSuccess

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

Parameters:

Name Type
sessionDescription SessionDescription
promise Promise<SessionDescription>

Returns: void

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

setRemoteCandidatesDoneTimer

▸ PrivatesetRemoteCandidatesDoneTimer(): void

Returns: void

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1431

setSignallingState

▸ ProtectedsetSignallingState(value: SignallingState): void

Sets the state of the signalling.

Parameters:

Name Type
value SignallingState

Returns: void

Inherited from: WebRtcConnectionBase

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

setTieBreaker

▸ setTieBreaker(value: string): void

Sets the tie breaker.

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalConnection

Inherited from: WebRtcConnectionBase

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

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1580

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1591

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1303

startConnectionTimeout

▸ PrivatestartConnectionTimeout(): void

Returns: void

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

startOrtc

▸ PrivatestartOrtc(): void

Returns: void

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

startOrtcTrack

▸ PrivatestartOrtcTrack(iceGatherer: RTCIceGatherer, iceTransport: RTCIceTransport, dtlsTransport: RTCDtlsTransport, localMediaDescription: OrtcMediaDescription, remoteMediaDescription: OrtcMediaDescription): void

Parameters:

Name Type
iceGatherer RTCIceGatherer
iceTransport RTCIceTransport
dtlsTransport RTCDtlsTransport
localMediaDescription OrtcMediaDescription
remoteMediaDescription OrtcMediaDescription

Returns: void

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

tryGetRtpSender

▸ PrivatetryGetRtpSender(mediaStreamIndex: number): RTCRtpSender

Parameters:

Name Type
mediaStreamIndex number

Returns: RTCRtpSender

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

unsetDynamicValue

▸ unsetDynamicValue(key: string): boolean

Unsets 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.

Returns: boolean

true if the value was removed; otherwise, false.

Inherited from: WebRtcConnectionBase

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

updateLocalDescription

▸ PrivateupdateLocalDescription(localDescription: SessionDescription): SessionDescription

Parameters:

Name Type
localDescription SessionDescription

Returns: SessionDescription

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

updateMaxBitrateSdpMediaDescription

▸ PrivateupdateMaxBitrateSdpMediaDescription(bitrate: number, sdpMediaDescription: MediaDescription): void

Parameters:

Name Type
bitrate number
sdpMediaDescription MediaDescription

Returns: void

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

updateMaxBitrateSdpMessage

▸ PrivateupdateMaxBitrateSdpMessage(bitrate: number, streamType: StreamType, sdpMessage: Message): boolean

Parameters:

Name Type
bitrate number
streamType StreamType
sdpMessage Message

Returns: boolean

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

validateCandidate

▸ PrivatevalidateCandidate(candidate: Candidate): boolean

Parameters:

Name Type
candidate Candidate

Returns: boolean

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

webrtcCandidateFromCandidate

▸ PrivatewebrtcCandidateFromCandidate(candidate: Candidate): RTCIceCandidate

Parameters:

Name Type
candidate Candidate

Returns: RTCIceCandidate

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

webrtcCandidateToCandidate

▸ PrivatewebrtcCandidateToCandidate(webrtcCandidate: RTCIceCandidate): Candidate

Parameters:

Name Type
webrtcCandidate RTCIceCandidate

Returns: Candidate

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

webrtcSessionDescriptionFromSessionDescription

▸ PrivatewebrtcSessionDescriptionFromSessionDescription(sessionDescription: SessionDescription): WebRtcSessionDescription

Parameters:

Name Type
sessionDescription SessionDescription

Returns: WebRtcSessionDescription

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

webrtcSessionDescriptionToSessionDescription

▸ PrivatewebrtcSessionDescriptionToSessionDescription(webrtcSessionDescription: WebRtcSessionDescription): SessionDescription

Parameters:

Name Type
webrtcSessionDescription WebRtcSessionDescription

Returns: SessionDescription

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