/ 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
- 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
- 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:118
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:162
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:175
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:187
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:199
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:211
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:223
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:235
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:247
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:259
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:271
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:283
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:296
close
▸ Abstract
close(): boolean
Closes this instance.
Returns: boolean
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:338
createAnswer
▸ createAnswer(): Future<SessionDescription>
Creates an answer.
Returns: Future<SessionDescription>
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:359
createOffer
▸ createOffer(): Future<SessionDescription>
Creates an offer.
Returns: Future<SessionDescription>
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:400
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:443
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:449
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:455
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:463
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:487
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:495
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:513
fmliveswitchWebRtcConnectionBaseInit
▸ Private
fmliveswitchWebRtcConnectionBaseInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:94
getAudioStream
▸ getAudioStream(): TAudioStream
Gets the first audio stream.
Returns: TAudioStream
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:551
getAudioStreams
▸ Abstract
getAudioStreams(): TAudioStream[]
Gets the audio streams.
Returns: TAudioStream[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:567
getBundlePolicy
▸ getBundlePolicy(): BundlePolicy
Gets the bundle policy.
Returns: BundlePolicy
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:573
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:586
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:599
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:612
getDataStream
▸ getDataStream(): TDataStream
Gets the first data stream.
Returns: TDataStream
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:641
getDataStreams
▸ Abstract
getDataStreams(): TDataStream[]
Gets the data streams.
Returns: TDataStream[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:657
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:666
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:678
getExternalId
▸ getExternalId(): string
Gets the external identifier.
Returns: string
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:690
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:703
getGatheringState
▸ Abstract
getGatheringState(): IceGatheringState
Gets the ICE gathering state.
Returns: IceGatheringState
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:715
getHasAudio
▸ getHasAudio(): boolean
Gets whether this connection has an audio stream.
Returns: boolean
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:721
getHasData
▸ getHasData(): boolean
Gets whether this connection has a data stream.
Returns: boolean
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:733
getHasVideo
▸ getHasVideo(): boolean
Gets whether this connection has a video stream.
Returns: boolean
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:745
getIceConnectionState
▸ Abstract
getIceConnectionState(): IceConnectionState
Gets the ICE connection state.
Returns: IceConnectionState
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:757
getIceGatherPolicy
▸ getIceGatherPolicy(): IceGatherPolicy
Gets the ICE gather policy.
Returns: IceGatherPolicy
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:763
getIceServer
▸ getIceServer(): IceServer
Gets the ICE server.
Returns: IceServer
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:775
getIceServers
▸ getIceServers(): IceServer[]
Gets the ICE servers.
Returns: IceServer[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:787
getId
▸ getId(): string
Gets the identifier.
Returns: string
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:799
getInstance
▸ Protected
Abstract
getInstance(): TConnection
Gets the current instance.
Returns: TConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:811
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:817
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:829
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:841
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:863
getLocalDescription
▸ Abstract
getLocalDescription(): SessionDescription
Gets the local description.
Returns: SessionDescription
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:875
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:881
getRemoteDescription
▸ Abstract
getRemoteDescription(): SessionDescription
Gets the remote description.
Returns: SessionDescription
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:893
getSignallingState
▸ getSignallingState(): SignallingState
Gets the state of the signalling.
Returns: SignallingState
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:901
getState
▸ getState(): ConnectionState
Gets the state of the connection.
Returns: ConnectionState
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:913
getStats
▸ Abstract
getStats(): Future<ConnectionStats>
Gets the current connection stats.
Returns: Future<ConnectionStats>
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:925
getStream
▸ getStream(): TStream
Gets the first stream.
Returns: TStream
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:931
getStreams
▸ Abstract
getStreams(): TStream[]
Gets the streams.
Returns: TStream[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:947
getTieBreaker
▸ getTieBreaker(): string
Gets the tie breaker.
Returns: string
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:953
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:967
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:979
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:999
getVideoStreams
▸ Abstract
getVideoStreams(): TVideoStream[]
Gets the video streams.
Returns: TVideoStream[]
Implementation of: IConnection
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1015
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:1033
processStateChange
▸ Protected
processStateChange(): void
Processes a state change.
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1045
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:1110
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:1130
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:1151
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:1313
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:1326
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:1338
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:1350
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:1362
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:1374
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:1386
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:1398
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:1410
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:1422
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:1434
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:1467
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:1486
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:1499
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:1511
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:1535
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:1541
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:1547
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:1559
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:1571
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:1593
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:1606
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:1661
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:1674
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:1733
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:1819
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:1833
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:1846
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