/ fm / liveswitch / WssWebSocketConnection

Class: WssWebSocketConnection

fm.liveswitch.WssWebSocketConnection

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

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

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

_logContext

• Private _logContext: LogContext

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

Methods

_getExternal

▸ _getExternal(): IExternalConnection

Returns: IExternalConnection

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

addIceServer

▸ addIceServer(iceServer: IceServer): void

Parameters:

Name Type
iceServer IceServer

Returns: void

Implementation of: IInternalConnection

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

addIceServers

▸ addIceServers(iceServers: IceServer[]): void

Parameters:

Name Type
iceServers IceServer[]

Returns: void

Implementation of: IInternalConnection

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

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

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

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

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

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

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

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

addOnRoundTripTime

▸ addOnRoundTripTime(value: IAction1<number>): void

Parameters:

Name Type
value IAction1<number>

Returns: void

Implementation of: IInternalConnection

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

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

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

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

addToWebSocketConnection

▸ addToWebSocketConnection(openArgs: WssServiceOpenArgs): void

Parameters:

Name Type
openArgs WssServiceOpenArgs

Returns: void

Implementation of: IInternalConnection

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

close

▸ close(): boolean

Returns: boolean

Implementation of: IInternalConnection

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

constraintMax

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

Parameters:

Name Type
num1 number
num2 number

Returns: number

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

constraintMin

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

Parameters:

Name Type
num1 number
num2 number

Returns: number

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

createAnswer

▸ createAnswer(): Future<SessionDescription>

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

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

createOffer

▸ createOffer(): Future<SessionDescription>

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

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

createWebSocket

▸ ProtectedcreateWebSocket(url: string): IWebSocket

Parameters:

Name Type
url string

Returns: IWebSocket

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

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

getAudioStream

▸ getAudioStream(): WebRtcAudioStream

Returns: WebRtcAudioStream

Implementation of: IInternalConnection

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

getAudioStreams

▸ getAudioStreams(): WebRtcAudioStream[]

Returns: WebRtcAudioStream[]

Implementation of: IInternalConnection

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

getBundlePolicy

▸ getBundlePolicy(): BundlePolicy

Returns: BundlePolicy

Implementation of: IInternalConnection

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

getCanonicalName

▸ getCanonicalName(): string

Returns: string

Implementation of: IInternalConnection

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

getDataStream

▸ getDataStream(): WebRtcDataStream

Returns: WebRtcDataStream

Implementation of: IInternalConnection

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

getDataStreams

▸ getDataStreams(): WebRtcDataStream[]

Returns: WebRtcDataStream[]

Implementation of: IInternalConnection

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

getDeadStreamTimeout

▸ getDeadStreamTimeout(): number

Returns: number

Implementation of: IInternalConnection

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

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

getExternalId

▸ getExternalId(): string

Returns: string

Implementation of: IInternalConnection

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

getGatheringState

▸ getGatheringState(): IceGatheringState

Returns: IceGatheringState

Implementation of: IInternalConnection

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

getHasAudio

▸ getHasAudio(): boolean

Returns: boolean

Implementation of: IInternalConnection

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

getHasData

▸ getHasData(): boolean

Returns: boolean

Implementation of: IInternalConnection

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

getHasVideo

▸ getHasVideo(): boolean

Returns: boolean

Implementation of: IInternalConnection

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

getIceConnectionState

▸ getIceConnectionState(): IceConnectionState

Returns: IceConnectionState

Implementation of: IInternalConnection

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

getIceGatherPolicy

▸ getIceGatherPolicy(): IceGatherPolicy

Returns: IceGatherPolicy

Implementation of: IInternalConnection

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

getIceServer

▸ getIceServer(): IceServer

Returns: IceServer

Implementation of: IInternalConnection

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

getIceServers

▸ getIceServers(): IceServer[]

Returns: IceServer[]

Implementation of: IInternalConnection

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

getId

▸ getId(): string

Returns: string

Implementation of: IInternalConnection

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

getLegacyTimeout

▸ getLegacyTimeout(): boolean

Returns: boolean

Implementation of: IInternalConnection

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

getLocalDescription

▸ getLocalDescription(): SessionDescription

Returns: SessionDescription

Implementation of: IInternalConnection

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

getMediaProtocol

▸ getMediaProtocol(): MediaProtocol

Returns: MediaProtocol

Implementation of: IInternalConnection

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

getReceiverStats

▸ ProtectedgetReceiverStats(streamType: StreamType): Future<MediaReceiverStats>

Parameters:

Name Type
streamType StreamType

Returns: Future<MediaReceiverStats>

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

getRemoteDescription

▸ getRemoteDescription(): SessionDescription

Returns: SessionDescription

Implementation of: IInternalConnection

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

getSenderStats

▸ ProtectedgetSenderStats(streamType: StreamType): MediaSenderStats

Parameters:

Name Type
streamType StreamType

Returns: MediaSenderStats

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

getSignallingState

▸ getSignallingState(): SignallingState

Returns: SignallingState

Implementation of: IInternalConnection

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

getState

▸ getState(): ConnectionState

Returns: ConnectionState

Implementation of: IInternalConnection

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

getStats

▸ getStats(): Future<ConnectionStats>

Returns: Future<ConnectionStats>

Implementation of: IInternalConnection

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

getStreams

▸ getStreams(): WebRtcStream[]

Returns: WebRtcStream[]

Implementation of: IInternalConnection

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

getTieBreaker

▸ getTieBreaker(): string

Returns: string

Implementation of: IInternalConnection

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

getTimeout

▸ getTimeout(): number

Returns: number

Implementation of: IInternalConnection

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

getTransportStats

▸ ProtectedgetTransportStats(): TransportStats

Returns: TransportStats

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

getTrickleIcePolicy

▸ getTrickleIcePolicy(): TrickleIcePolicy

Returns: TrickleIcePolicy

Implementation of: IInternalConnection

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

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

getVideoRetentionPolicy

▸ getVideoRetentionPolicy(): VideoRetentionPolicy

Returns: VideoRetentionPolicy

Implementation of: IInternalConnection

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

getVideoStream

▸ getVideoStream(): WebRtcVideoStream

Returns: WebRtcVideoStream

Implementation of: IInternalConnection

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

getVideoStreams

▸ getVideoStreams(): WebRtcVideoStream[]

Returns: WebRtcVideoStream[]

Implementation of: IInternalConnection

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

getWssManager

▸ getWssManager(): WssManager

Returns: WssManager

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

isCapableOfReceiving

▸ isCapableOfReceiving(): boolean

Returns: boolean

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

isCapableOfSending

▸ isCapableOfSending(): boolean

Returns: boolean

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

removeIceServer

▸ removeIceServer(iceServer: IceServer): void

Parameters:

Name Type
iceServer IceServer

Returns: void

Implementation of: IInternalConnection

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

removeIceServers

▸ removeIceServers(iceServers: IceServer[]): void

Parameters:

Name Type
iceServers IceServer[]

Returns: void

Implementation of: IInternalConnection

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

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

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

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

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

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

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

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

removeOnRoundTripTime

▸ removeOnRoundTripTime(value: IAction1<number>): void

Parameters:

Name Type
value IAction1<number>

Returns: void

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

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

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

setBundlePolicy

▸ setBundlePolicy(value: BundlePolicy): void

Parameters:

Name Type
value BundlePolicy

Returns: void

Implementation of: IInternalConnection

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

setDeadStreamTimeout

▸ setDeadStreamTimeout(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IInternalConnection

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

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

setExternalId

▸ setExternalId(value: string): void

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalConnection

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

setIceGatherPolicy

▸ setIceGatherPolicy(value: IceGatherPolicy): void

Parameters:

Name Type
value IceGatherPolicy

Returns: void

Implementation of: IInternalConnection

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

setIceServer

▸ setIceServer(value: IceServer): void

Parameters:

Name Type
value IceServer

Returns: void

Implementation of: IInternalConnection

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

setIceServers

▸ setIceServers(value: IceServer[]): void

Parameters:

Name Type
value IceServer[]

Returns: void

Implementation of: IInternalConnection

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

setLegacyTimeout

▸ setLegacyTimeout(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalConnection

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

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

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

setState

▸ setState(value: ConnectionState): void

Parameters:

Name Type
value ConnectionState

Returns: void

Implementation of: IInternalConnection

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

setTieBreaker

▸ setTieBreaker(value: string): void

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalConnection

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

setTimeout

▸ setTimeout(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IInternalConnection

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

setTrickleIcePolicy

▸ setTrickleIcePolicy(value: TrickleIcePolicy): void

Parameters:

Name Type
value TrickleIcePolicy

Returns: void

Implementation of: IInternalConnection

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

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

setVideoRetentionPolicy

▸ setVideoRetentionPolicy(value: VideoRetentionPolicy): void

Parameters:

Name Type
value VideoRetentionPolicy

Returns: void

Implementation of: IInternalConnection

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

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

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

updateLogContext

▸ updateLogContext(value: LogContext): void

Parameters:

Name Type
value LogContext

Returns: void

Implementation of: IInternalConnection

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

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