/ 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

Implements

  • IConnection<TConnection, TStream, TAudioStream, TVideoStream, TDataStream>

Table of contents

Constructors

Methods

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

Methods

addIceServer

▸ addIceServer(iceServer: IceServer): void

Adds an ICE server.

Parameters:

Name Type Description
iceServer IceServer The ICE server.

Returns: void

Implementation of: IConnection

addIceServers

▸ addIceServers(iceServers: IceServer[]): void

Adds some ICE servers.

Parameters:

Name Type Description
iceServers IceServer[] The ICE servers.

Returns: void

Implementation of: IConnection

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

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

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

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

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

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

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

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

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

addRemoteCandidate

▸ addRemoteCandidate(remoteCandidate: Candidate): Future<Candidate>

Adds the remote candidate.

Parameters:

Name Type Description
remoteCandidate Candidate The remote candidate.

Returns: Future<Candidate>

Implementation of: IConnection

close

▸ Abstractclose(): boolean

Closes this instance.

Returns: boolean

Implementation of: IConnection

createAnswer

▸ createAnswer(): Future<SessionDescription>

Creates an answer.

Returns: Future<SessionDescription>

Implementation of: IConnection

createOffer

▸ createOffer(): Future<SessionDescription>

Creates an offer.

Returns: Future<SessionDescription>

Implementation of: IConnection

doAddRemoteCandidate

▸ Protected AbstractdoAddRemoteCandidate(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

doCreateAnswer

▸ Protected AbstractdoCreateAnswer(promise: Promise<SessionDescription>): void

Creates an answer.

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: void

doCreateOffer

▸ Protected AbstractdoCreateOffer(promise: Promise<SessionDescription>): boolean

Creates an offer.

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: boolean

doProcessDescription

▸ ProtecteddoProcessDescription(description: SessionDescription, isLocalDescription: boolean): Error

Processes a session description.

Parameters:

Name Type Description
description SessionDescription The session description.
isLocalDescription boolean Whether this is a local session description.

Returns: Error

doSendCachedLocalCandidates

▸ Protected AbstractdoSendCachedLocalCandidates(): void

Dispatches cached local candidates that were gathered while Connection generated session description.

Returns: void

doSetLocalDescription

▸ Protected AbstractdoSetLocalDescription(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

doSetRemoteDescription

▸ Protected AbstractdoSetRemoteDescription(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

fmliveswitchWebRtcConnectionBaseInit

▸ PrivatefmliveswitchWebRtcConnectionBaseInit(): void

Returns: void

getAudioStream

▸ getAudioStream(): TAudioStream

Gets the first audio stream.

Returns: TAudioStream

Implementation of: IConnection

getAudioStreams

▸ AbstractgetAudioStreams(): TAudioStream[]

Gets the audio streams.

Returns: TAudioStream[]

Implementation of: IConnection

getBundlePolicy

▸ getBundlePolicy(): BundlePolicy

Gets the bundle policy.

Returns: BundlePolicy

Implementation of: IConnection

getCanonicalName

▸ getCanonicalName(): string

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

Returns: string

Implementation of: IConnection

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>

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>

getDataStream

▸ getDataStream(): TDataStream

Gets the first data stream.

Returns: TDataStream

Implementation of: IConnection

getDataStreams

▸ AbstractgetDataStreams(): TDataStream[]

Gets the data streams.

Returns: TDataStream[]

Implementation of: IConnection

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

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: Dynamic

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

getError

▸ getError(): Error

Gets the error.

Returns: Error

Implementation of: IConnection

getExternalId

▸ getExternalId(): string

Gets the external identifier.

Returns: string

Implementation of: IConnection

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>

getGatheringState

▸ AbstractgetGatheringState(): IceGatheringState

Gets the ICE gathering state.

Returns: IceGatheringState

Implementation of: IConnection

getHasAudio

▸ getHasAudio(): boolean

Gets whether this connection has an audio stream.

Returns: boolean

Implementation of: IConnection

getHasData

▸ getHasData(): boolean

Gets whether this connection has a data stream.

Returns: boolean

Implementation of: IConnection

getHasVideo

▸ getHasVideo(): boolean

Gets whether this connection has a video stream.

Returns: boolean

Implementation of: IConnection

getIceConnectionState

▸ AbstractgetIceConnectionState(): IceConnectionState

Gets the ICE connection state.

Returns: IceConnectionState

Implementation of: IConnection

getIceGatherPolicy

▸ getIceGatherPolicy(): IceGatherPolicy

Gets the ICE gather policy.

Returns: IceGatherPolicy

Implementation of: IConnection

getIceServer

▸ getIceServer(): IceServer

Gets the ICE server.

Returns: IceServer

Implementation of: IConnection

getIceServers

▸ getIceServers(): IceServer[]

Gets the ICE servers.

Returns: IceServer[]

Implementation of: IConnection

getId

▸ getId(): string

Gets the identifier.

Returns: string

Implementation of: IConnection

getInstance

▸ Protected AbstractgetInstance(): TConnection

Gets the current instance.

Returns: TConnection

getIsTerminated

▸ getIsTerminated(): boolean

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

Returns: boolean

getIsTerminating

▸ getIsTerminating(): boolean

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

Returns: boolean

getIsTerminatingOrTerminated

▸ getIsTerminatingOrTerminated(): boolean

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

Returns: boolean

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

getLocalDescription

▸ AbstractgetLocalDescription(): SessionDescription

Gets the local description.

Returns: SessionDescription

Implementation of: IConnection

getRemoteDescription

▸ AbstractgetRemoteDescription(): SessionDescription

Gets the remote description.

Returns: SessionDescription

Implementation of: IConnection

getSignallingState

▸ getSignallingState(): SignallingState

Gets the state of the signalling.

Returns: SignallingState

Implementation of: IConnection

getState

▸ getState(): ConnectionState

Gets the state of the connection.

Returns: ConnectionState

Implementation of: IConnection

getStats

▸ AbstractgetStats(): Future<ConnectionStats>

Gets the current connection stats.

Returns: Future<ConnectionStats>

Implementation of: IConnection

getStream

▸ getStream(): TStream

Gets the first stream.

Returns: TStream

getStreams

▸ AbstractgetStreams(): TStream[]

Gets the streams.

Returns: TStream[]

Implementation of: IConnection

getTieBreaker

▸ getTieBreaker(): string

Gets the tie breaker.

Returns: string

Implementation of: IConnection

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

getTrickleIcePolicy

▸ getTrickleIcePolicy(): TrickleIcePolicy

Gets Trickle Ice Support Policy. Cf. https://tools.ietf.org/html/draft-ietf-ice-trickle-05

Returns: TrickleIcePolicy

Implementation of: IConnection

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

getVideoStream

▸ getVideoStream(): TVideoStream

Gets the first video stream.

Returns: TVideoStream

Implementation of: IConnection

getVideoStreams

▸ AbstractgetVideoStreams(): TVideoStream[]

Gets the video streams.

Returns: TVideoStream[]

Implementation of: IConnection

processDescription

▸ ProtectedprocessDescription(description: SessionDescription, isLocalDescription: boolean): Error

Processes a session description.

Parameters:

Name Type Description
description SessionDescription The session description.
isLocalDescription boolean Whether this is a local session description.

Returns: Error

processStateChange

▸ ProtectedprocessStateChange(): void

Processes a state change.

Returns: void

raiseGatheringStateChange

▸ ProtectedraiseGatheringStateChange(connection: TConnection): void

Raises gathering state change.

Parameters:

Name Type
connection TConnection

Returns: void

raiseIceConnectionStateChange

▸ ProtectedraiseIceConnectionStateChange(connection: TConnection): void

Raises ICE connection state change.

Parameters:

Name Type
connection TConnection

Returns: void

raiseLocalCandidate

▸ ProtectedraiseLocalCandidate(localCandidate: Candidate): void

Raises a local candidate but only if it has not been already raised.

Parameters:

Name Type Description
localCandidate Candidate The local candidate.

Returns: void

removeIceServer

▸ removeIceServer(iceServer: IceServer): void

Removes an ICE server.

Parameters:

Name Type Description
iceServer IceServer The ICE server.

Returns: void

Implementation of: IConnection

removeIceServers

▸ removeIceServers(iceServers: IceServer[]): void

Removes some ICE servers.

Parameters:

Name Type Description
iceServers IceServer[] The ICE servers.

Returns: void

Implementation of: IConnection

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

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

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

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

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

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

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

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

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

setBundlePolicy

▸ setBundlePolicy(value: BundlePolicy): void

Sets the bundle policy.

Parameters:

Name Type
value BundlePolicy

Returns: void

Implementation of: IConnection

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

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

setError

▸ setError(value: Error): void

Sets the error.

Parameters:

Name Type
value Error

Returns: void

Implementation of: IConnection

setExternalId

▸ setExternalId(value: string): void

Sets the external identifier.

Parameters:

Name Type
value string

Returns: void

Implementation of: IConnection

setGatheringState

▸ Protected AbstractsetGatheringState(value: IceGatheringState): void

Sets the ICE gathering state.

Parameters:

Name Type
value IceGatheringState

Returns: void

setIceConnectionState

▸ Protected AbstractsetIceConnectionState(value: IceConnectionState): void

Sets the ICE connection state.

Parameters:

Name Type
value IceConnectionState

Returns: void

setIceGatherPolicy

▸ setIceGatherPolicy(value: IceGatherPolicy): void

Sets the ICE gather policy.

Parameters:

Name Type
value IceGatherPolicy

Returns: void

Implementation of: IConnection

setIceServer

▸ setIceServer(value: IceServer): void

Sets the ICE server.

Parameters:

Name Type
value IceServer

Returns: void

Implementation of: IConnection

setIceServers

▸ setIceServers(value: IceServer[]): void

Sets the ICE servers.

Parameters:

Name Type
value IceServer[]

Returns: void

Implementation of: IConnection

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

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

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

setSignallingState

▸ ProtectedsetSignallingState(value: SignallingState): void

Sets the state of the signalling.

Parameters:

Name Type
value SignallingState

Returns: void

setTieBreaker

▸ setTieBreaker(value: string): void

Sets the tie breaker.

Parameters:

Name Type
value string

Returns: void

Implementation of: IConnection

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

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

unsetDynamicValue

▸ unsetDynamicValue(key: string): boolean

Unsets a property value in the local cache.

Parameters:

Name Type Description
key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

Returns: boolean

true if the value was removed; otherwise, false.

Inherited from: Dynamic