/ fm / liveswitch / Connection

Class: Connection

fm.liveswitch.Connection

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new Connection(stream: Stream): Connection

Parameters:

Name Type
stream Stream

Returns: Connection

Inherited from: Dynamic

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

+ new Connection(streams: Stream[]): Connection

Parameters:

Name Type
streams Stream[]

Returns: Connection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:36

+ new Connection(streams: Stream[], useWebSocketsForMedia: boolean): Connection

Parameters:

Name Type
streams Stream[]
useWebSocketsForMedia boolean

Returns: Connection

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

Properties

_onExternalIdChangeValues

• Private _onExternalIdChangeValues: IAction2<string, string>[]

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:31

Methods

addIceServer

▸ addIceServer(iceServer: IceServer): void

Parameters:

Name Type
iceServer IceServer

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:183

addIceServers

▸ addIceServers(iceServers: IceServer[]): void

Parameters:

Name Type
iceServers IceServer[]

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:187

addOnExternalIdChange

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

Parameters:

Name Type
value IAction2<string, string>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:416

addOnGatheringStateChange

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

Parameters:

Name Type
value IAction1<Connection>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:191

addOnIceConnectionStateChange

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

Parameters:

Name Type
value IAction1<Connection>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:194

addOnLocalCandidate

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

Parameters:

Name Type
value IAction2<Connection, Candidate>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:197

addOnLocalDescription

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

Parameters:

Name Type
value IAction2<Connection, SessionDescription>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:201

addOnRemoteCandidate

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

Parameters:

Name Type
value IAction2<Connection, Candidate>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:205

addOnRemoteDescription

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

Parameters:

Name Type
value IAction2<Connection, SessionDescription>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:209

addOnSignallingStateChange

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

Parameters:

Name Type
value IAction1<Connection>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:213

addOnStateChange

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

Parameters:

Name Type
value IAction1<Connection>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:217

addRemoteCandidate

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

Parameters:

Name Type
remoteCandidate Candidate

Returns: Future<Candidate>

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:221

addToWebSocketConnection

▸ addToWebSocketConnection(openArgs: WssServiceOpenArgs): void

Parameters:

Name Type
openArgs WssServiceOpenArgs

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:175

close

▸ close(): boolean

Returns: boolean

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:225

createAnswer

▸ createAnswer(): Future<SessionDescription>

Returns: Future<SessionDescription>

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:229

createOffer

▸ createOffer(): Future<SessionDescription>

Returns: Future<SessionDescription>

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:233

externalToInternal

▸ PrivateexternalToInternal(external: IExternalStream): IInternalStream

Parameters:

Name Type
external IExternalStream

Returns: IInternalStream

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:490

externalsToInternals

▸ PrivateexternalsToInternals(externals: IExternalStream[]): IInternalStream[]

Parameters:

Name Type
externals IExternalStream[]

Returns: IInternalStream[]

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:484

getAudioStream

▸ getAudioStream(): AudioStream

Returns: AudioStream

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:333

getAudioStreams

▸ getAudioStreams(): AudioStream[]

Returns: AudioStream[]

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:337

getBundlePolicy

▸ getBundlePolicy(): BundlePolicy

Returns: BundlePolicy

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:249

getCanonicalName

▸ getCanonicalName(): string

Returns: string

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:277

getDataStream

▸ getDataStream(): DataStream

Returns: DataStream

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:349

getDataStreams

▸ getDataStreams(): DataStream[]

Returns: DataStream[]

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:353

getDeadStreamTimeout

▸ getDeadStreamTimeout(): number

Returns: number

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:237

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

Returns: Error

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:241

getExternalId

▸ getExternalId(): string

Returns: string

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:245

getGatheringState

▸ getGatheringState(): IceGatheringState

Returns: IceGatheringState

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:261

getHasAudio

▸ getHasAudio(): boolean

Returns: boolean

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:321

getHasData

▸ getHasData(): boolean

Returns: boolean

Implementation of: IExternalConnection

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

getHasVideo

▸ getHasVideo(): boolean

Returns: boolean

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:325

getIceConnectionState

▸ getIceConnectionState(): IceConnectionState

Returns: IceConnectionState

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:265

getIceGatherPolicy

▸ getIceGatherPolicy(): IceGatherPolicy

Returns: IceGatherPolicy

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:253

getIceServer

▸ getIceServer(): IceServer

Returns: IceServer

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:257

getIceServers

▸ getIceServers(): IceServer[]

Returns: IceServer[]

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:269

getId

▸ getId(): string

Returns: string

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:273

getLegacyTimeout

▸ getLegacyTimeout(): boolean

Returns: boolean

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:309

getLocalDescription

▸ getLocalDescription(): SessionDescription

Returns: SessionDescription

Implementation of: IExternalConnection

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

getMediaProtocol

▸ getMediaProtocol(): MediaProtocol

Returns: MediaProtocol

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:171

getRemoteDescription

▸ getRemoteDescription(): SessionDescription

Returns: SessionDescription

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:285

getRemoteMedia

▸ getRemoteMedia(): RemoteMedia

Returns: RemoteMedia

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:479

getSignallingState

▸ getSignallingState(): SignallingState

Returns: SignallingState

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:289

getState

▸ getState(): ConnectionState

Returns: ConnectionState

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:293

getStats

▸ getStats(): Future<ConnectionStats>

Returns: Future<ConnectionStats>

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:297

getStreams

▸ getStreams(): Stream[]

Returns: Stream[]

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:301

getTieBreaker

▸ getTieBreaker(): string

Returns: string

Implementation of: IExternalConnection

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

getTimeout

▸ getTimeout(): number

Returns: number

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:313

getTrickleIcePolicy

▸ getTrickleIcePolicy(): TrickleIcePolicy

Returns: TrickleIcePolicy

Implementation of: IExternalConnection

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

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:4

getVideoEnabledUpdateConnectionPolicy

▸ getVideoEnabledUpdateConnectionPolicy(): IFunction1<number, number>

Returns: IFunction1<number, number>

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:361

getVideoRetentionPolicy

▸ getVideoRetentionPolicy(): VideoRetentionPolicy

Returns: VideoRetentionPolicy

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

getVideoStream

▸ getVideoStream(): VideoStream

Returns: VideoStream

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:341

getVideoStreams

▸ getVideoStreams(): VideoStream[]

Returns: VideoStream[]

Implementation of: IExternalConnection

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

internalToExternal

▸ PrivateinternalToExternal(internal: IInternalStream): IExternalStream

Parameters:

Name Type
internal IInternalStream

Returns: IExternalStream

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:500

internalsToExternals

▸ PrivateinternalsToExternals(internals: IInternalStream[]): IExternalStream[]

Parameters:

Name Type
internals IInternalStream[]

Returns: IExternalStream[]

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

removeIceServer

▸ removeIceServer(iceServer: IceServer): void

Parameters:

Name Type
iceServer IceServer

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:365

removeIceServers

▸ removeIceServers(iceServers: IceServer[]): void

Parameters:

Name Type
iceServers IceServer[]

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:369

removeOnExternalIdChange

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

Parameters:

Name Type
value IAction2<string, string>

Returns: void

Implementation of: IExternalConnection

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

removeOnGatheringStateChange

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

Parameters:

Name Type
value IAction1<Connection>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:373

removeOnIceConnectionStateChange

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

Parameters:

Name Type
value IAction1<Connection>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:376

removeOnLocalCandidate

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

Parameters:

Name Type
value IAction2<Connection, Candidate>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:380

removeOnLocalDescription

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

Parameters:

Name Type
value IAction2<Connection, SessionDescription>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:384

removeOnRemoteCandidate

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

Parameters:

Name Type
value IAction2<Connection, Candidate>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:388

removeOnRemoteDescription

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

Parameters:

Name Type
value IAction2<Connection, SessionDescription>

Returns: void

Implementation of: IExternalConnection

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

removeOnSignallingStateChange

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

Parameters:

Name Type
value IAction1<Connection>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:396

removeOnStateChange

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

Parameters:

Name Type
value IAction1<Connection>

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:400

setBundlePolicy

▸ setBundlePolicy(value: BundlePolicy): void

Parameters:

Name Type
value BundlePolicy

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:424

setDeadStreamTimeout

▸ setDeadStreamTimeout(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:404

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

Parameters:

Name Type
value Error

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:412

setExternalId

▸ setExternalId(value: string): void

Parameters:

Name Type
value string

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:408

setIceGatherPolicy

▸ setIceGatherPolicy(value: IceGatherPolicy): void

Parameters:

Name Type
value IceGatherPolicy

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:428

setIceServer

▸ setIceServer(value: IceServer): void

Parameters:

Name Type
value IceServer

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:432

setIceServers

▸ setIceServers(value: IceServer[]): void

Parameters:

Name Type
value IceServer[]

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:436

setLegacyTimeout

▸ setLegacyTimeout(legacyTimeout: boolean): void

Parameters:

Name Type
legacyTimeout boolean

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:444

setLocalDescription

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

Parameters:

Name Type
localDescription SessionDescription

Returns: Future<SessionDescription>

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:440

setRemoteDescription

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

Parameters:

Name Type
remoteDescription SessionDescription

Returns: Future<SessionDescription>

Implementation of: IExternalConnection

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

setState

▸ setState(state: ConnectionState, error: Error): void

Parameters:

Name Type
state ConnectionState
error Error

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:452

setTieBreaker

▸ setTieBreaker(value: string): void

Parameters:

Name Type
value string

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:467

setTimeout

▸ setTimeout(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:459

setTrickleIcePolicy

▸ setTrickleIcePolicy(value: TrickleIcePolicy): void

Parameters:

Name Type
value TrickleIcePolicy

Returns: void

Implementation of: IExternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:463

setVideoEnabledUpdateConnectionPolicy

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

Parameters:

Name Type
value IFunction1<number, number>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Connection.ts:475

setVideoRetentionPolicy

▸ setVideoRetentionPolicy(value: VideoRetentionPolicy): void

Parameters:

Name Type
value VideoRetentionPolicy

Returns: void

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

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

updateWebSocketConnection

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

Parameters:

Name Type
config ConnectionConfig
promise Promise<object>

Returns: void

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