/ 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

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:169

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:182

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:194

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:206

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:218

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:230

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:242

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:254

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:266

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:278

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:290

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

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:303

close

▸ Abstractclose(): boolean

Closes this instance.

Returns: boolean

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:345

createAnswer

▸ createAnswer(): Future<SessionDescription>

Creates an answer.

Returns: Future<SessionDescription>

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:366

createOffer

▸ createOffer(): Future<SessionDescription>

Creates an offer.

Returns: Future<SessionDescription>

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:407

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

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:450

doCreateAnswer

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

Creates an answer.

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:456

doCreateOffer

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

Creates an offer.

Parameters:

Name Type
promise Promise<SessionDescription>

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:462

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

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:470

doSendCachedLocalCandidates

▸ Protected AbstractdoSendCachedLocalCandidates(): void

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

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:494

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

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:502

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

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:520

fmliveswitchWebRtcConnectionBaseInit

▸ PrivatefmliveswitchWebRtcConnectionBaseInit(): 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:558

getAudioStreams

▸ AbstractgetAudioStreams(): TAudioStream[]

Gets the audio streams.

Returns: TAudioStream[]

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:574

getBundlePolicy

▸ getBundlePolicy(): BundlePolicy

Gets the bundle policy.

Returns: BundlePolicy

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:580

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:593

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:606

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:619

getDataStream

▸ getDataStream(): TDataStream

Gets the first data stream.

Returns: TDataStream

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:648

getDataStreams

▸ AbstractgetDataStreams(): TDataStream[]

Gets the data streams.

Returns: TDataStream[]

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:664

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:673

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:685

getExternalId

▸ getExternalId(): string

Gets the external identifier.

Returns: string

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:697

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:710

getGatheringState

▸ AbstractgetGatheringState(): IceGatheringState

Gets the ICE gathering state.

Returns: IceGatheringState

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:722

getHasAudio

▸ getHasAudio(): boolean

Gets whether this connection has an audio stream.

Returns: boolean

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:728

getHasData

▸ getHasData(): boolean

Gets whether this connection has a data stream.

Returns: boolean

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:740

getHasVideo

▸ getHasVideo(): boolean

Gets whether this connection has a video stream.

Returns: boolean

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:752

getIceConnectionState

▸ AbstractgetIceConnectionState(): IceConnectionState

Gets the ICE connection state.

Returns: IceConnectionState

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:764

getIceGatherPolicy

▸ getIceGatherPolicy(): IceGatherPolicy

Gets the ICE gather policy.

Returns: IceGatherPolicy

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:770

getIceServer

▸ getIceServer(): IceServer

Gets the ICE server.

Returns: IceServer

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:782

getIceServers

▸ getIceServers(): IceServer[]

Gets the ICE servers.

Returns: IceServer[]

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:794

getId

▸ getId(): string

Gets the identifier.

Returns: string

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:806

getInstance

▸ Protected AbstractgetInstance(): TConnection

Gets the current instance.

Returns: TConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:818

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:824

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:836

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:848

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:870

getLocalDescription

▸ AbstractgetLocalDescription(): SessionDescription

Gets the local description.

Returns: SessionDescription

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:882

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:901

getRemoteDescription

▸ AbstractgetRemoteDescription(): SessionDescription

Gets the remote description.

Returns: SessionDescription

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:913

getSignallingState

▸ getSignallingState(): SignallingState

Gets the state of the signalling.

Returns: SignallingState

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:921

getState

▸ getState(): ConnectionState

Gets the state of the connection.

Returns: ConnectionState

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:933

getStats

▸ AbstractgetStats(): Future<ConnectionStats>

Gets the current connection stats.

Returns: Future<ConnectionStats>

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:945

getStream

▸ getStream(): TStream

Gets the first stream.

Returns: TStream

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:951

getStreams

▸ AbstractgetStreams(): TStream[]

Gets the streams.

Returns: TStream[]

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:967

getTieBreaker

▸ getTieBreaker(): string

Gets the tie breaker.

Returns: string

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:973

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:987

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:999

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:1020

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:1033

getVideoStream

▸ getVideoStream(): TVideoStream

Gets the first video stream.

Returns: TVideoStream

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1045

getVideoStreams

▸ AbstractgetVideoStreams(): TVideoStream[]

Gets the video streams.

Returns: TVideoStream[]

Implementation of: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1061

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

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1079

processStateChange

▸ ProtectedprocessStateChange(): void

Processes a state change.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1091

raiseGatheringStateChange

▸ ProtectedraiseGatheringStateChange(connection: TConnection): void

Raises gathering state change.

Parameters:

Name Type
connection TConnection

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1156

raiseIceConnectionStateChange

▸ ProtectedraiseIceConnectionStateChange(connection: TConnection): void

Raises ICE connection state change.

Parameters:

Name Type
connection TConnection

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1176

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

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1197

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:1359

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:1372

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:1384

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:1396

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:1408

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:1420

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:1432

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:1444

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:1456

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:1468

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:1480

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:1513

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:1532

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:1545

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:1557

setGatheringState

▸ Protected AbstractsetGatheringState(value: IceGatheringState): void

Sets the ICE gathering state.

Parameters:

Name Type
value IceGatheringState

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1586

setIceConnectionState

▸ Protected AbstractsetIceConnectionState(value: IceConnectionState): void

Sets the ICE connection state.

Parameters:

Name Type
value IceConnectionState

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1592

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:1598

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:1610

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:1622

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:1644

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:1657

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:1712

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:1725

setSignallingState

▸ ProtectedsetSignallingState(value: SignallingState): void

Sets the state of the signalling.

Parameters:

Name Type
value SignallingState

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcConnectionBase.ts:1784

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:1866

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:1880

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:1893

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:1925

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:1938

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