/ fm / liveswitch / WebRtcConnection
Class: WebRtcConnection
fm.liveswitch.WebRtcConnection
Hierarchy
WebRtcConnectionBase<WebRtcConnection, WebRtcStream, WebRtcAudioStream, WebRtcVideoStream, WebRtcDataStream, WebRtcDataChannel>
↳ WebRtcConnection
Implements
Table of contents
Constructors
Properties
- _dataStreamsReady
- _lastMediaComponentFrameStatsCollection
- _mediaStreamsReady
- _processingMaxSendBitrate
- _remoteMediaTrackCount
- _setMaxSendBitrateQueue
- dtmfSender
Methods
- addIceServer
- addIceServers
- addOnExternalIdChange
- addOnGatheringStateChange
- addOnIceConnectionStateChange
- addOnLocalCandidate
- addOnLocalDescription
- addOnRemoteCandidate
- addOnRemoteDescription
- addOnSignallingStateChange
- addOnStateChange
- addRemoteCandidate
- addStreamInternal
- addStreamsInternal
- applyMediaFeedbackAttributes
- applyMediaFormatParametersAttributes
- assignRemoteDescriptionInternal
- close
- constraintMax
- constraintMin
- createAnswer
- createIceGatherer
- createOffer
- doAddRemoteCandidate
- doClose
- doCreate
- doCreateAnswer
- doCreateOffer
- doProcessDescription
- doSendCachedLocalCandidates
- doSetLocalDescription
- doSetMaxSendBitrate
- doSetRemoteDescription
- finalizeBitrateChange
- getAudioStream
- getAudioStreams
- getBundlePolicy
- getCandidatePairStats
- getCandidateStats
- getCanonicalName
- getCertificateStats
- getChromeVersion
- getClosed
- getCodecStats
- getConnected
- getDataStream
- getDataStreams
- getDeadStreamTimeout
- getDtmfSender
- getDynamicProperties
- getDynamicValue
- getError
- getExtRtpMapAttributesWithNoDuplicateUri
- getExternalId
- getFailed
- getGatheringState
- getHasAudio
- getHasData
- getHasVideo
- getIceCandidateProcessingTimeout
- getIceConnectionState
- getIceGatherPolicy
- getIceServer
- getIceServers
- getId
- getInstance
- getIsTerminated
- getIsTerminating
- getIsTerminatingOrTerminated
- getLegacyTimeout
- getLocalDescription
- getMediaReceiverStats
- getMediaSenderStats
- getMediaStreams
- getMediaTrackStats
- getNativeDtlsTransports
- getNativeIceGatherers
- getNativeIceTransports
- getNativePeerConnection
- getNativeRtpReceivers
- getNativeRtpSenders
- getRemoteDescription
- getRemoteMedia
- getRtpSender
- getSignallingState
- getState
- getStats
- getStream
- getStreams
- getTieBreaker
- getTimeout
- getTransportStats
- getTrickleIcePolicy
- getTypeString
- getVideoStream
- getVideoStreams
- getWebRTCBundlePolicyString
- initialize
- initializeTrack
- injectDiscoveredCandidatesIntoSdp
- modifyExtRtpMapId
- onIceConnectionStateChange
- ortcCandidateFromCandidate
- ortcCandidateToCandidate
- ortcSessionDescriptionFromSessionDescription
- ortcSessionDescriptionToSessionDescription
- processDescription
- processIceGatheringStateComplete
- processNextSetMaxSendBitrate
- processRemoteDescriptionOnRenegotiation
- processStateChange
- raiseGatheringStateChange
- raiseIceConnectionStateChange
- raiseLocalCandidate
- reallocateRtpExtMapId
- removeIceServer
- removeIceServers
- removeOnExternalIdChange
- removeOnGatheringStateChange
- removeOnIceConnectionStateChange
- removeOnLocalCandidate
- removeOnLocalDescription
- removeOnRemoteCandidate
- removeOnRemoteDescription
- removeOnSignallingStateChange
- removeOnStateChange
- removeSdesAttributesIfNeeded
- reorderExtRtpMapIdsOnRenegotiationOffer
- replaceLocalTrack
- replaceRemoteTrack
- rtcCandidateFromSdpCandidateAttribute
- rtcCandidateToSdpCandidateAttribute
- selectCodecs
- selectEncodings
- selectRtcp
- sessionDescriptionTypeToEnum
- sessionDescriptionTypeToString
- setBundlePolicy
- setDeadStreamTimeout
- setDynamicValue
- setError
- setExternalId
- setGatheringState
- setIceCandidateProcessingTimeout
- setIceConnectionState
- setIceGatherPolicy
- setIceServer
- setIceServers
- setLegacyTimeout
- setLocalDescription
- setMaxSendBitrate
- setNativeDescriptionSuccess
- setRemoteCandidatesDoneTimer
- setRemoteDescription
- setSignallingState
- setTieBreaker
- setTimeout
- setTrickleIcePolicy
- setupTransceivers
- startConnectionTimeout
- startOrtc
- startOrtcTrack
- syncStreamsWithRemoteDescription
- tryGetRtpSender
- unsetDynamicValue
- updateLocalDescription
- updateMaxBitrateRemoteSdpMessage
- validateCandidate
- webrtcCandidateFromCandidate
- webrtcCandidateToCandidate
- webrtcSessionDescriptionFromSessionDescription
- webrtcSessionDescriptionToSessionDescription
Constructors
constructor
+ new WebRtcConnection(external
: IExternalConnection, streams
: WebRtcStream[], remoteMedia
: WebRtcRemoteMedia): WebRtcConnection
Parameters:
Name | Type |
---|---|
external |
IExternalConnection |
streams |
WebRtcStream[] |
remoteMedia |
WebRtcRemoteMedia |
Returns: WebRtcConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:143
Properties
_dataStreamsReady
• Private
_dataStreamsReady: boolean= false
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:99
_lastMediaComponentFrameStatsCollection
• Private
_lastMediaComponentFrameStatsCollection: any
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:801
_mediaStreamsReady
• Private
_mediaStreamsReady: boolean= false
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:100
_processingMaxSendBitrate
• Private
_processingMaxSendBitrate: boolean= false
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3362
_remoteMediaTrackCount
• Private
_remoteMediaTrackCount: number= 0
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:98
_setMaxSendBitrateQueue
• Private
_setMaxSendBitrateQueue: any[]
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3361
dtmfSender
• Private
dtmfSender: RTCDTMFSender= null
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3214
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: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:160
addIceServers
▸ addIceServers(iceServers
: IceServer[]): void
Adds some ICE servers.
Parameters:
Name | Type | Description |
---|---|---|
iceServers |
IceServer[] | The ICE servers. |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:173
addOnExternalIdChange
▸ addOnExternalIdChange(value
: IAction2<string, string>): void
Adds a handler that is raised when external Id of this connection changes. Old external Id as well as internal Id are raised.
Parameters:
Name | Type |
---|---|
value |
IAction2<string, string> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:185
addOnGatheringStateChange
▸ addOnGatheringStateChange(value
: IAction1<WebRtcConnection>): void
Adds a handler that is raised when the gathering state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<WebRtcConnection> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:197
addOnIceConnectionStateChange
▸ addOnIceConnectionStateChange(value
: IAction1<WebRtcConnection>): void
Adds a handler that is raised when the ice connection state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<WebRtcConnection> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:209
addOnLocalCandidate
▸ addOnLocalCandidate(value
: IAction2<WebRtcConnection, Candidate>): void
Adds a handler that is raised when a local candidate is added.
Parameters:
Name | Type |
---|---|
value |
IAction2<WebRtcConnection, Candidate> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:221
addOnLocalDescription
▸ addOnLocalDescription(value
: IAction2<WebRtcConnection, SessionDescription>): void
Adds a handler that is raised when a local description is set.
Parameters:
Name | Type |
---|---|
value |
IAction2<WebRtcConnection, SessionDescription> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:233
addOnRemoteCandidate
▸ addOnRemoteCandidate(value
: IAction2<WebRtcConnection, Candidate>): void
Adds a handler that is raised when a remote description is added.
Parameters:
Name | Type |
---|---|
value |
IAction2<WebRtcConnection, Candidate> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:245
addOnRemoteDescription
▸ addOnRemoteDescription(value
: IAction2<WebRtcConnection, SessionDescription>): void
Adds a handler that is raised when a remote description is set.
Parameters:
Name | Type |
---|---|
value |
IAction2<WebRtcConnection, SessionDescription> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:257
addOnSignallingStateChange
▸ addOnSignallingStateChange(value
: IAction1<WebRtcConnection>): void
Adds a handler that is raised when the signalling state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<WebRtcConnection> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:269
addOnStateChange
▸ addOnStateChange(value
: IAction1<WebRtcConnection>): void
Adds a handler that is raised when the connection state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<WebRtcConnection> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:281
addRemoteCandidate
▸ addRemoteCandidate(remoteCandidate
: Candidate): Future<Candidate>
Adds the remote candidate.
Parameters:
Name | Type | Description |
---|---|---|
remoteCandidate |
Candidate | The remote candidate. |
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:294
addStreamInternal
▸ Private
addStreamInternal(stream
: WebRtcStream): void
Parameters:
Name | Type |
---|---|
stream |
WebRtcStream |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:178
addStreamsInternal
▸ Private
addStreamsInternal(streams
: WebRtcStream[]): void
Parameters:
Name | Type |
---|---|
streams |
WebRtcStream[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:196
applyMediaFeedbackAttributes
▸ Private
applyMediaFeedbackAttributes(codecCap
: RTCRtpCodecCapability, mediaFeedbackAttributeList
: FeedbackAttribute[]): void
Parameters:
Name | Type |
---|---|
codecCap |
RTCRtpCodecCapability |
mediaFeedbackAttributeList |
FeedbackAttribute[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1875
applyMediaFormatParametersAttributes
▸ Private
applyMediaFormatParametersAttributes(codecCap
: RTCRtpCodecCapability, mediaFormatParametersList
: FormatParametersAttribute[]): void
Parameters:
Name | Type |
---|---|
codecCap |
RTCRtpCodecCapability |
mediaFormatParametersList |
FormatParametersAttribute[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1864
assignRemoteDescriptionInternal
▸ Protected
assignRemoteDescriptionInternal(sessionDescription
: SessionDescription): void
Parameters:
Name | Type |
---|---|
sessionDescription |
SessionDescription |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3160
close
▸ close(): boolean
Returns: boolean
Implementation of: IInternalConnection
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3163
constraintMax
▸ Private
constraintMax(num1
: number, num2
: number): number
Parameters:
Name | Type |
---|---|
num1 |
number |
num2 |
number |
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:247
constraintMin
▸ Private
constraintMin(num1
: number, num2
: number): number
Parameters:
Name | Type |
---|---|
num1 |
number |
num2 |
number |
Returns: number
Defined in: 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: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:351
createIceGatherer
▸ Private
createIceGatherer(rtcServers
: RTCIceServer[]): RTCIceGatherer
Parameters:
Name | Type |
---|---|
rtcServers |
RTCIceServer[] |
Returns: RTCIceGatherer
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1460
createOffer
▸ createOffer(): Future<SessionDescription>
Creates an offer.
Returns: Future<SessionDescription>
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:392
doAddRemoteCandidate
▸ Protected
doAddRemoteCandidate(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:3099
doClose
▸ Private
doClose(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3171
doCreate
▸ Private
doCreate(promise
: Promise<SessionDescription>): void
Parameters:
Name | Type |
---|---|
promise |
Promise<SessionDescription> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2121
doCreateAnswer
▸ Protected
doCreateAnswer(promise
: Promise<SessionDescription>): void
Parameters:
Name | Type |
---|---|
promise |
Promise<SessionDescription> |
Returns: void
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1907
doCreateOffer
▸ Protected
doCreateOffer(promise
: Promise<SessionDescription>): boolean
Parameters:
Name | Type |
---|---|
promise |
Promise<SessionDescription> |
Returns: boolean
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1902
doProcessDescription
▸ Protected
doProcessDescription(description
: SessionDescription, isLocalDescription
: boolean): Error
Processes a session description.
Parameters:
Name | Type | Description |
---|---|---|
description |
SessionDescription | The session description. |
isLocalDescription |
boolean | Whether this is a local session description. |
Returns: Error
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:455
doSendCachedLocalCandidates
▸ Protected
doSendCachedLocalCandidates(): void
Returns: void
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2947
doSetLocalDescription
▸ Protected
doSetLocalDescription(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:2597
doSetMaxSendBitrate
▸ Private
doSetMaxSendBitrate(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:3388
doSetRemoteDescription
▸ Protected
doSetRemoteDescription(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:2768
finalizeBitrateChange
▸ Private
finalizeBitrateChange(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3383
getAudioStream
▸ getAudioStream(): WebRtcAudioStream
Gets the first audio stream.
Returns: WebRtcAudioStream
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:543
getAudioStreams
▸ getAudioStreams(): WebRtcAudioStream[]
Returns: WebRtcAudioStream[]
Implementation of: IInternalConnection
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:227
getBundlePolicy
▸ getBundlePolicy(): BundlePolicy
Gets the bundle policy.
Returns: BundlePolicy
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:565
getCandidatePairStats
▸ Private
getCandidatePairStats(candidatePairId
: string, report
: any): CandidatePairStats
Parameters:
Name | Type |
---|---|
candidatePairId |
string |
report |
any |
Returns: CandidatePairStats
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:697
getCandidateStats
▸ Private
getCandidateStats(candidateId
: string, report
: any): CandidateStats
Parameters:
Name | Type |
---|---|
candidateId |
string |
report |
any |
Returns: CandidateStats
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:650
getCanonicalName
▸ getCanonicalName(): string
Gets the canonical name.
deprecated
Use MediaStream.LocalCanonicalName instead.
Returns: string
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:578
getCertificateStats
▸ Private
getCertificateStats(certificateId
: string, report
: any): CertificateStats
Parameters:
Name | Type |
---|---|
certificateId |
string |
report |
any |
Returns: CertificateStats
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:631
getChromeVersion
▸ Private
getChromeVersion(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:553
getClosed
▸ getClosed(): Future<Object>
Gets a future that resolves if the connection enters the Closed state or rejects if the connection enters the Failed state before that happens.
Returns: Future<Object>
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:591
getCodecStats
▸ Private
getCodecStats(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:743
getConnected
▸ getConnected(): Future<Object>
Gets a future that resolves if the connection enters the Connected state or rejects if the connection enters the Failed state before that happens.
Returns: Future<Object>
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:604
getDataStream
▸ getDataStream(): WebRtcDataStream
Gets the first data stream.
Returns: WebRtcDataStream
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:633
getDataStreams
▸ getDataStreams(): WebRtcDataStream[]
Returns: WebRtcDataStream[]
Implementation of: IInternalConnection
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts: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: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:658
getDtmfSender
▸ getDtmfSender(): RTCDTMFSender
Returns: RTCDTMFSender
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3215
getDynamicProperties
▸ getDynamicProperties(): Hash<string, Object>
Gets all dynamic properties on this instance.
Returns: Hash<string, Object>
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:37
getDynamicValue
▸ getDynamicValue(key
: string): Object
Gets a property value from the local cache.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions. |
Returns: Object
The stored value, if found; otherwise null.
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:58
getError
▸ getError(): Error
Gets the error.
Returns: Error
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:670
getExtRtpMapAttributesWithNoDuplicateUri
▸ Private
getExtRtpMapAttributesWithNoDuplicateUri(newList
: ExtMapAttribute[], sessionDescription
: SessionDescription): ExtMapAttribute[]
Parameters:
Name | Type |
---|---|
newList |
ExtMapAttribute[] |
sessionDescription |
SessionDescription |
Returns: ExtMapAttribute[]
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2010
getExternalId
▸ getExternalId(): string
Gets the external identifier.
Returns: string
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:682
getFailed
▸ getFailed(): Future<Object>
Gets a future that resolves if the connection enters the Failed state or rejects if the connection enters the Closed state before that happens.
Returns: Future<Object>
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:695
getGatheringState
▸ getGatheringState(): IceGatheringState
Returns: IceGatheringState
Implementation of: IInternalConnection
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2415
getHasAudio
▸ getHasAudio(): boolean
Gets whether this connection has an audio stream.
Returns: boolean
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:713
getHasData
▸ getHasData(): boolean
Gets whether this connection has a data stream.
Returns: boolean
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:725
getHasVideo
▸ getHasVideo(): boolean
Gets whether this connection has a video stream.
Returns: boolean
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:737
getIceCandidateProcessingTimeout
▸ getIceCandidateProcessingTimeout(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1889
getIceConnectionState
▸ getIceConnectionState(): IceConnectionState
Returns: IceConnectionState
Implementation of: IInternalConnection
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2418
getIceGatherPolicy
▸ getIceGatherPolicy(): IceGatherPolicy
Gets the ICE gather policy.
Returns: IceGatherPolicy
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:755
getIceServer
▸ getIceServer(): IceServer
Gets the ICE server.
Returns: IceServer
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:767
getIceServers
▸ getIceServers(): IceServer[]
Gets the ICE servers.
Returns: IceServer[]
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:779
getId
▸ getId(): string
Gets the identifier.
Returns: string
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:791
getInstance
▸ getInstance(): WebRtcConnection
Returns: WebRtcConnection
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:174
getIsTerminated
▸ getIsTerminated(): boolean
Gets a value indicating whether the connection is currently closed or failed.
Returns: boolean
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:809
getIsTerminating
▸ getIsTerminating(): boolean
Gets a value indicating whether the connection is currently closing or failing.
Returns: boolean
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:821
getIsTerminatingOrTerminated
▸ getIsTerminatingOrTerminated(): boolean
Gets a value indicating whether the connection is currently closing, failing, closed, or failed.
Returns: boolean
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:833
getLegacyTimeout
▸ getLegacyTimeout(): boolean
Gets a value indicating whether legacy Connection.Timeout should be used. When disabled, Connection.Timeout only accounts for the time spent trying to establish connectivity (i.e. time it takes to transition from the Connecting to the Connected state; from the time point when both offer and answer had been set to the connection being fully established). When enabled, Connection.Timeout accounts for the time spent from receiving an offer (or creating an offer) to establishing connectivity (i.e. time it takes to transition from Initializing to Connected state). By default, LegacyTimeout is set to true, so that existing behavior is preserved. However, in the future default will be updated to false. This means that IL will not account for any signalling delays that may occur while establishing connectivity. This option will be later deprecated.
Returns: boolean
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:855
getLocalDescription
▸ getLocalDescription(): SessionDescription
Returns: SessionDescription
Implementation of: IInternalConnection
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2412
getMediaReceiverStats
▸ Private
getMediaReceiverStats(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:510
getMediaSenderStats
▸ Private
getMediaSenderStats(mediaSenderId
: string, report
: any, _mediaStream
: WebRtcMediaStream<WebRtcMediaTrack>): MediaSenderStats
Parameters:
Name | Type |
---|---|
mediaSenderId |
string |
report |
any |
_mediaStream |
WebRtcMediaStream<WebRtcMediaTrack> |
Returns: MediaSenderStats
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:483
getMediaStreams
▸ getMediaStreams(): WebRtcMediaStream<WebRtcMediaTrack>[]
Returns: WebRtcMediaStream<WebRtcMediaTrack>[]
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:224
getMediaTrackStats
▸ Private
getMediaTrackStats(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:802
getNativeDtlsTransports
▸ getNativeDtlsTransports(): RTCDtlsTransport[]
Returns: RTCDtlsTransport[]
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:115
getNativeIceGatherers
▸ getNativeIceGatherers(): any[]
Returns: any[]
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:105
getNativeIceTransports
▸ getNativeIceTransports(): RTCIceTransport[]
Returns: RTCIceTransport[]
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:110
getNativePeerConnection
▸ getNativePeerConnection(): RTCPeerConnection
Returns: RTCPeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:93
getNativeRtpReceivers
▸ getNativeRtpReceivers(): RTCRtpReceiver[]
Returns: RTCRtpReceiver[]
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:125
getNativeRtpSenders
▸ getNativeRtpSenders(): RTCRtpSender[]
Returns: RTCRtpSender[]
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:120
getRemoteDescription
▸ getRemoteDescription(): SessionDescription
Returns: SessionDescription
Implementation of: IInternalConnection
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2436
getRemoteMedia
▸ getRemoteMedia(): WebRtcRemoteMedia
Returns: WebRtcRemoteMedia
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:86
getRtpSender
▸ Private
getRtpSender(mediaStreamIndex
: number): RTCRtpSender
Parameters:
Name | Type |
---|---|
mediaStreamIndex |
number |
Returns: RTCRtpSender
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3313
getSignallingState
▸ getSignallingState(): SignallingState
Gets the state of the signalling.
Returns: SignallingState
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:881
getState
▸ getState(): ConnectionState
Gets the state of the connection.
Returns: ConnectionState
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:893
getStats
▸ getStats(): Future<ConnectionStats>
Returns: Future<ConnectionStats>
Implementation of: IInternalConnection
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:257
getStream
▸ getStream(): WebRtcStream
Gets the first stream.
Returns: WebRtcStream
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:911
getStreams
▸ getStreams(): WebRtcStream[]
Returns: WebRtcStream[]
Implementation of: IInternalConnection
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:221
getTieBreaker
▸ getTieBreaker(): string
Gets the tie breaker.
Returns: string
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:933
getTimeout
▸ getTimeout(): number
Gets the amount of time (in milliseconds) to wait for a connection to establish before giving up and closing it. Defaults to 30,000.
Returns: number
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:947
getTransportStats
▸ Private
getTransportStats(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:558
getTrickleIcePolicy
▸ getTrickleIcePolicy(): TrickleIcePolicy
Gets Trickle Ice Support Policy. Cf. https://tools.ietf.org/html/draft-ietf-ice-trickle-05
Returns: TrickleIcePolicy
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:959
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:38
getVideoStream
▸ getVideoStream(): WebRtcVideoStream
Gets the first video stream.
Returns: WebRtcVideoStream
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:979
getVideoStreams
▸ getVideoStreams(): WebRtcVideoStream[]
Returns: WebRtcVideoStream[]
Implementation of: IInternalConnection
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:230
getWebRTCBundlePolicyString
▸ Private
getWebRTCBundlePolicyString(): RTCBundlePolicy
Returns: RTCBundlePolicy
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:778
initialize
▸ Private
initialize(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:940
initializeTrack
▸ Private
initializeTrack(element
: OrtcMediaElement, rtcServers
: RTCIceServer[]): MediaStreamTrack
Parameters:
Name | Type |
---|---|
element |
OrtcMediaElement |
rtcServers |
RTCIceServer[] |
Returns: MediaStreamTrack
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1402
injectDiscoveredCandidatesIntoSdp
▸ Private
injectDiscoveredCandidatesIntoSdp(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1919
modifyExtRtpMapId
▸ Private
modifyExtRtpMapId(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:2000
onIceConnectionStateChange
▸ Private
onIceConnectionStateChange(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1323
ortcCandidateFromCandidate
▸ Private
ortcCandidateFromCandidate(candidate
: Candidate): OrtcCandidate
Parameters:
Name | Type |
---|---|
candidate |
Candidate |
Returns: OrtcCandidate
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1615
ortcCandidateToCandidate
▸ Private
ortcCandidateToCandidate(ortcCandidate
: OrtcCandidate): Candidate
Parameters:
Name | Type |
---|---|
ortcCandidate |
OrtcCandidate |
Returns: Candidate
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1608
ortcSessionDescriptionFromSessionDescription
▸ Private
ortcSessionDescriptionFromSessionDescription(sessionDescription
: SessionDescription): OrtcSessionDescription
Parameters:
Name | Type |
---|---|
sessionDescription |
SessionDescription |
Returns: OrtcSessionDescription
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1707
ortcSessionDescriptionToSessionDescription
▸ Private
ortcSessionDescriptionToSessionDescription(ortcSessionDescription
: OrtcSessionDescription): SessionDescription
Parameters:
Name | Type |
---|---|
ortcSessionDescription |
OrtcSessionDescription |
Returns: SessionDescription
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1622
processDescription
▸ Protected
processDescription(description
: SessionDescription, isLocalDescription
: boolean): Error
Processes a session description.
Parameters:
Name | Type | Description |
---|---|---|
description |
SessionDescription | The session description. |
isLocalDescription |
boolean | Whether this is a local session description. |
Returns: Error
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1013
processIceGatheringStateComplete
▸ Private
processIceGatheringStateComplete(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1912
processNextSetMaxSendBitrate
▸ Private
processNextSetMaxSendBitrate(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3373
processRemoteDescriptionOnRenegotiation
▸ Private
processRemoteDescriptionOnRenegotiation(promise
: Promise<SessionDescription>, remoteDescription
: SessionDescription): void
Parameters:
Name | Type |
---|---|
promise |
Promise<SessionDescription> |
remoteDescription |
SessionDescription |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2685
processStateChange
▸ processStateChange(): void
Returns: void
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:202
raiseGatheringStateChange
▸ Protected
raiseGatheringStateChange(connection
: WebRtcConnection): void
Raises gathering state change.
Parameters:
Name | Type |
---|---|
connection |
WebRtcConnection |
Returns: void
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1090
raiseIceConnectionStateChange
▸ Protected
raiseIceConnectionStateChange(connection
: WebRtcConnection): void
Raises ICE connection state change.
Parameters:
Name | Type |
---|---|
connection |
WebRtcConnection |
Returns: void
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1110
raiseLocalCandidate
▸ Protected
raiseLocalCandidate(localCandidate
: Candidate): void
Raises a local candidate but only if it has not been already raised.
Parameters:
Name | Type | Description |
---|---|---|
localCandidate |
Candidate | The local candidate. |
Returns: void
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1131
reallocateRtpExtMapId
▸ Private
reallocateRtpExtMapId(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:2048
removeIceServer
▸ removeIceServer(iceServer
: IceServer): void
Removes an ICE server.
Parameters:
Name | Type | Description |
---|---|---|
iceServer |
IceServer | The ICE server. |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1293
removeIceServers
▸ removeIceServers(iceServers
: IceServer[]): void
Removes some ICE servers.
Parameters:
Name | Type | Description |
---|---|---|
iceServers |
IceServer[] | The ICE servers. |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1306
removeOnExternalIdChange
▸ removeOnExternalIdChange(value
: IAction2<string, string>): void
Removes a handler that is raised when external Id of this connection changes. Old external Id as well as internal Id are raised.
Parameters:
Name | Type |
---|---|
value |
IAction2<string, string> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1318
removeOnGatheringStateChange
▸ removeOnGatheringStateChange(value
: IAction1<WebRtcConnection>): void
Removes a handler that is raised when the gathering state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<WebRtcConnection> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1330
removeOnIceConnectionStateChange
▸ removeOnIceConnectionStateChange(value
: IAction1<WebRtcConnection>): void
Removes a handler that is raised when the ice connection state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<WebRtcConnection> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1342
removeOnLocalCandidate
▸ removeOnLocalCandidate(value
: IAction2<WebRtcConnection, Candidate>): void
Removes a handler that is raised when a local candidate is added.
Parameters:
Name | Type |
---|---|
value |
IAction2<WebRtcConnection, Candidate> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1354
removeOnLocalDescription
▸ removeOnLocalDescription(value
: IAction2<WebRtcConnection, SessionDescription>): void
Removes a handler that is raised when a local description is set.
Parameters:
Name | Type |
---|---|
value |
IAction2<WebRtcConnection, SessionDescription> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1366
removeOnRemoteCandidate
▸ removeOnRemoteCandidate(value
: IAction2<WebRtcConnection, Candidate>): void
Removes a handler that is raised when a remote description is added.
Parameters:
Name | Type |
---|---|
value |
IAction2<WebRtcConnection, Candidate> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1378
removeOnRemoteDescription
▸ removeOnRemoteDescription(value
: IAction2<WebRtcConnection, SessionDescription>): void
Removes a handler that is raised when a remote description is set.
Parameters:
Name | Type |
---|---|
value |
IAction2<WebRtcConnection, SessionDescription> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1390
removeOnSignallingStateChange
▸ removeOnSignallingStateChange(value
: IAction1<WebRtcConnection>): void
Removes a handler that is raised when the signalling state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<WebRtcConnection> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1402
removeOnStateChange
▸ removeOnStateChange(value
: IAction1<WebRtcConnection>): void
Removes a handler that is raised when the connection state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<WebRtcConnection> |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1414
removeSdesAttributesIfNeeded
▸ Private
removeSdesAttributesIfNeeded(remoteDescription
: SessionDescription): void
Parameters:
Name | Type |
---|---|
remoteDescription |
SessionDescription |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2741
reorderExtRtpMapIdsOnRenegotiationOffer
▸ Private
reorderExtRtpMapIdsOnRenegotiationOffer(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:2082
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:3280
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:3309
rtcCandidateFromSdpCandidateAttribute
▸ Private
rtcCandidateFromSdpCandidateAttribute(sdpCandidateAttribute
: CandidateAttribute): RTCIceCandidateDictionary
Parameters:
Name | Type |
---|---|
sdpCandidateAttribute |
CandidateAttribute |
Returns: RTCIceCandidateDictionary
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1594
rtcCandidateToSdpCandidateAttribute
▸ Private
rtcCandidateToSdpCandidateAttribute(rtcCandidate
: RTCIceCandidateDictionary): CandidateAttribute
Parameters:
Name | Type |
---|---|
rtcCandidate |
RTCIceCandidateDictionary |
Returns: CandidateAttribute
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1578
selectCodecs
▸ Private
selectCodecs(mediaIndex
: number): RTCRtpCodecParameters[]
Parameters:
Name | Type |
---|---|
mediaIndex |
number |
Returns: RTCRtpCodecParameters[]
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3040
selectEncodings
▸ Private
selectEncodings(mediaIndex
: number, send
: boolean): RTCRtpEncodingParameters[]
Parameters:
Name | Type |
---|---|
mediaIndex |
number |
send |
boolean |
Returns: RTCRtpEncodingParameters[]
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3066
selectRtcp
▸ Private
selectRtcp(mediaIndex
: number, send
: boolean): any
Parameters:
Name | Type |
---|---|
mediaIndex |
number |
send |
boolean |
Returns: any
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3087
sessionDescriptionTypeToEnum
▸ Private
sessionDescriptionTypeToEnum(typeString
: string): SessionDescriptionType
Parameters:
Name | Type |
---|---|
typeString |
string |
Returns: SessionDescriptionType
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1542
sessionDescriptionTypeToString
▸ Private
sessionDescriptionTypeToString(typeEnum
: SessionDescriptionType): string
Parameters:
Name | Type |
---|---|
typeEnum |
SessionDescriptionType |
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1538
setBundlePolicy
▸ setBundlePolicy(value
: BundlePolicy): void
Sets the bundle policy.
Parameters:
Name | Type |
---|---|
value |
BundlePolicy |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1447
setDeadStreamTimeout
▸ setDeadStreamTimeout(value
: number): void
Sets the amount of time (in milliseconds) to wait for connectivity checks to re-establish after they start to fail on a live connection. Defaults to 15,000.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1466
setDynamicValue
▸ setDynamicValue(key
: string, value
: Object): void
Sets a property value in the local cache.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions. |
value |
Object | The property value. This can be any object that needs to be stored for future use. |
Returns: void
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:95
setError
▸ setError(value
: Error): void
Sets the error.
Parameters:
Name | Type |
---|---|
value |
Error |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1479
setExternalId
▸ setExternalId(value
: string): void
Sets the external identifier.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1491
setGatheringState
▸ Protected
setGatheringState(state
: IceGatheringState): void
Parameters:
Name | Type |
---|---|
state |
IceGatheringState |
Returns: void
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2421
setIceCandidateProcessingTimeout
▸ setIceCandidateProcessingTimeout(value
: number): void
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1893
setIceConnectionState
▸ Protected
setIceConnectionState(state
: IceConnectionState): void
Parameters:
Name | Type |
---|---|
state |
IceConnectionState |
Returns: void
Overrides: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2430
setIceGatherPolicy
▸ setIceGatherPolicy(value
: IceGatherPolicy): void
Sets the ICE gather policy.
Parameters:
Name | Type |
---|---|
value |
IceGatherPolicy |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1527
setIceServer
▸ setIceServer(value
: IceServer): void
Sets the ICE server.
Parameters:
Name | Type |
---|---|
value |
IceServer |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1539
setIceServers
▸ setIceServers(value
: IceServer[]): void
Sets the ICE servers.
Parameters:
Name | Type |
---|---|
value |
IceServer[] |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1551
setLegacyTimeout
▸ setLegacyTimeout(value
: boolean): void
Sets a value indicating whether legacy Connection.Timeout should be used. When disabled, Connection.Timeout only accounts for the time spent trying to establish connectivity (i.e. time it takes to transition from the Connecting to the Connected state; from the time point when both offer and answer had been set to the connection being fully established). When enabled, Connection.Timeout accounts for the time spent from receiving an offer (or creating an offer) to establishing connectivity (i.e. time it takes to transition from Initializing to Connected state). By default, LegacyTimeout is set to true, so that existing behavior is preserved. However, in the future default will be updated to false. This means that IL will not account for any signalling delays that may occur while establishing connectivity. This option will be later deprecated.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1573
setLocalDescription
▸ setLocalDescription(localDescription
: SessionDescription): Future<SessionDescription>
Sets the local description.
Parameters:
Name | Type | Description |
---|---|---|
localDescription |
SessionDescription | The local description. |
Returns: Future<SessionDescription>
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1586
setMaxSendBitrate
▸ setMaxSendBitrate(bitrate
: number, streamType
: StreamType): Future<object>
Parameters:
Name | Type |
---|---|
bitrate |
number |
streamType |
StreamType |
Returns: Future<object>
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3363
setNativeDescriptionSuccess
▸ Private
setNativeDescriptionSuccess(sessionDescription
: SessionDescription, promise
: Promise<SessionDescription>): void
Parameters:
Name | Type |
---|---|
sessionDescription |
SessionDescription |
promise |
Promise<SessionDescription> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1981
setRemoteCandidatesDoneTimer
▸ Private
setRemoteCandidatesDoneTimer(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3140
setRemoteDescription
▸ setRemoteDescription(remoteDescription
: SessionDescription): Future<SessionDescription>
Sets the remote description.
Parameters:
Name | Type | Description |
---|---|---|
remoteDescription |
SessionDescription | The remote description. |
Returns: Future<SessionDescription>
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1642
setSignallingState
▸ Protected
setSignallingState(value
: SignallingState): void
Sets the state of the signalling.
Parameters:
Name | Type |
---|---|
value |
SignallingState |
Returns: void
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1701
setTieBreaker
▸ setTieBreaker(value
: string): void
Sets the tie breaker.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Implementation of: IInternalConnection
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1785
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:1799
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:1812
setupTransceivers
▸ Private
setupTransceivers(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:1349
startConnectionTimeout
▸ Private
startConnectionTimeout(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:210
startOrtc
▸ Private
startOrtc(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2949
startOrtcTrack
▸ Private
startOrtcTrack(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: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2981
syncStreamsWithRemoteDescription
▸ Private
syncStreamsWithRemoteDescription(remoteDescription
: SessionDescription): void
Parameters:
Name | Type |
---|---|
remoteDescription |
SessionDescription |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2934
tryGetRtpSender
▸ Private
tryGetRtpSender(mediaStreamIndex
: number): RTCRtpSender
Parameters:
Name | Type |
---|---|
mediaStreamIndex |
number |
Returns: RTCRtpSender
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:3337
unsetDynamicValue
▸ unsetDynamicValue(key
: string): boolean
Removes a property value from the local cache. Returns true if the value was removed and returns false otherwise.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions. |
Returns: boolean
true
if the value was removed; otherwise, false
.
Inherited from: WebRtcConnectionBase
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:122
updateLocalDescription
▸ Private
updateLocalDescription(localDescription
: SessionDescription): SessionDescription
Parameters:
Name | Type |
---|---|
localDescription |
SessionDescription |
Returns: SessionDescription
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:2454
updateMaxBitrateRemoteSdpMessage
▸ Private
updateMaxBitrateRemoteSdpMessage(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:3481
validateCandidate
▸ Private
validateCandidate(candidate
: Candidate): boolean
Parameters:
Name | Type |
---|---|
candidate |
Candidate |
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1451
webrtcCandidateFromCandidate
▸ Private
webrtcCandidateFromCandidate(candidate
: Candidate): RTCIceCandidate
Parameters:
Name | Type |
---|---|
candidate |
Candidate |
Returns: RTCIceCandidate
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1553
webrtcCandidateToCandidate
▸ Private
webrtcCandidateToCandidate(webrtcCandidate
: RTCIceCandidate): Candidate
Parameters:
Name | Type |
---|---|
webrtcCandidate |
RTCIceCandidate |
Returns: Candidate
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1546
webrtcSessionDescriptionFromSessionDescription
▸ Private
webrtcSessionDescriptionFromSessionDescription(sessionDescription
: SessionDescription): WebRtcSessionDescription
Parameters:
Name | Type |
---|---|
sessionDescription |
SessionDescription |
Returns: WebRtcSessionDescription
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1568
webrtcSessionDescriptionToSessionDescription
▸ Private
webrtcSessionDescriptionToSessionDescription(webrtcSessionDescription
: WebRtcSessionDescription): SessionDescription
Parameters:
Name | Type |
---|---|
webrtcSessionDescription |
WebRtcSessionDescription |
Returns: SessionDescription
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnection.ts:1560