/ fm / liveswitch / WebRtcConnectionBase
Class: WebRtcConnectionBase<TConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel>
fm.liveswitch.WebRtcConnectionBase
Connection base properties/methods.
Type parameters
Name | Type |
---|---|
TConnection |
WebRtcConnectionBase<TConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel> |
TStream |
WebRtcStreamBase |
TAudioStream |
IAudioStream |
TVideoStream |
IVideoStream |
TDataStream |
IDataStream<TDataChannel> |
TDataChannel |
IDataChannel<TDataChannel> |
Hierarchy
-
↳ WebRtcConnectionBase
Implements
- IConnection<TConnection, TStream, TAudioStream, TVideoStream, TDataStream>
Table of contents
Constructors
Methods
- addIceServer
- addIceServers
- addOnExternalIdChange
- addOnGatheringStateChange
- addOnIceConnectionStateChange
- addOnLocalCandidate
- addOnLocalDescription
- addOnRemoteCandidate
- addOnRemoteDescription
- addOnSignallingStateChange
- addOnStateChange
- addRemoteCandidate
- close
- createAnswer
- createOffer
- doAddRemoteCandidate
- doCreateAnswer
- doCreateOffer
- doProcessDescription
- doSendCachedLocalCandidates
- doSetLocalDescription
- doSetRemoteDescription
- fmliveswitchWebRtcConnectionBaseInit
- getAudioStream
- getAudioStreams
- getBundlePolicy
- getCanonicalName
- getClosed
- getConnected
- getDataStream
- getDataStreams
- getDeadStreamTimeout
- getDynamicProperties
- getDynamicValue
- getError
- getExternalId
- getFailed
- getGatheringState
- getHasAudio
- getHasData
- getHasVideo
- getIceConnectionState
- getIceGatherPolicy
- getIceServer
- getIceServers
- getId
- getInstance
- getIsTerminated
- getIsTerminating
- getIsTerminatingOrTerminated
- getLegacyTimeout
- getLocalDescription
- getMediaProtocol
- getRemoteDescription
- getSignallingState
- getState
- getStats
- getStream
- getStreams
- getTieBreaker
- getTimeout
- getTrickleIcePolicy
- getTypeString
- getVideoEnabledUpdateConnectionPolicy
- getVideoRetentionPolicy
- getVideoStream
- getVideoStreams
- processDescription
- processStateChange
- raiseGatheringStateChange
- raiseIceConnectionStateChange
- raiseLocalCandidate
- removeIceServer
- removeIceServers
- removeOnExternalIdChange
- removeOnGatheringStateChange
- removeOnIceConnectionStateChange
- removeOnLocalCandidate
- removeOnLocalDescription
- removeOnRemoteCandidate
- removeOnRemoteDescription
- removeOnSignallingStateChange
- removeOnStateChange
- setBundlePolicy
- setDeadStreamTimeout
- setDynamicValue
- setError
- setExternalId
- setGatheringState
- setIceConnectionState
- setIceGatherPolicy
- setIceServer
- setIceServers
- setLegacyTimeout
- setLocalDescription
- setMediaProtocol
- setRemoteDescription
- setSignallingState
- setTieBreaker
- setTimeout
- setTrickleIcePolicy
- setVideoEnabledUpdateConnectionPolicy
- setVideoRetentionPolicy
- unsetDynamicValue
Constructors
constructor
+ new WebRtcConnectionBase<TConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel>(sharedLock
: Object, connectionId
: string): WebRtcConnectionBase<TConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel>
Initializes a new instance of the [[fm.liveswitch.connectionBase]] class.
Type parameters:
Name | Type |
---|---|
TConnection |
WebRtcConnectionBase<TConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel, TConnection> |
TStream |
WebRtcStreamBase<TStream> |
TAudioStream |
IAudioStream |
TVideoStream |
IVideoStream |
TDataStream |
IDataStream<TDataChannel, TDataStream> |
TDataChannel |
IDataChannel<TDataChannel, TDataChannel> |
Parameters:
Name | Type |
---|---|
sharedLock |
Object |
connectionId |
string |
Returns: WebRtcConnectionBase<TConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel>
Inherited from: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:124
Methods
addIceServer
▸ addIceServer(iceServer
: IceServer): void
Adds an ICE server.
Parameters:
Name | Type | Description |
---|---|---|
iceServer |
IceServer | The ICE server. |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:174
addIceServers
▸ addIceServers(iceServers
: IceServer[]): void
Adds some ICE servers.
Parameters:
Name | Type | Description |
---|---|---|
iceServers |
IceServer[] | The ICE servers. |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:187
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:199
addOnGatheringStateChange
▸ addOnGatheringStateChange(value
: IAction1<TConnection>): void
Adds a handler that is raised when the gathering state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<TConnection> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:211
addOnIceConnectionStateChange
▸ addOnIceConnectionStateChange(value
: IAction1<TConnection>): void
Adds a handler that is raised when the ice connection state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<TConnection> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:223
addOnLocalCandidate
▸ addOnLocalCandidate(value
: IAction2<TConnection, Candidate>): void
Adds a handler that is raised when a local candidate is added.
Parameters:
Name | Type |
---|---|
value |
IAction2<TConnection, Candidate> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:235
addOnLocalDescription
▸ addOnLocalDescription(value
: IAction2<TConnection, SessionDescription>): void
Adds a handler that is raised when a local description is set.
Parameters:
Name | Type |
---|---|
value |
IAction2<TConnection, SessionDescription> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:247
addOnRemoteCandidate
▸ addOnRemoteCandidate(value
: IAction2<TConnection, Candidate>): void
Adds a handler that is raised when a remote description is added.
Parameters:
Name | Type |
---|---|
value |
IAction2<TConnection, Candidate> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:259
addOnRemoteDescription
▸ addOnRemoteDescription(value
: IAction2<TConnection, SessionDescription>): void
Adds a handler that is raised when a remote description is set.
Parameters:
Name | Type |
---|---|
value |
IAction2<TConnection, SessionDescription> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:271
addOnSignallingStateChange
▸ addOnSignallingStateChange(value
: IAction1<TConnection>): void
Adds a handler that is raised when the signalling state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<TConnection> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:283
addOnStateChange
▸ addOnStateChange(value
: IAction1<TConnection>): void
Adds a handler that is raised when the connection state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<TConnection> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:295
addRemoteCandidate
▸ addRemoteCandidate(remoteCandidate
: Candidate): Future<Candidate>
Adds the remote candidate.
Parameters:
Name | Type | Description |
---|---|---|
remoteCandidate |
Candidate | The remote candidate. |
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:308
close
▸ Abstract
close(): boolean
Closes this instance.
Returns: boolean
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:350
createAnswer
▸ createAnswer(): Future<SessionDescription>
Creates an answer.
Returns: Future<SessionDescription>
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:371
createOffer
▸ createOffer(): Future<SessionDescription>
Creates an offer.
Returns: Future<SessionDescription>
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:412
doAddRemoteCandidate
▸ Protected
Abstract
doAddRemoteCandidate(promise
: Promise<Candidate>, remoteCandidate
: Candidate): void
Adds the remote candidate.
Parameters:
Name | Type | Description |
---|---|---|
promise |
Promise<Candidate> | The promise. |
remoteCandidate |
Candidate | The remote candidate. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:455
doCreateAnswer
▸ Protected
Abstract
doCreateAnswer(promise
: Promise<SessionDescription>): void
Creates an answer.
Parameters:
Name | Type |
---|---|
promise |
Promise<SessionDescription> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:461
doCreateOffer
▸ Protected
Abstract
doCreateOffer(promise
: Promise<SessionDescription>): boolean
Creates an offer.
Parameters:
Name | Type |
---|---|
promise |
Promise<SessionDescription> |
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:467
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
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:475
doSendCachedLocalCandidates
▸ Protected
Abstract
doSendCachedLocalCandidates(): void
Dispatches cached local candidates that were gathered while Connection generated session description.
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:499
doSetLocalDescription
▸ Protected
Abstract
doSetLocalDescription(promise
: Promise<SessionDescription>, localDescription
: SessionDescription): void
Sets the local description.
Parameters:
Name | Type | Description |
---|---|---|
promise |
Promise<SessionDescription> | The promise. |
localDescription |
SessionDescription | The local description. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:507
doSetRemoteDescription
▸ Protected
Abstract
doSetRemoteDescription(promise
: Promise<SessionDescription>, remoteDescription
: SessionDescription): void
Sets the remote description.
Parameters:
Name | Type | Description |
---|---|---|
promise |
Promise<SessionDescription> | The promise. |
remoteDescription |
SessionDescription | The remote description. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:525
fmliveswitchWebRtcConnectionBaseInit
▸ Private
fmliveswitchWebRtcConnectionBaseInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:100
getAudioStream
▸ getAudioStream(): TAudioStream
Gets the first audio stream.
Returns: TAudioStream
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:563
getAudioStreams
▸ Abstract
getAudioStreams(): TAudioStream[]
Gets the audio streams.
Returns: TAudioStream[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:579
getBundlePolicy
▸ getBundlePolicy(): BundlePolicy
Gets the bundle policy.
Returns: BundlePolicy
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:585
getCanonicalName
▸ getCanonicalName(): string
Gets the canonical name.
deprecated
Use MediaStream.LocalCanonicalName instead.
Returns: string
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:598
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>
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:611
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>
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:624
getDataStream
▸ getDataStream(): TDataStream
Gets the first data stream.
Returns: TDataStream
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:653
getDataStreams
▸ Abstract
getDataStreams(): TDataStream[]
Gets the data streams.
Returns: TDataStream[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:669
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:678
getDynamicProperties
▸ getDynamicProperties(): Hash<string, Object>
Gets all dynamic properties on this instance.
Returns: Hash<string, Object>
Inherited from: Dynamic
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: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:61
getError
▸ getError(): Error
Gets the error.
Returns: Error
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:690
getExternalId
▸ getExternalId(): string
Gets the external identifier.
Returns: string
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:702
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>
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:715
getGatheringState
▸ Abstract
getGatheringState(): IceGatheringState
Gets the ICE gathering state.
Returns: IceGatheringState
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:727
getHasAudio
▸ getHasAudio(): boolean
Gets whether this connection has an audio stream.
Returns: boolean
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:733
getHasData
▸ getHasData(): boolean
Gets whether this connection has a data stream.
Returns: boolean
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:745
getHasVideo
▸ getHasVideo(): boolean
Gets whether this connection has a video stream.
Returns: boolean
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:757
getIceConnectionState
▸ Abstract
getIceConnectionState(): IceConnectionState
Gets the ICE connection state.
Returns: IceConnectionState
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:769
getIceGatherPolicy
▸ getIceGatherPolicy(): IceGatherPolicy
Gets the ICE gather policy.
Returns: IceGatherPolicy
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:775
getIceServer
▸ getIceServer(): IceServer
Gets the ICE server.
Returns: IceServer
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:787
getIceServers
▸ getIceServers(): IceServer[]
Gets the ICE servers.
Returns: IceServer[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:799
getId
▸ getId(): string
Gets the identifier.
Returns: string
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:811
getInstance
▸ Protected
Abstract
getInstance(): TConnection
Gets the current instance.
Returns: TConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:823
getIsTerminated
▸ getIsTerminated(): boolean
Gets a value indicating whether the connection is currently closed or failed.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:829
getIsTerminating
▸ getIsTerminating(): boolean
Gets a value indicating whether the connection is currently closing or failing.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:841
getIsTerminatingOrTerminated
▸ getIsTerminatingOrTerminated(): boolean
Gets a value indicating whether the connection is currently closing, failing, closed, or failed.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:853
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:875
getLocalDescription
▸ Abstract
getLocalDescription(): SessionDescription
Gets the local description.
Returns: SessionDescription
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:887
getMediaProtocol
▸ getMediaProtocol(): MediaProtocol
Gets the media protocol in use on this connection.
Returns: MediaProtocol
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:906
getRemoteDescription
▸ Abstract
getRemoteDescription(): SessionDescription
Gets the remote description.
Returns: SessionDescription
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:918
getSignallingState
▸ getSignallingState(): SignallingState
Gets the state of the signalling.
Returns: SignallingState
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:926
getState
▸ getState(): ConnectionState
Gets the state of the connection.
Returns: ConnectionState
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:938
getStats
▸ Abstract
getStats(): Future<ConnectionStats>
Gets the current connection stats.
Returns: Future<ConnectionStats>
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:950
getStream
▸ getStream(): TStream
Gets the first stream.
Returns: TStream
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:956
getStreams
▸ Abstract
getStreams(): TStream[]
Gets the streams.
Returns: TStream[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:972
getTieBreaker
▸ getTieBreaker(): string
Gets the tie breaker.
Returns: string
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:978
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:992
getTrickleIcePolicy
▸ getTrickleIcePolicy(): TrickleIcePolicy
Gets Trickle Ice Support Policy. Cf. https://tools.ietf.org/html/draft-ietf-ice-trickle-05
Returns: TrickleIcePolicy
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1004
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:10
getVideoEnabledUpdateConnectionPolicy
▸ getVideoEnabledUpdateConnectionPolicy(): IFunction1<number, number>
Gets a method that determines when to enable video again on a connection that dynamically disables video. Optional. If not set, default policy will be used. Takes in an interger parameter that represents the amount of attempts already tried. Will return an interger value as a time period in seconds for how long to wait for the next attempt or -1 for no more attempts.
Returns: IFunction1<number, number>
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1025
getVideoRetentionPolicy
▸ getVideoRetentionPolicy(): VideoRetentionPolicy
Gets the Video Retention Policy. This will determine how we will handle video on the connection when the connection is poor in quality.
Returns: VideoRetentionPolicy
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1038
getVideoStream
▸ getVideoStream(): TVideoStream
Gets the first video stream.
Returns: TVideoStream
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1050
getVideoStreams
▸ Abstract
getVideoStreams(): TVideoStream[]
Gets the video streams.
Returns: TVideoStream[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1066
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
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1084
processStateChange
▸ Protected
processStateChange(): void
Processes a state change.
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1096
raiseGatheringStateChange
▸ Protected
raiseGatheringStateChange(connection
: TConnection): void
Raises gathering state change.
Parameters:
Name | Type |
---|---|
connection |
TConnection |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1161
raiseIceConnectionStateChange
▸ Protected
raiseIceConnectionStateChange(connection
: TConnection): void
Raises ICE connection state change.
Parameters:
Name | Type |
---|---|
connection |
TConnection |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1181
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
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1202
removeIceServer
▸ removeIceServer(iceServer
: IceServer): void
Removes an ICE server.
Parameters:
Name | Type | Description |
---|---|---|
iceServer |
IceServer | The ICE server. |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1368
removeIceServers
▸ removeIceServers(iceServers
: IceServer[]): void
Removes some ICE servers.
Parameters:
Name | Type | Description |
---|---|---|
iceServers |
IceServer[] | The ICE servers. |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1381
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1393
removeOnGatheringStateChange
▸ removeOnGatheringStateChange(value
: IAction1<TConnection>): void
Removes a handler that is raised when the gathering state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<TConnection> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1405
removeOnIceConnectionStateChange
▸ removeOnIceConnectionStateChange(value
: IAction1<TConnection>): void
Removes a handler that is raised when the ice connection state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<TConnection> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1417
removeOnLocalCandidate
▸ removeOnLocalCandidate(value
: IAction2<TConnection, Candidate>): void
Removes a handler that is raised when a local candidate is added.
Parameters:
Name | Type |
---|---|
value |
IAction2<TConnection, Candidate> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1429
removeOnLocalDescription
▸ removeOnLocalDescription(value
: IAction2<TConnection, SessionDescription>): void
Removes a handler that is raised when a local description is set.
Parameters:
Name | Type |
---|---|
value |
IAction2<TConnection, SessionDescription> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1441
removeOnRemoteCandidate
▸ removeOnRemoteCandidate(value
: IAction2<TConnection, Candidate>): void
Removes a handler that is raised when a remote description is added.
Parameters:
Name | Type |
---|---|
value |
IAction2<TConnection, Candidate> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1453
removeOnRemoteDescription
▸ removeOnRemoteDescription(value
: IAction2<TConnection, SessionDescription>): void
Removes a handler that is raised when a remote description is set.
Parameters:
Name | Type |
---|---|
value |
IAction2<TConnection, SessionDescription> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1465
removeOnSignallingStateChange
▸ removeOnSignallingStateChange(value
: IAction1<TConnection>): void
Removes a handler that is raised when the signalling state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<TConnection> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1477
removeOnStateChange
▸ removeOnStateChange(value
: IAction1<TConnection>): void
Removes a handler that is raised when the connection state changes.
Parameters:
Name | Type |
---|---|
value |
IAction1<TConnection> |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1489
setBundlePolicy
▸ setBundlePolicy(value
: BundlePolicy): void
Sets the bundle policy.
Parameters:
Name | Type |
---|---|
value |
BundlePolicy |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1522
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1541
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: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:98
setError
▸ setError(value
: Error): void
Sets the error.
Parameters:
Name | Type |
---|---|
value |
Error |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1554
setExternalId
▸ setExternalId(value
: string): void
Sets the external identifier.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1566
setGatheringState
▸ Protected
Abstract
setGatheringState(value
: IceGatheringState): void
Sets the ICE gathering state.
Parameters:
Name | Type |
---|---|
value |
IceGatheringState |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1595
setIceConnectionState
▸ Protected
Abstract
setIceConnectionState(value
: IceConnectionState): void
Sets the ICE connection state.
Parameters:
Name | Type |
---|---|
value |
IceConnectionState |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1601
setIceGatherPolicy
▸ setIceGatherPolicy(value
: IceGatherPolicy): void
Sets the ICE gather policy.
Parameters:
Name | Type |
---|---|
value |
IceGatherPolicy |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1607
setIceServer
▸ setIceServer(value
: IceServer): void
Sets the ICE server.
Parameters:
Name | Type |
---|---|
value |
IceServer |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1619
setIceServers
▸ setIceServers(value
: IceServer[]): void
Sets the ICE servers.
Parameters:
Name | Type |
---|---|
value |
IceServer[] |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1631
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1653
setLocalDescription
▸ setLocalDescription(localDescription
: SessionDescription): Future<SessionDescription>
Sets the local description.
Parameters:
Name | Type | Description |
---|---|---|
localDescription |
SessionDescription | The local description. |
Returns: Future<SessionDescription>
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1666
setMediaProtocol
▸ setMediaProtocol(value
: MediaProtocol): void
Sets the media protocol in use on this connection.
Parameters:
Name | Type |
---|---|
value |
MediaProtocol |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1721
setRemoteDescription
▸ setRemoteDescription(remoteDescription
: SessionDescription): Future<SessionDescription>
Sets the remote description.
Parameters:
Name | Type | Description |
---|---|---|
remoteDescription |
SessionDescription | The remote description. |
Returns: Future<SessionDescription>
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1734
setSignallingState
▸ Protected
setSignallingState(value
: SignallingState): void
Sets the state of the signalling.
Parameters:
Name | Type |
---|---|
value |
SignallingState |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1793
setTieBreaker
▸ setTieBreaker(value
: string): void
Sets the tie breaker.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1875
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1889
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1902
setVideoEnabledUpdateConnectionPolicy
▸ setVideoEnabledUpdateConnectionPolicy(value
: IFunction1<number, number>): void
Sets a method that determines when to enable video again on a connection that dynamically disables video. Optional. If not set, default policy will be used. Takes in an interger parameter that represents the amount of attempts already tried. Will return an interger value as a time period in seconds for how long to wait for the next attempt or -1 for no more attempts.
Parameters:
Name | Type |
---|---|
value |
IFunction1<number, number> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1934
setVideoRetentionPolicy
▸ setVideoRetentionPolicy(value
: VideoRetentionPolicy): void
Sets the Video Retention Policy. This will determine how we will handle video on the connection when the connection is poor in quality.
Parameters:
Name | Type |
---|---|
value |
VideoRetentionPolicy |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1947
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: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:125