/ fm / liveswitch / WssWebSocketConnection

Class: WssWebSocketConnection

fm.liveswitch.WssWebSocketConnection

Hierarchy

• WssWebSocketConnectionBase<WssWebSocketConnection, WebRtcStream, WebRtcAudioStream, WebRtcVideoStream, WebRtcDataStream, WebRtcDataChannel>

  ↳ WssWebSocketConnection

Implements

• IInternalConnection

Table of contents

Constructors

• constructor

Properties

• __localMediaForAudio
• __localMediaForVideo
• __remoteMedia

Methods

• _getExternal
• addIceServer
• addIceServers
• addOnExternalIdChange
• addOnGatheringStateChange
• addOnIceConnectionStateChange
• addOnLocalCandidate
• addOnLocalDescription
• addOnRemoteCandidate
• addOnRemoteDescription
• addOnSignallingStateChange
• addOnStateChange
• addRemoteCandidate
• addToWebSocketConnection
• close
• constraintMax
• constraintMin
• createAnswer
• createOffer
• createWssManager
• fail
• getAudioStream
• getAudioStreams
• getBundlePolicy
• getCanonicalName
• getDataStream
• getDataStreams
• getDeadStreamTimeout
• getDynamicProperties
• getDynamicValue
• getError
• getExternalId
• getGatheringState
• getHasAudio
• getHasData
• getHasVideo
• getIceConnectionState
• getIceGatherPolicy
• getIceServer
• getIceServers
• getId
• getLegacyTimeout
• getLocalDescription
• getMediaProtocol
• getReceiverStats
• getRemoteDescription
• getSenderStats
• getSignallingState
• getState
• getStats
• getStreams
• getTieBreaker
• getTimeout
• getTransportStats
• getTrickleIcePolicy
• getTypeString
• getVideoEnabledUpdateConnectionPolicy
• getVideoRetentionPolicy
• getVideoStream
• getVideoStreams
• getWssManager
• isCapableOfReceiving
• isCapableOfSending
• removeIceServer
• removeIceServers
• removeOnExternalIdChange
• removeOnGatheringStateChange
• removeOnIceConnectionStateChange
• removeOnLocalCandidate
• removeOnLocalDescription
• removeOnRemoteCandidate
• removeOnRemoteDescription
• removeOnSignallingStateChange
• removeOnStateChange
• setBundlePolicy
• setDeadStreamTimeout
• setDynamicValue
• setError
• setExternalId
• setIceGatherPolicy
• setIceServer
• setIceServers
• setLegacyTimeout
• setLocalDescription
• setRemoteDescription
• setState
• setTieBreaker
• setTimeout
• setTrickleIcePolicy
• setVideoEnabledUpdateConnectionPolicy
• setVideoRetentionPolicy
• streamOverWebSocket
• unsetDynamicValue
• updateWebSocketConnection

Constructors

constructor

+ new WssWebSocketConnection(external: IExternalConnection, localMediaForAudio: LocalMedia, localMediaForVideo: LocalMedia, remoteMedia: RemoteMedia, streams: WebRtcStream[]): WssWebSocketConnection

Parameters:

Name	Type
external	IExternalConnection
localMediaForAudio	LocalMedia
localMediaForVideo	LocalMedia
remoteMedia	RemoteMedia
streams	WebRtcStream[]

Returns: WssWebSocketConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:49

Properties

__localMediaForAudio

• Protected __localMediaForAudio: LocalMedia

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:15

---

__localMediaForVideo

• Protected __localMediaForVideo: LocalMedia

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:16

---

__remoteMedia

• Protected __remoteMedia: RemoteMedia

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:37

Methods

_getExternal

▸ _getExternal(): IExternalConnection

Returns: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:30

---

addIceServer

▸ addIceServer(iceServer: IceServer): void

Parameters:

Name	Type
iceServer	IceServer

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:137

---

addIceServers

▸ addIceServers(iceServers: IceServer[]): void

Parameters:

Name	Type
iceServers	IceServer[]

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:144

---

addOnExternalIdChange

▸ addOnExternalIdChange(value: IAction2<string, string>): void

Parameters:

Name	Type
value	IAction2<string, string>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:151

---

addOnGatheringStateChange

▸ addOnGatheringStateChange(value: IAction1<WssWebSocketConnection>): void

Parameters:

Name	Type
value	IAction1<WssWebSocketConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:158

---

addOnIceConnectionStateChange

▸ addOnIceConnectionStateChange(value: IAction1<WssWebSocketConnection>): void

Parameters:

Name	Type
value	IAction1<WssWebSocketConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:165

---

addOnLocalCandidate

▸ addOnLocalCandidate(value: IAction2<WssWebSocketConnection, Candidate>): void

Parameters:

Name	Type
value	IAction2<WssWebSocketConnection, Candidate>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:172

---

addOnLocalDescription

▸ addOnLocalDescription(value: IAction2<WssWebSocketConnection, SessionDescription>): void

Parameters:

Name	Type
value	IAction2<WssWebSocketConnection, SessionDescription>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:179

---

addOnRemoteCandidate

▸ addOnRemoteCandidate(value: IAction2<WssWebSocketConnection, Candidate>): void

Parameters:

Name	Type
value	IAction2<WssWebSocketConnection, Candidate>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:186

---

addOnRemoteDescription

▸ addOnRemoteDescription(value: IAction2<WssWebSocketConnection, SessionDescription>): void

Parameters:

Name	Type
value	IAction2<WssWebSocketConnection, SessionDescription>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:193

---

addOnSignallingStateChange

▸ addOnSignallingStateChange(value: IAction1<WssWebSocketConnection>): void

Parameters:

Name	Type
value	IAction1<WssWebSocketConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:200

---

addOnStateChange

▸ addOnStateChange(value: IAction1<WssWebSocketConnection>): void

Parameters:

Name	Type
value	IAction1<WssWebSocketConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:207

---

addRemoteCandidate

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

Parameters:

Name	Type
remoteCandidate	Candidate

Returns: Future<Candidate>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:214

---

addToWebSocketConnection

▸ addToWebSocketConnection(openArgs: WssServiceOpenArgs): void

Parameters:

Name	Type
openArgs	WssServiceOpenArgs

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:251

---

close

▸ close(): boolean

Returns: boolean

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:260

---

constraintMax

▸ PrivateconstraintMax(num1: number, num2: number): number

Parameters:

Name	Type
num1	number
num2	number

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:66

---

constraintMin

▸ PrivateconstraintMin(num1: number, num2: number): number

Parameters:

Name	Type
num1	number
num2	number

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:56

---

createAnswer

▸ createAnswer(): Future<SessionDescription>

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:267

---

createOffer

▸ createOffer(): Future<SessionDescription>

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:274

---

createWssManager

▸ createWssManager(openArgs: WssServiceOpenArgs): WssManager

Parameters:

Name	Type
openArgs	WssServiceOpenArgs

Returns: WssManager

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:5

---

fail

▸ fail(error: Error): void

Parameters:

Name	Type
error	Error

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:283

---

getAudioStream

▸ getAudioStream(): WebRtcAudioStream

Returns: WebRtcAudioStream

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:291

---

getAudioStreams

▸ getAudioStreams(): WebRtcAudioStream[]

Returns: WebRtcAudioStream[]

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:8

---

getBundlePolicy

▸ getBundlePolicy(): BundlePolicy

Returns: BundlePolicy

Implementation of: IInternalConnection

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

---

getCanonicalName

▸ getCanonicalName(): string

Returns: string

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:310

---

getDataStream

▸ getDataStream(): WebRtcDataStream

Returns: WebRtcDataStream

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:317

---

getDataStreams

▸ getDataStreams(): WebRtcDataStream[]

Returns: WebRtcDataStream[]

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:11

---

getDeadStreamTimeout

▸ getDeadStreamTimeout(): number

Returns: number

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:329

---

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

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.

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:61

---

getError

▸ getError(): Error

Returns: Error

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:336

---

getExternalId

▸ getExternalId(): string

Returns: string

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:34

---

getGatheringState

▸ getGatheringState(): IceGatheringState

Returns: IceGatheringState

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:350

---

getHasAudio

▸ getHasAudio(): boolean

Returns: boolean

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:357

---

getHasData

▸ getHasData(): boolean

Returns: boolean

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:364

---

getHasVideo

▸ getHasVideo(): boolean

Returns: boolean

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:371

---

getIceConnectionState

▸ getIceConnectionState(): IceConnectionState

Returns: IceConnectionState

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:378

---

getIceGatherPolicy

▸ getIceGatherPolicy(): IceGatherPolicy

Returns: IceGatherPolicy

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:385

---

getIceServer

▸ getIceServer(): IceServer

Returns: IceServer

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:392

---

getIceServers

▸ getIceServers(): IceServer[]

Returns: IceServer[]

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:399

---

getId

▸ getId(): string

Returns: string

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:406

---

getLegacyTimeout

▸ getLegacyTimeout(): boolean

Returns: boolean

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:413

---

getLocalDescription

▸ getLocalDescription(): SessionDescription

Returns: SessionDescription

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:420

---

getMediaProtocol

▸ getMediaProtocol(): MediaProtocol

Returns: MediaProtocol

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:427

---

getReceiverStats

▸ ProtectedgetReceiverStats(streamType: StreamType): MediaReceiverStats

Parameters:

Name	Type
streamType	StreamType

Returns: MediaReceiverStats

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:434

---

getRemoteDescription

▸ getRemoteDescription(): SessionDescription

Returns: SessionDescription

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:464

---

getSenderStats

▸ ProtectedgetSenderStats(streamType: StreamType): MediaSenderStats

Parameters:

Name	Type
streamType	StreamType

Returns: MediaSenderStats

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:471

---

getSignallingState

▸ getSignallingState(): SignallingState

Returns: SignallingState

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:503

---

getState

▸ getState(): ConnectionState

Returns: ConnectionState

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:510

---

getStats

▸ getStats(): Future<ConnectionStats>

Returns: Future<ConnectionStats>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:76

---

getStreams

▸ getStreams(): WebRtcStream[]

Returns: WebRtcStream[]

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:17

---

getTieBreaker

▸ getTieBreaker(): string

Returns: string

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:519

---

getTimeout

▸ getTimeout(): number

Returns: number

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:526

---

getTransportStats

▸ ProtectedgetTransportStats(): TransportStats

Returns: TransportStats

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:533

---

getTrickleIcePolicy

▸ getTrickleIcePolicy(): TrickleIcePolicy

Returns: TrickleIcePolicy

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:545

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:6

---

getVideoEnabledUpdateConnectionPolicy

▸ getVideoEnabledUpdateConnectionPolicy(): IFunction1<number, number>

Returns: IFunction1<number, number>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:44

---

getVideoRetentionPolicy

▸ getVideoRetentionPolicy(): VideoRetentionPolicy

Returns: VideoRetentionPolicy

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:38

---

getVideoStream

▸ getVideoStream(): WebRtcVideoStream

Returns: WebRtcVideoStream

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:552

---

getVideoStreams

▸ getVideoStreams(): WebRtcVideoStream[]

Returns: WebRtcVideoStream[]

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:14

---

getWssManager

▸ getWssManager(): WssManager

Returns: WssManager

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:564

---

isCapableOfReceiving

▸ isCapableOfReceiving(): boolean

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:24

---

isCapableOfSending

▸ isCapableOfSending(): boolean

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:21

---

removeIceServer

▸ removeIceServer(iceServer: IceServer): void

Parameters:

Name	Type
iceServer	IceServer

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:612

---

removeIceServers

▸ removeIceServers(iceServers: IceServer[]): void

Parameters:

Name	Type
iceServers	IceServer[]

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:619

---

removeOnExternalIdChange

▸ removeOnExternalIdChange(value: IAction2<string, string>): void

Parameters:

Name	Type
value	IAction2<string, string>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:626

---

removeOnGatheringStateChange

▸ removeOnGatheringStateChange(value: IAction1<WssWebSocketConnection>): void

Parameters:

Name	Type
value	IAction1<WssWebSocketConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:633

---

removeOnIceConnectionStateChange

▸ removeOnIceConnectionStateChange(value: IAction1<WssWebSocketConnection>): void

Parameters:

Name	Type
value	IAction1<WssWebSocketConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:640

---

removeOnLocalCandidate

▸ removeOnLocalCandidate(value: IAction2<WssWebSocketConnection, Candidate>): void

Parameters:

Name	Type
value	IAction2<WssWebSocketConnection, Candidate>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:647

---

removeOnLocalDescription

▸ removeOnLocalDescription(value: IAction2<WssWebSocketConnection, SessionDescription>): void

Parameters:

Name	Type
value	IAction2<WssWebSocketConnection, SessionDescription>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:654

---

removeOnRemoteCandidate

▸ removeOnRemoteCandidate(value: IAction2<WssWebSocketConnection, Candidate>): void

Parameters:

Name	Type
value	IAction2<WssWebSocketConnection, Candidate>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:661

---

removeOnRemoteDescription

▸ removeOnRemoteDescription(value: IAction2<WssWebSocketConnection, SessionDescription>): void

Parameters:

Name	Type
value	IAction2<WssWebSocketConnection, SessionDescription>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:668

---

removeOnSignallingStateChange

▸ removeOnSignallingStateChange(value: IAction1<WssWebSocketConnection>): void

Parameters:

Name	Type
value	IAction1<WssWebSocketConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:675

---

removeOnStateChange

▸ removeOnStateChange(value: IAction1<WssWebSocketConnection>): void

Parameters:

Name	Type
value	IAction1<WssWebSocketConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:682

---

setBundlePolicy

▸ setBundlePolicy(value: BundlePolicy): void

Parameters:

Name	Type
value	BundlePolicy

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:689

---

setDeadStreamTimeout

▸ setDeadStreamTimeout(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:696

---

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

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:98

---

setError

▸ setError(value: Error): void

Parameters:

Name	Type
value	Error

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:704

---

setExternalId

▸ setExternalId(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:711

---

setIceGatherPolicy

▸ setIceGatherPolicy(value: IceGatherPolicy): void

Parameters:

Name	Type
value	IceGatherPolicy

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:718

---

setIceServer

▸ setIceServer(value: IceServer): void

Parameters:

Name	Type
value	IceServer

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:725

---

setIceServers

▸ setIceServers(value: IceServer[]): void

Parameters:

Name	Type
value	IceServer[]

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:732

---

setLegacyTimeout

▸ setLegacyTimeout(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:747

---

setLocalDescription

▸ setLocalDescription(localDescription: SessionDescription): Future<SessionDescription>

Parameters:

Name	Type
localDescription	SessionDescription

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:754

---

setRemoteDescription

▸ setRemoteDescription(remoteDescription: SessionDescription): Future<SessionDescription>

Parameters:

Name	Type
remoteDescription	SessionDescription

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:761

---

setState

▸ setState(value: ConnectionState): void

Parameters:

Name	Type
value	ConnectionState

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:768

---

setTieBreaker

▸ setTieBreaker(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:825

---

setTimeout

▸ setTimeout(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:832

---

setTrickleIcePolicy

▸ setTrickleIcePolicy(value: TrickleIcePolicy): void

Parameters:

Name	Type
value	TrickleIcePolicy

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:840

---

setVideoEnabledUpdateConnectionPolicy

▸ setVideoEnabledUpdateConnectionPolicy(value: IFunction1<number, number>): void

Parameters:

Name	Type
value	IFunction1<number, number>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:47

---

setVideoRetentionPolicy

▸ setVideoRetentionPolicy(value: VideoRetentionPolicy): void

Parameters:

Name	Type
value	VideoRetentionPolicy

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnection.ts:41

---

streamOverWebSocket

▸ streamOverWebSocket(audioWebSocketStreamId: number, videoWebSocketStreamId: number, videoStreamInfo: MediaStreamInfo): void

Parameters:

Name	Type
audioWebSocketStreamId	number
videoWebSocketStreamId	number
videoStreamInfo	MediaStreamInfo

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:847

---

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.

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:125

---

updateWebSocketConnection

▸ updateWebSocketConnection(config: ConnectionConfig, promise: Promise<Object>): void

Parameters:

Name	Type
config	ConnectionConfig
promise	Promise<Object>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketConnectionBase.ts:950