/ 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
- getRemoteDescription
- getSignallingState
- getState
- getStats
- getStream
- getStreams
- getTieBreaker
- getTimeout
- getTrickleIcePolicy
- getTypeString
- 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
- setRemoteDescription
- setSignallingState
- setTieBreaker
- setTimeout
- setTrickleIcePolicy
- unsetDynamicValue
Constructors
constructor
+ new WebRtcConnectionBase<TConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel>(sharedLock
: Object): 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 |
Returns: WebRtcConnectionBase<TConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel>
Inherited from: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:116
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:160
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: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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:185
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:197
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:209
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:221
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:233
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:245
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:257
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:269
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:281
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:294
close
▸ Abstract
close(): boolean
Closes this instance.
Returns: boolean
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:334
createAnswer
▸ createAnswer(): Future<SessionDescription>
Creates an answer.
Returns: Future<SessionDescription>
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:351
createOffer
▸ createOffer(): Future<SessionDescription>
Creates an offer.
Returns: Future<SessionDescription>
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:392
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:435
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:441
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:447
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:455
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:479
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:487
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:505
fmliveswitchWebRtcConnectionBaseInit
▸ Private
fmliveswitchWebRtcConnectionBaseInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:92
getAudioStream
▸ getAudioStream(): TAudioStream
Gets the first audio stream.
Returns: TAudioStream
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:543
getAudioStreams
▸ Abstract
getAudioStreams(): TAudioStream[]
Gets the audio streams.
Returns: TAudioStream[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:559
getBundlePolicy
▸ getBundlePolicy(): BundlePolicy
Gets the bundle policy.
Returns: BundlePolicy
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:565
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:578
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:591
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:604
getDataStream
▸ getDataStream(): TDataStream
Gets the first data stream.
Returns: TDataStream
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:633
getDataStreams
▸ Abstract
getDataStreams(): TDataStream[]
Gets the data streams.
Returns: TDataStream[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:649
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:658
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:58
getError
▸ getError(): Error
Gets the error.
Returns: Error
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:670
getExternalId
▸ getExternalId(): string
Gets the external identifier.
Returns: string
Implementation of: IConnection
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>
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:695
getGatheringState
▸ Abstract
getGatheringState(): IceGatheringState
Gets the ICE gathering state.
Returns: IceGatheringState
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:707
getHasAudio
▸ getHasAudio(): boolean
Gets whether this connection has an audio stream.
Returns: boolean
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:713
getHasData
▸ getHasData(): boolean
Gets whether this connection has a data stream.
Returns: boolean
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:725
getHasVideo
▸ getHasVideo(): boolean
Gets whether this connection has a video stream.
Returns: boolean
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:737
getIceConnectionState
▸ Abstract
getIceConnectionState(): IceConnectionState
Gets the ICE connection state.
Returns: IceConnectionState
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:749
getIceGatherPolicy
▸ getIceGatherPolicy(): IceGatherPolicy
Gets the ICE gather policy.
Returns: IceGatherPolicy
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:755
getIceServer
▸ getIceServer(): IceServer
Gets the ICE server.
Returns: IceServer
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:767
getIceServers
▸ getIceServers(): IceServer[]
Gets the ICE servers.
Returns: IceServer[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:779
getId
▸ getId(): string
Gets the identifier.
Returns: string
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:791
getInstance
▸ Protected
Abstract
getInstance(): TConnection
Gets the current instance.
Returns: TConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:803
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:809
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:821
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: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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:855
getLocalDescription
▸ Abstract
getLocalDescription(): SessionDescription
Gets the local description.
Returns: SessionDescription
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:867
getRemoteDescription
▸ Abstract
getRemoteDescription(): SessionDescription
Gets the remote description.
Returns: SessionDescription
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:873
getSignallingState
▸ getSignallingState(): SignallingState
Gets the state of the signalling.
Returns: SignallingState
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:881
getState
▸ getState(): ConnectionState
Gets the state of the connection.
Returns: ConnectionState
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:893
getStats
▸ Abstract
getStats(): Future<ConnectionStats>
Gets the current connection stats.
Returns: Future<ConnectionStats>
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:905
getStream
▸ getStream(): TStream
Gets the first stream.
Returns: TStream
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:911
getStreams
▸ Abstract
getStreams(): TStream[]
Gets the streams.
Returns: TStream[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:927
getTieBreaker
▸ getTieBreaker(): string
Gets the tie breaker.
Returns: string
Implementation of: IConnection
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:947
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:959
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:10
getVideoStream
▸ getVideoStream(): TVideoStream
Gets the first video stream.
Returns: TVideoStream
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:979
getVideoStreams
▸ Abstract
getVideoStreams(): TVideoStream[]
Gets the video streams.
Returns: TVideoStream[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:995
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:1013
processStateChange
▸ Protected
processStateChange(): void
Processes a state change.
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1025
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:1090
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: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
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1131
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:1293
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: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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1318
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:1330
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:1342
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:1354
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:1366
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:1378
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:1390
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:1402
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:1414
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: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: IConnection
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: Dynamic
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: IConnection
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1491
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:1515
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:1521
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:1527
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:1539
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: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: IConnection
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1586
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:1642
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:1701
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: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: IConnection
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: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1812
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:122