/ fm / liveswitch / ServerConnection

Class: ServerConnection

fm.liveswitch.ServerConnection

A server connection.

Hierarchy

Table of contents

Methods

Methods

addOnAutomaticIceServers

▸ addOnAutomaticIceServers(value: IAction2<ManagedConnection, IceServerCollection>): void

Adds a handler that is raised when automatic ICE servers have been received. Parameters: - connection - the connection - automaticIceServers - the automatic ICE severs collection

Parameters:

Name Type
value IAction2<ManagedConnection, IceServerCollection>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:308

addOnGatheringStateChange

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

Adds a handler that is raised when the ICE gathering state changes. Parameters: - connection - the connection

Parameters:

Name Type
value IAction1<ManagedConnection>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:318

addOnIceConnectionStateChange

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

Adds a handler that is raised when the ICE connection state changes. Parameters: - connection - the connection

Parameters:

Name Type
value IAction1<ManagedConnection>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:328

addOnInboundAudioBitrateChange

▸ addOnInboundAudioBitrateChange(value: IAction2<number, number>): void

Adds a handler that is raised when the inbound audio bitrate changes.

Parameters:

Name Type
value IAction2<number, number>

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:100

addOnInboundVideoBitrateChange

▸ addOnInboundVideoBitrateChange(value: IAction2<number, number>): void

Adds a handler that is raised when the inbound video bitrate changes.

Parameters:

Name Type
value IAction2<number, number>

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:110

addOnLocalCandidate

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

Adds a handler that is raised when a local candidate is ready. Parameters: - connection - the connection - candidate - the local candidate

Parameters:

Name Type
value IAction2<ManagedConnection, Candidate>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:338

addOnLocalDescription

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

Adds a handler that is raised when the local description is ready. Parameters: - connection - the connection - description - the local description

Parameters:

Name Type
value IAction2<ManagedConnection, SessionDescription>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:348

addOnNoMediaServersAvailable

▸ addOnNoMediaServersAvailable(value: IAction2<ManagedConnection, NoMediaServersAvailableEventArgs>): void

Adds a handler that is raised when there are no Media Servers available.

Parameters:

Name Type
value IAction2<ManagedConnection, NoMediaServersAvailableEventArgs>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:358

addOnRemoteAudioEncodingSwitch

▸ addOnRemoteAudioEncodingSwitch(value: IAction2<EncodingInfo, EncodingInfo>): void

Adds a handler that is raised when the remote audio encoding is switched by the server.

Parameters:

Name Type
value IAction2<EncodingInfo, EncodingInfo>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:368

addOnRemoteCandidate

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

Adds a handler that is raised when a remote candidate is ready. Parameters: - connection - the connection - candidate - the remote candidate

Parameters:

Name Type
value IAction2<ManagedConnection, Candidate>

Returns: void

Inherited from: ManagedConnection

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

addOnRemoteDescription

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

Adds a handler that is raised when the remote description is ready. Parameters: - connection - the connection - description - the remote description

Parameters:

Name Type
value IAction2<ManagedConnection, SessionDescription>

Returns: void

Inherited from: ManagedConnection

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

addOnRemoteUpdate

▸ addOnRemoteUpdate(value: IAction2<ConnectionInfo, ConnectionInfo>): void

Adds a handler that is raised when a remote connection has been updated.

Parameters:

Name Type
value IAction2<ConnectionInfo, ConnectionInfo>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:398

addOnRemoteVideoEncodingSwitch

▸ addOnRemoteVideoEncodingSwitch(value: IAction2<EncodingInfo, EncodingInfo>): void

Adds a handler that is raised when the remote video encoding is switched by the server.

Parameters:

Name Type
value IAction2<EncodingInfo, EncodingInfo>

Returns: void

Inherited from: ManagedConnection

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

addOnSignallingStateChange

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

Adds a handler that is raised when the signalling state changes. Parameters: - connection - the connection

Parameters:

Name Type
value IAction1<ManagedConnection>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:418

addOnStateChange

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

Adds a handler that is raised when the connection state changes. Parameters: - connection - the connection

Parameters:

Name Type
value IAction1<ManagedConnection>

Returns: void

Inherited from: ManagedConnection

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

close

▸ close(): Future<Object>

Closes the connection.

Returns: Future<Object>

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:454

detachInternalEventHandlers

▸ ProtecteddetachInternalEventHandlers(): void

Detaches internal event handlers.

Returns: void

Overrides: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:120

doCreateCandidateMessage

▸ ProtecteddoCreateCandidateMessage(candidate: Candidate): Message

Creates a candidate message.

Parameters:

Name Type Description
candidate Candidate The candidate.

Returns: Message

Overrides: ManagedConnection

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

doCreateCloseMessage

▸ ProtecteddoCreateCloseMessage(): Message

Creates a close message.

Returns: Message

Overrides: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:147

doCreateOfferMessage

▸ Protected AbstractdoCreateOfferMessage(offer: SessionDescription): Message

Creates an offer message.

Parameters:

Name Type Description
offer SessionDescription The offer.

Returns: Message

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

doCreateUpdateMessage

▸ ProtecteddoCreateUpdateMessage(config: ConnectionConfig): Message

Creates an update message.

Parameters:

Name Type Description
config ConnectionConfig The connection config.

Returns: Message

Inherited from: ManagedConnection

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

doOpen

▸ ProtecteddoOpen(): void

Opens the connection.

Returns: void

Overrides: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:162

doProcessMessage

▸ ProtecteddoProcessMessage(message: Message): void

Processes a message.

Parameters:

Name Type Description
message Message The message.

Returns: void

Overrides: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:188

fmliveswitchServerConnectionInit

▸ PrivatefmliveswitchServerConnectionInit(): void

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:48

getApplicationId

▸ getApplicationId(): string

Gets the application identifier.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:757

getAudioDirection

▸ getAudioDirection(): string

Gets thes audio direction. Null if disabled.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:767

getAudioStream

▸ getAudioStream(): AudioStream

Gets the audio stream.

Returns: AudioStream

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:777

getBundlePolicy

▸ getBundlePolicy(): BundlePolicy

Gets the Bundle Policy.

Returns: BundlePolicy

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:787

getCanonicalName

▸ getCanonicalName(): string

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

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:797

getChannelId

▸ getChannelId(): string

Gets the channel identifier.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:807

getClientId

▸ getClientId(): string

Gets the client identifier.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:817

getConfig

▸ getConfig(): ConnectionConfig

Gets the current configuration.

Returns: ConnectionConfig

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:827

getDataDirection

▸ getDataDirection(): string

Gets the data direction. Null if disabled.

Returns: string

Inherited from: ManagedConnection

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

getDataStream

▸ getDataStream(): DataStream

Gets the data stream.

Returns: DataStream

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:857

getDeviceId

▸ getDeviceId(): string

Gets the device identifier.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:867

getDisableAutomaticIceServers

▸ getDisableAutomaticIceServers(): boolean

Gets whether to disable automatic ICE servers (embedded TURN).

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:877

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: ManagedConnection

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

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

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

getError

▸ getError(): Error

Gets the error, if an error exists.

Returns: Error

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:887

getExternalId

▸ getExternalId(): string

Gets the external connection identifier.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:897

getGatheringState

▸ getGatheringState(): IceGatheringState

Gets the state of the ice gathering.

Returns: IceGatheringState

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:907

getHasAudio

▸ getHasAudio(): boolean

Gets whether this connection has an audio stream.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:917

getHasData

▸ getHasData(): boolean

Gets whether this connection has a data stream.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:927

getHasVideo

▸ getHasVideo(): boolean

Gets whether this connection has a video stream.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:937

getIceConnectionState

▸ getIceConnectionState(): IceConnectionState

Gets the state of the ice connection.

Returns: IceConnectionState

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:947

getIceGatherPolicy

▸ getIceGatherPolicy(): IceGatherPolicy

Gets the ICE gather policy.

Returns: IceGatherPolicy

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:957

getIceServer

▸ getIceServer(): IceServer

Gets the ICE server.

Returns: IceServer

Inherited from: ManagedConnection

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

getIceServers

▸ getIceServers(): IceServer[]

Gets the ICE servers.

Returns: IceServer[]

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:977

getId

▸ getId(): string

Gets the connection identifier.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:987

getInboundAudioBitrate

▸ getInboundAudioBitrate(): number

Gets the current inbound audio bitrate.

Returns: number

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

getInboundVideoBitrate

▸ getInboundVideoBitrate(): number

Gets the current inbound video bitrate.

Returns: number

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:210

getInfo

▸ getInfo(): ConnectionInfo

Gets the connection info.

Returns: ConnectionInfo

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:997

getLocalAudioDisabled

▸ getLocalAudioDisabled(): boolean

Gets if local audio is disabled.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1054

getLocalAudioFormats

▸ getLocalAudioFormats(): FormatInfo[]

Gets the local audio formats.

Returns: FormatInfo[]

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1064

getLocalAudioMuted

▸ getLocalAudioMuted(): boolean

Gets whether the local audio is muted.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1074

getLocalDataDisabled

▸ getLocalDataDisabled(): boolean

Gets if local data is disabled.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1087

getLocalDescription

▸ getLocalDescription(): SessionDescription

Gets the local description.

Returns: SessionDescription

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1097

getLocalVideoDisabled

▸ getLocalVideoDisabled(): boolean

Gets if local video is disabled.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1107

getLocalVideoFormats

▸ getLocalVideoFormats(): FormatInfo[]

Gets the local video formats.

Returns: FormatInfo[]

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1117

getLocalVideoMuted

▸ getLocalVideoMuted(): boolean

Gets whether the local video is muted.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1127

getMediaId

▸ getMediaId(): string

Gets the media identifier.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1140

getMediaServerId

▸ getMediaServerId(): string

Gets the identifier of the Media Server handling this connection.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:220

getNoMediaServerTimeout

▸ getNoMediaServerTimeout(): number

Gets the timeout in milliseconds on retries for cases where no Media Servers are available for either CE servers or SFU/MCU offer processing.

Returns: number

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1150

getPreferredMediaServerId

▸ getPreferredMediaServerId(): string

Gets the preferred identifier of the Media Server to handle this connection.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:230

getRemoteAudioDisabled

▸ getRemoteAudioDisabled(): boolean

Gets if remote audio is disabled.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1160

getRemoteAudioEncoding

▸ getRemoteAudioEncoding(): EncodingInfo

Gets the remote audio encoding.

Returns: EncodingInfo

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1170

getRemoteAudioFormats

▸ getRemoteAudioFormats(): FormatInfo[]

Gets the remote audio formats.

Returns: FormatInfo[]

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1180

getRemoteAudioMuted

▸ getRemoteAudioMuted(): boolean

Gets whether the remote audio is muted.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1190

getRemoteClosed

▸ getRemoteClosed(): boolean

Gets a value indicating whether the connection was closed by the remote host.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1203

getRemoteConnectionId

▸ getRemoteConnectionId(): string

Gets the remote connection identifier, if available.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1213

getRemoteDataDisabled

▸ getRemoteDataDisabled(): boolean

Gets if remote data is disabled.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1223

getRemoteDescription

▸ getRemoteDescription(): SessionDescription

Gets the remote description.

Returns: SessionDescription

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1233

getRemoteMediaId

▸ getRemoteMediaId(): string

Gets the remote media identifier, if available.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1251

getRemoteRejected

▸ getRemoteRejected(): boolean

Gets a value indicating whether the connection was rejected by the remote host.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1261

getRemoteTag

▸ getRemoteTag(): string

Gets the remote tag, if applicable.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1271

getRemoteVideoDisabled

▸ getRemoteVideoDisabled(): boolean

Gets if remote video is disabled.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1281

getRemoteVideoEncoding

▸ getRemoteVideoEncoding(): EncodingInfo

Gets the remote video encoding.

Returns: EncodingInfo

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1291

getRemoteVideoFormats

▸ getRemoteVideoFormats(): FormatInfo[]

Gets the remote video formats.

Returns: FormatInfo[]

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1301

getRemoteVideoMuted

▸ getRemoteVideoMuted(): boolean

Gets whether the remote video is muted.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1311

getSignallingState

▸ getSignallingState(): SignallingState

Gets the state of the signalling.

Returns: SignallingState

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1324

getState

▸ getState(): ConnectionState

Gets the state of the connection.

Returns: ConnectionState

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1334

getStats

▸ getStats(): Future<ConnectionStats>

Gets the current connection stats.

Returns: Future<ConnectionStats>

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1356

getStatsInterval

▸ getStatsInterval(): number

Gets the stats interval in milliseconds. The default value is 10,000 (10 seconds).

Returns: number

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1366

getTag

▸ getTag(): string

Gets the tag.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1376

getTrickleIcePolicy

▸ getTrickleIcePolicy(): TrickleIcePolicy

Gets the trickle-ICE policy.

Returns: TrickleIcePolicy

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1423

getType

▸ getType(): string

Gets the connection type.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1433

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: ManagedConnection

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

getUserId

▸ getUserId(): string

Gets the user identifier.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1443

getVideoDirection

▸ getVideoDirection(): string

Gets the video direction. Null if disabled.

Returns: string

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1453

getVideoStream

▸ getVideoStream(): VideoStream

Gets the video stream.

Returns: VideoStream

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1463

isMediaDirectionAllowed

▸ Protected AbstractisMediaDirectionAllowed(direction: string): boolean

Gets a value indicating whether the given direction is allowed for this connection.

Parameters:

Name Type Description
direction string The direction.

Returns: boolean

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1474

open

▸ open(): Future<Object>

Opens the connection.

Returns: Future<Object>

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1603

processAnswer

▸ ProtectedprocessAnswer(message: Message): void

Processes an answer.

Parameters:

Name Type Description
message Message The message.

Returns: void

Overrides: ManagedConnection

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

processError

▸ ProtectedprocessError(message: Message): void

Processes an error message.

Parameters:

Name Type Description
message Message The message.

Returns: void

Overrides: ManagedConnection

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

processIceServers

▸ ProtectedprocessIceServers(message: Message): void

Processes an iceServers message.

Parameters:

Name Type Description
message Message The message.

Returns: void

Overrides: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:304

processLocalError

▸ ProtectedprocessLocalError(error: Error): void

Processes a local failure.

Parameters:

Name Type Description
error Error The error.

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1816

raiseAudioBitrateNotification

▸ ProtectedraiseAudioBitrateNotification(audioStream: AudioStream, bitrateNotification: BitrateNotification): void

Raises an audio bitrate notification.

Parameters:

Name Type Description
audioStream AudioStream The audio stream.
bitrateNotification BitrateNotification The bitrate notification.

Returns: void

Overrides: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:338

raiseAudioBitrateRequest

▸ ProtectedraiseAudioBitrateRequest(audioStream: AudioStream, bitrateRequest: BitrateRequest): void

Raises an audio bitrate request.

Parameters:

Name Type Description
audioStream AudioStream The audio stream.
bitrateRequest BitrateRequest The bitrate request.

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1941

raiseLocalCandidate

▸ ProtectedraiseLocalCandidate(localCandidate: Candidate): void

Raises a local candidate.

Parameters:

Name Type Description
localCandidate Candidate The local candidate.

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1952

raiseNoMediaServersAvailable

▸ ProtectedraiseNoMediaServersAvailable(args: NoMediaServersAvailableEventArgs): void

Raises the OnNoMediaServersAvailable event.

Parameters:

Name Type
args NoMediaServersAvailableEventArgs

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1968

raiseRemoteCandidate

▸ ProtectedraiseRemoteCandidate(remoteCandidate: Candidate): void

Raises a remote candidate.

Parameters:

Name Type Description
remoteCandidate Candidate The remote candidate.

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1982

raiseVideoBitrateNotification

▸ ProtectedraiseVideoBitrateNotification(videoStream: VideoStream, bitrateNotification: BitrateNotification): void

Raises a video bitrate notification.

Parameters:

Name Type Description
videoStream VideoStream The video stream.
bitrateNotification BitrateNotification The bitrate notification.

Returns: void

Overrides: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:355

raiseVideoBitrateRequest

▸ ProtectedraiseVideoBitrateRequest(videoStream: VideoStream, bitrateRequest: BitrateRequest): void

Raises a video bitrate request.

Parameters:

Name Type Description
videoStream VideoStream The video stream.
bitrateRequest BitrateRequest The bitrate request.

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2020

removeOnAutomaticIceServers

▸ removeOnAutomaticIceServers(value: IAction2<ManagedConnection, IceServerCollection>): void

Removes a handler that is raised when automatic ICE servers have been received. Parameters: - connection - the connection - automaticIceServers - the automatic ICE severs collection

Parameters:

Name Type
value IAction2<ManagedConnection, IceServerCollection>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2030

removeOnGatheringStateChange

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

Removes a handler that is raised when the ICE gathering state changes. Parameters: - connection - the connection

Parameters:

Name Type
value IAction1<ManagedConnection>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2040

removeOnIceConnectionStateChange

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

Removes a handler that is raised when the ICE connection state changes. Parameters: - connection - the connection

Parameters:

Name Type
value IAction1<ManagedConnection>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2050

removeOnInboundAudioBitrateChange

▸ removeOnInboundAudioBitrateChange(value: IAction2<number, number>): void

Removes a handler that is raised when the inbound audio bitrate changes.

Parameters:

Name Type
value IAction2<number, number>

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:381

removeOnInboundVideoBitrateChange

▸ removeOnInboundVideoBitrateChange(value: IAction2<number, number>): void

Removes a handler that is raised when the inbound video bitrate changes.

Parameters:

Name Type
value IAction2<number, number>

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/ServerConnection.ts:391

removeOnLocalCandidate

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

Removes a handler that is raised when a local candidate is ready. Parameters: - connection - the connection - candidate - the local candidate

Parameters:

Name Type
value IAction2<ManagedConnection, Candidate>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2060

removeOnLocalDescription

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

Removes a handler that is raised when the local description is ready. Parameters: - connection - the connection - description - the local description

Parameters:

Name Type
value IAction2<ManagedConnection, SessionDescription>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2070

removeOnNoMediaServersAvailable

▸ removeOnNoMediaServersAvailable(value: IAction2<ManagedConnection, NoMediaServersAvailableEventArgs>): void

Removes a handler that is raised when there are no Media Servers available.

Parameters:

Name Type
value IAction2<ManagedConnection, NoMediaServersAvailableEventArgs>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2080

removeOnRemoteAudioEncodingSwitch

▸ removeOnRemoteAudioEncodingSwitch(value: IAction2<EncodingInfo, EncodingInfo>): void

Removes a handler that is raised when the remote audio encoding is switched by the server.

Parameters:

Name Type
value IAction2<EncodingInfo, EncodingInfo>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2090

removeOnRemoteCandidate

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

Removes a handler that is raised when a remote candidate is ready. Parameters: - connection - the connection - candidate - the remote candidate

Parameters:

Name Type
value IAction2<ManagedConnection, Candidate>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2100

removeOnRemoteDescription

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

Removes a handler that is raised when the remote description is ready. Parameters: - connection - the connection - description - the remote description

Parameters:

Name Type
value IAction2<ManagedConnection, SessionDescription>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2110

removeOnRemoteUpdate

▸ removeOnRemoteUpdate(value: IAction2<ConnectionInfo, ConnectionInfo>): void

Removes a handler that is raised when a remote connection has been updated.

Parameters:

Name Type
value IAction2<ConnectionInfo, ConnectionInfo>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2120

removeOnRemoteVideoEncodingSwitch

▸ removeOnRemoteVideoEncodingSwitch(value: IAction2<EncodingInfo, EncodingInfo>): void

Removes a handler that is raised when the remote video encoding is switched by the server.

Parameters:

Name Type
value IAction2<EncodingInfo, EncodingInfo>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2130

removeOnSignallingStateChange

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

Removes a handler that is raised when the signalling state changes. Parameters: - connection - the connection

Parameters:

Name Type
value IAction1<ManagedConnection>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2140

removeOnStateChange

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

Removes a handler that is raised when the connection state changes. Parameters: - connection - the connection

Parameters:

Name Type
value IAction1<ManagedConnection>

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2150

send

▸ Protectedsend(message: Message): Future<Message>

Sends a message.

Parameters:

Name Type Description
message Message The message.

Returns: Future<Message>

Overrides: ManagedConnection

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

setBundlePolicy

▸ setBundlePolicy(value: BundlePolicy): void

Sets the Bundle Policy.

Parameters:

Name Type
value BundlePolicy

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2342

setDisableAutomaticIceServers

▸ setDisableAutomaticIceServers(value: boolean): void

Sets whether to disable automatic ICE servers (embedded TURN).

Parameters:

Name Type
value boolean

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2384

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

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

setIceGatherPolicy

▸ setIceGatherPolicy(value: IceGatherPolicy): void

Sets the ICE gather policy.

Parameters:

Name Type
value IceGatherPolicy

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2394

setIceServer

▸ setIceServer(value: IceServer): void

Sets the ICE server.

Parameters:

Name Type
value IceServer

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2404

setIceServers

▸ setIceServers(value: IceServer[]): void

Sets the ICE servers.

Parameters:

Name Type
value IceServer[]

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2414

setLocalAudioFormats

▸ ProtectedsetLocalAudioFormats(value: FormatInfo[]): void

Sets the local audio formats.

Parameters:

Name Type
value FormatInfo[]

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2432

setLocalVideoFormats

▸ ProtectedsetLocalVideoFormats(value: FormatInfo[]): void

Sets the local video formats.

Parameters:

Name Type
value FormatInfo[]

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2442

setMediaId

▸ ProtectedsetMediaId(value: string): void

Sets the media identifier.

Parameters:

Name Type
value string

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2452

setNoMediaServerTimeout

▸ setNoMediaServerTimeout(value: number): void

Sets the timeout in milliseconds on retries for cases where no Media Servers are available for either CE servers or SFU/MCU offer processing.

Parameters:

Name Type
value number

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2462

setPreferredMediaServerId

▸ setPreferredMediaServerId(value: string): void

Sets the preferred identifier of the Media Server to handle this connection.

Parameters:

Name Type
value string

Returns: void

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

setRemoteAudioEncoding

▸ ProtectedsetRemoteAudioEncoding(value: EncodingInfo): void

Sets the remote audio encoding.

Parameters:

Name Type
value EncodingInfo

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2473

setRemoteAudioFormats

▸ ProtectedsetRemoteAudioFormats(value: FormatInfo[]): void

Sets the remote audio formats.

Parameters:

Name Type
value FormatInfo[]

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2491

setRemoteAudioMuted

▸ setRemoteAudioMuted(value: boolean): void

Sets whether the remote audio is muted.

Parameters:

Name Type
value boolean

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2501

setRemoteConnectionId

▸ ProtectedsetRemoteConnectionId(value: string): void

Sets the remote connection identifier, if available.

Parameters:

Name Type
value string

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2521

setRemoteMediaId

▸ ProtectedsetRemoteMediaId(value: string): void

Sets the remote media identifier, if available.

Parameters:

Name Type
value string

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2539

setRemoteTag

▸ ProtectedsetRemoteTag(value: string): void

Sets the remote tag, if applicable.

Parameters:

Name Type
value string

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2557

setRemoteVideoEncoding

▸ ProtectedsetRemoteVideoEncoding(value: EncodingInfo): void

Sets the remote video encoding.

Parameters:

Name Type
value EncodingInfo

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2567

setRemoteVideoFormats

▸ ProtectedsetRemoteVideoFormats(value: FormatInfo[]): void

Sets the remote video formats.

Parameters:

Name Type
value FormatInfo[]

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2585

setRemoteVideoMuted

▸ setRemoteVideoMuted(value: boolean): void

Sets whether the remote video is muted.

Parameters:

Name Type
value boolean

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2595

setStatsInterval

▸ setStatsInterval(value: number): void

Sets the stats interval in milliseconds. The default value is 10,000 (10 seconds).

Parameters:

Name Type
value number

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2607

setTag

▸ setTag(value: string): void

Sets the tag.

Parameters:

Name Type
value string

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2618

setTrickleIcePolicy

▸ setTrickleIcePolicy(value: TrickleIcePolicy): void

Sets the trickle-ICE policy.

Parameters:

Name Type
value TrickleIcePolicy

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2628

unsetDynamicValue

▸ unsetDynamicValue(key: string): boolean

Unsets a property value in the local cache.

Parameters:

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

Returns: boolean

true if the value was removed; otherwise, false.

Inherited from: ManagedConnection

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

update

▸ update(config: ConnectionConfig): Future<Object>

Updates the local description with any modified properties from the config and alerts the server.

Parameters:

Name Type Description
config ConnectionConfig The config

Returns: Future<Object>

A future that resolves when the renegotiation is complete.

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2682

getDefaultNoMediaServerTimeout

▸ StaticgetDefaultNoMediaServerTimeout(): number

Gets the default timeout in milliseconds on retries for cases where no Media Servers are available for either CE servers or SFU/MCU offer processing. The initial value is 120,000 (2 minutes).

Returns: number

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:262

getDefaultStatsInterval

▸ StaticgetDefaultStatsInterval(): number

Gets the default stats interval in milliseconds. The initial value is 10,000 (10 seconds).

Returns: number

Inherited from: ManagedConnection

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

setDefaultNoMediaServerTimeout

▸ StaticsetDefaultNoMediaServerTimeout(value: number): void

Sets the default timeout in milliseconds on retries for cases where no Media Servers are available for either CE servers or SFU/MCU offer processing. The initial value is 120,000 (2 minutes).

Parameters:

Name Type
value number

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:284

setDefaultStatsInterval

▸ StaticsetDefaultStatsInterval(value: number): void

Sets the default stats interval in milliseconds. The initial value is 10,000 (10 seconds).

Parameters:

Name Type
value number

Returns: void

Inherited from: ManagedConnection

Defined in: fm/Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:296