/ fm / liveswitch / SfuConnection

Class: SfuConnection

fm.liveswitch.SfuConnection

An SFU connection.

Hierarchy

Table of contents

Methods

Methods

addOnAudioUnmuteDisabled

▸ addOnAudioUnmuteDisabled(value: IAction0): void

Adds a handler that is raised when the ability to unmute audio is disabled.

Parameters:

Name Type
value IAction0

Returns: void

Inherited from: ServerConnection

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

addOnAudioUnmuteEnabled

▸ addOnAudioUnmuteEnabled(value: IAction0): void

Adds a handler that is raised when the ability to unmute audio is enabled.

Parameters:

Name Type
value IAction0

Returns: void

Inherited from: ServerConnection

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

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

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

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

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

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

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

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

Inherited from: ServerConnection

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

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

Inherited from: ServerConnection

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

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

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

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

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

addOnMediaQuality

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

Adds a handler that is raised every [[fm.liveswitch.managedConnection.statsEventInterval]] milliseconds with the current estimated media quality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.

Parameters:

Name Type
value IAction1<number>

Returns: void

Inherited from: ServerConnection

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

addOnNetworkQuality

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

Adds a handler that is raised every [[fm.liveswitch.managedConnection.statsEventInterval]] milliseconds with the current estimated network quality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.

Parameters:

Name Type
value IAction1<number>

Returns: void

Inherited from: ServerConnection

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

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

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

addOnNoWebSocketMediaServersAvailable

▸ addOnNoWebSocketMediaServersAvailable(value: IAction2<ManagedConnection, NoWebSocketMediaServersAvailableEventArgs>): void

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

Parameters:

Name Type
value IAction2<ManagedConnection, NoWebSocketMediaServersAvailableEventArgs>

Returns: void

Inherited from: ServerConnection

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

addOnRecordingDisabled

▸ addOnRecordingDisabled(value: IAction1<string>): void

Adds a handler that is raised when this connection is no longer being recorded.

Parameters:

Name Type
value IAction1<string>

Returns: void

Inherited from: ServerConnection

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

addOnRecordingEnabled

▸ addOnRecordingEnabled(value: IAction1<string>): void

Adds a handler that is raised when this connection is being recorded.

Parameters:

Name Type
value IAction1<string>

Returns: void

Inherited from: ServerConnection

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

addOnStats

▸ addOnStats(value: IAction1<ConnectionStats>): void

Adds a handler that is raised every [[fm.liveswitch.managedConnection.statsEventInterval]] milliseconds with the current connection stats.

Parameters:

Name Type
value IAction1<ConnectionStats>

Returns: void

Inherited from: ServerConnection

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

addOnVideoEnabledChange

▸ addOnVideoEnabledChange(value: IAction2<ManagedConnection, boolean>): void

Adds a handler that is raised when a connection has it's video state changed from disabled or enabled. Due to connection constrainsts. Parameters:

  • connection - the connection
  • videoEnabled - the value indicating true if the video has been enabled or false for disabled.

Parameters:

Name Type
value IAction2<ManagedConnection, boolean>

Returns: void

Inherited from: ServerConnection

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

addOnVideoUnmuteDisabled

▸ addOnVideoUnmuteDisabled(value: IAction0): void

Adds a handler that is raised when the ability to unmute video is disabled.

Parameters:

Name Type
value IAction0

Returns: void

Inherited from: ServerConnection

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

addOnVideoUnmuteEnabled

▸ addOnVideoUnmuteEnabled(value: IAction0): void

Adds a handler that is raised when the ability to unmute video is enabled.

Parameters:

Name Type
value IAction0

Returns: void

Inherited from: ServerConnection

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

close

▸ close(): Future<Object>

Closes the connection.

Returns: Future<Object>

Inherited from: ServerConnection

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

defaultRTTMonitoringStrategy

▸ defaultRTTMonitoringStrategy(rtt: number): void

The default RTT strategy.

Parameters:

Name Type Description
rtt number A round trip time measurement

Returns: void

Inherited from: ServerConnection

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

detachInternalEventHandlers

▸ ProtecteddetachInternalEventHandlers(): void

Detaches internal event handlers.

Returns: void

Inherited from: ServerConnection

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

disableVideo

▸ Protected AbstractdisableVideo(config: ConnectionConfig): void

Disable this connections video in the connection config.

Parameters:

Name Type
config ConnectionConfig

Returns: void

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

doCreateCandidateMessage

▸ ProtecteddoCreateCandidateMessage(candidate: Candidate): Message

Creates a candidate message.

Parameters:

Name Type Description
candidate Candidate The candidate.

Returns: Message

Inherited from: ServerConnection

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

doCreateCloseMessage

▸ ProtecteddoCreateCloseMessage(): Message

Creates a close message.

Returns: Message

Inherited from: ServerConnection

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

doCreateOfferMessage

▸ Protected AbstractdoCreateOfferMessage(offer: SessionDescription): Message

Creates an offer message.

Parameters:

Name Type Description
offer SessionDescription The offer.

Returns: Message

Inherited from: ServerConnection

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

doCreateUpdateMessage

▸ ProtecteddoCreateUpdateMessage(config: ConnectionConfig): Message

Creates an update message.

Parameters:

Name Type Description
config ConnectionConfig The connection config.

Returns: Message

Inherited from: ServerConnection

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

doCreateUseWebSocketServiceMessage

▸ ProtecteddoCreateUseWebSocketServiceMessage(): Message

Create the message to use WebSockets for media

Returns: Message

Inherited from: ServerConnection

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

doOpen

▸ ProtecteddoOpen(): void

Opens the connection.

Returns: void

Inherited from: ServerConnection

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

doProcessMessage

▸ ProtecteddoProcessMessage(message: Message): void

Processes a message.

Parameters:

Name Type Description
message Message The message.

Returns: void

Inherited from: ServerConnection

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

enableVideo

▸ Protected AbstractenableVideo(config: ConnectionConfig): void

Enable this connection's video in the connection config.

Parameters:

Name Type
config ConnectionConfig

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/SfuConnection.ts:55

getApplicationId

▸ getApplicationId(): string

Gets the application identifier.

Returns: string

Inherited from: ServerConnection

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

getAudioDirection

▸ getAudioDirection(): string

Gets the audio direction. Null if disabled.

Returns: string

Inherited from: ServerConnection

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

getAudioStream

▸ getAudioStream(): AudioStream

Gets the audio stream.

Returns: AudioStream

Inherited from: ServerConnection

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

getAudioUnmuteDisabled

▸ getAudioUnmuteDisabled(): boolean

Gets whether the ability to unmute audio is disabled.

Returns: boolean

Inherited from: ServerConnection

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

getBundlePolicy

▸ getBundlePolicy(): BundlePolicy

Gets the Bundle Policy.

Returns: BundlePolicy

Inherited from: ServerConnection

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

getCanonicalName

▸ getCanonicalName(): string

Gets the connection's canonical name.

deprecated Use MediaStream.LocalCanonicalName instead.

Returns: string

Inherited from: ServerConnection

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

getChannelId

▸ getChannelId(): string

Gets the channel identifier.

Returns: string

Inherited from: ServerConnection

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

getClientId

▸ getClientId(): string

Gets the client identifier.

Returns: string

Inherited from: ServerConnection

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

getConfig

▸ getConfig(): ConnectionConfig

Gets the current configuration.

Returns: ConnectionConfig

Inherited from: ServerConnection

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

getDataDirection

▸ getDataDirection(): string

Gets the data direction. Null if disabled.

Returns: string

Inherited from: ServerConnection

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

getDataStream

▸ getDataStream(): DataStream

Gets the data stream.

Returns: DataStream

Inherited from: ServerConnection

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

getDeadStreamTimeout

▸ getDeadStreamTimeout(): number

Gets the amount of time (in milliseconds) to wait before declaring the connection dead. When there are no candidate pairs connected, the timer will start. When a candidate pair becomes connected the timer will be reset and stopped. If no candidate pairs become connected before the timeout is reached, the state of the connection will change to failed. Defaults to 15,000.

Returns: number

Inherited from: ServerConnection

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

getDeviceId

▸ getDeviceId(): string

Gets the device identifier.

Returns: string

Inherited from: ServerConnection

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

getDiagnosticsConfig

▸ getDiagnosticsConfig(): DiagnosticsConfig

Gets the Diagnostics Config.

Returns: DiagnosticsConfig

Inherited from: ServerConnection

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

getDisableAutomaticIceServers

▸ getDisableAutomaticIceServers(): boolean

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

Returns: boolean

Inherited from: ServerConnection

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

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: ServerConnection

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

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

getError

▸ getError(): Error

Gets the error, if an error exists.

Returns: Error

Inherited from: ServerConnection

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

getExternalId

▸ getExternalId(): string

Gets the external connection identifier.

Returns: string

Inherited from: ServerConnection

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

getGatheringState

▸ getGatheringState(): IceGatheringState

Gets the state of the ice gathering.

Returns: IceGatheringState

Inherited from: ServerConnection

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

getHasAudio

▸ getHasAudio(): boolean

Gets whether this connection has an audio stream.

Returns: boolean

Inherited from: ServerConnection

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

getHasData

▸ getHasData(): boolean

Gets whether this connection has a data stream.

Returns: boolean

Inherited from: ServerConnection

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

getHasVideo

▸ getHasVideo(): boolean

Gets whether this connection has a video stream.

Returns: boolean

Inherited from: ServerConnection

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

getIceConnectionState

▸ getIceConnectionState(): IceConnectionState

Gets the state of the ice connection.

Returns: IceConnectionState

Inherited from: ServerConnection

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

getIceGatherPolicy

▸ getIceGatherPolicy(): IceGatherPolicy

Gets the ICE gather policy.

Returns: IceGatherPolicy

Inherited from: ServerConnection

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

getIceServer

▸ getIceServer(): IceServer

Gets the ICE server.

Returns: IceServer

Inherited from: ServerConnection

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

getIceServers

▸ getIceServers(): IceServer[]

Gets the ICE servers.

Returns: IceServer[]

Inherited from: ServerConnection

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

getId

▸ getId(): string

Gets the connection identifier.

Returns: string

Inherited from: ServerConnection

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

getInboundAudioBitrate

▸ getInboundAudioBitrate(): number

Gets the current inbound audio bitrate.

Returns: number

Inherited from: ServerConnection

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

getInboundVideoBitrate

▸ getInboundVideoBitrate(): number

Gets the current inbound video bitrate.

Returns: number

Inherited from: ServerConnection

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

getInfo

▸ getInfo(): ConnectionInfo

Gets the connection info.

Returns: ConnectionInfo

Inherited from: ServerConnection

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

getInternalRtcpDataChannel

▸ ProtectedgetInternalRtcpDataChannel(): DataChannel

Gets Data Channel for inband signalling.

Returns: DataChannel

Inherited from: ServerConnection

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

getLayoutPriority

▸ getLayoutPriority(): number

Gets the LayoutPriority.

Returns: number

Inherited from: ServerConnection

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

getLayoutZone

▸ getLayoutZone(): string

Gets the LayoutZone.

Returns: string

Inherited from: ServerConnection

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

getLocalAudioDirection

▸ getLocalAudioDirection(): string

Gets the local audio direction. Null if disabled.

Returns: string

Inherited from: ServerConnection

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

getLocalAudioDisabled

▸ getLocalAudioDisabled(): boolean

Gets if local audio is disabled.

Returns: boolean

Inherited from: ServerConnection

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

getLocalAudioFormats

▸ getLocalAudioFormats(): FormatInfo[]

Gets the local audio formats.

Returns: FormatInfo[]

Inherited from: ServerConnection

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

getLocalAudioMuted

▸ getLocalAudioMuted(): boolean

Gets whether the local audio is muted.

Returns: boolean

Inherited from: ServerConnection

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

getLocalDataDirection

▸ getLocalDataDirection(): string

Gets the local data direction. Null if disabled.

Returns: string

Inherited from: ServerConnection

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

getLocalDataDisabled

▸ getLocalDataDisabled(): boolean

Gets if local data is disabled.

Returns: boolean

Inherited from: ServerConnection

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

getLocalDescription

▸ getLocalDescription(): SessionDescription

Gets the local description.

Returns: SessionDescription

Inherited from: ServerConnection

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

getLocalVideoDirection

▸ getLocalVideoDirection(): string

Gets the local video direction. Null if disabled.

Returns: string

Inherited from: ServerConnection

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

getLocalVideoDisabled

▸ getLocalVideoDisabled(): boolean

Gets if local video is disabled.

Returns: boolean

Inherited from: ServerConnection

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

getLocalVideoFormats

▸ getLocalVideoFormats(): FormatInfo[]

Gets the local video formats.

Returns: FormatInfo[]

Inherited from: ServerConnection

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

getLocalVideoMuted

▸ getLocalVideoMuted(): boolean

Gets whether the local video is muted.

Returns: boolean

Inherited from: ServerConnection

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

getMaxNoMediaServerRetryBackoff

▸ getMaxNoMediaServerRetryBackoff(): number

Gets the maximum retry backoff timeout, in milliseconds, before we retry a request after receiving no Media Servers are available for either ICE servers or SFU/MCU offer processing.
The default value is 1500ms.

Returns: number

Inherited from: ServerConnection

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

getMediaId

▸ getMediaId(): string

Gets the media identifier.

Returns: string

Inherited from: ServerConnection

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

getMediaProtocol

▸ getMediaProtocol(): MediaProtocol

Gets the media protocol in use on this connection.

Returns: MediaProtocol

Inherited from: ServerConnection

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

getMediaQuality

▸ getMediaQuality(): number

Gets the current estimated media quality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.

Returns: number

Inherited from: ServerConnection

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

getMediaServerId

▸ getMediaServerId(): string

Gets the identifier of the Media Server handling this connection.

Returns: string

Inherited from: ServerConnection

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

getMinNoMediaServerRetryBackoff

▸ getMinNoMediaServerRetryBackoff(): number

Gets the mininum retry backoff timeout, in milliseconds, before we retry a request after receiving no Media Servers are available for either ICE servers or SFU/MCU offer processing.
The default value is 1000ms.

Returns: number

Inherited from: ServerConnection

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

getNetworkQuality

▸ getNetworkQuality(): number

Gets the current estimated network quality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.

Returns: number

Inherited from: ServerConnection

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

getNoMediaServerTimeout

▸ getNoMediaServerTimeout(): number

Gets the timeout, in milliseconds, before failing a request where no Media Servers are available for either ICE servers or SFU/MCU offer processing.

Returns: number

Inherited from: ServerConnection

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

getPreferredMediaServerId

▸ getPreferredMediaServerId(): string

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

Returns: string

Inherited from: ServerConnection

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

getRandomizer

▸ ProtectedgetRandomizer(): Randomizer

Gets a randomizer for backoff timers

Returns: Randomizer

Inherited from: ServerConnection

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

getRecordingEnabled

▸ getRecordingEnabled(): boolean

Gets whether this connection is being recorded.

Returns: boolean

Inherited from: ServerConnection

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

getRemoteAudioDisabled

▸ getRemoteAudioDisabled(): boolean

Gets if remote audio is disabled.

Returns: boolean

Inherited from: ServerConnection

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

getRemoteAudioEncoding

▸ getRemoteAudioEncoding(): EncodingInfo

Gets the remote audio encoding.

Returns: EncodingInfo

Inherited from: ServerConnection

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

getRemoteAudioFormats

▸ getRemoteAudioFormats(): FormatInfo[]

Gets the remote audio formats.

Returns: FormatInfo[]

Inherited from: ServerConnection

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

getRemoteAudioMuted

▸ getRemoteAudioMuted(): boolean

Gets whether the remote audio is muted.

Returns: boolean

Inherited from: ServerConnection

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

getRemoteClosed

▸ getRemoteClosed(): boolean

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

Returns: boolean

Inherited from: ServerConnection

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

getRemoteConnectionId

▸ getRemoteConnectionId(): string

Gets the remote connection identifier, if available.

Returns: string

Inherited from: ServerConnection

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

getRemoteDataDisabled

▸ getRemoteDataDisabled(): boolean

Gets if remote data is disabled.

Returns: boolean

Inherited from: ServerConnection

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

getRemoteDescription

▸ getRemoteDescription(): SessionDescription

Gets the remote description.

Returns: SessionDescription

Inherited from: ServerConnection

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

getRemoteMediaId

▸ getRemoteMediaId(): string

Gets the remote media identifier, if available.

Returns: string

Inherited from: ServerConnection

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

getRemoteRejected

▸ getRemoteRejected(): boolean

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

Returns: boolean

Inherited from: ServerConnection

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

getRemoteTag

▸ getRemoteTag(): string

Gets the remote tag, if applicable.

Returns: string

Inherited from: ServerConnection

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

getRemoteVideoDisabled

▸ getRemoteVideoDisabled(): boolean

Gets if remote video is disabled.

Returns: boolean

Inherited from: ServerConnection

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

getRemoteVideoEncoding

▸ getRemoteVideoEncoding(): EncodingInfo

Gets the remote video encoding.

Returns: EncodingInfo

Inherited from: ServerConnection

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

getRemoteVideoFormats

▸ getRemoteVideoFormats(): FormatInfo[]

Gets the remote video formats.

Returns: FormatInfo[]

Inherited from: ServerConnection

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

getRemoteVideoMuted

▸ getRemoteVideoMuted(): boolean

Gets whether the remote video is muted.

Returns: boolean

Inherited from: ServerConnection

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

getRttMonitoringStrategy

▸ getRttMonitoringStrategy(): IAction1<number>

Gets the RTT strategy.

Returns: IAction1<number>

Inherited from: ServerConnection

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

getSignallingState

▸ getSignallingState(): SignallingState

Gets the state of the signalling.

Returns: SignallingState

Inherited from: ServerConnection

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

getState

▸ getState(): ConnectionState

Gets the state of the connection.

Returns: ConnectionState

Inherited from: ServerConnection

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

getStats

▸ getStats(): Future<ConnectionStats>

Gets the current connection stats.

Returns: Future<ConnectionStats>

Inherited from: ServerConnection

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

getStatsEventInterval

▸ getStatsEventInterval(): number

Gets the interval, in milliseconds, between stats events raised locally by [[fm.liveswitch.managedConnection.addOnStats]].
The default value is 1000 (1 second).

Returns: number

Inherited from: ServerConnection

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

getStatsInterval

▸ getStatsInterval(): number

Gets the default interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).

deprecated Use StatsReportInterval instead.

Returns: number

Inherited from: ServerConnection

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

getStatsReportInterval

▸ getStatsReportInterval(): number

Gets the interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).

Returns: number

Inherited from: ServerConnection

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

getTag

▸ getTag(): string

Gets the tag.

Returns: string

Inherited from: ServerConnection

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

getTrickleIcePolicy

▸ getTrickleIcePolicy(): TrickleIcePolicy

Gets the trickle-ICE policy.

Returns: TrickleIcePolicy

Inherited from: ServerConnection

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

getType

▸ getType(): string

Gets the connection type.

Returns: string

Inherited from: ServerConnection

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

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: ServerConnection

Defined in: Generated/TypeScript/fm.liveswitch/SfuConnection.ts:10

getUseWebSocketsForMedia

▸ getUseWebSocketsForMedia(): boolean

Gets if we should use WebSockets for sending media.

Returns: boolean

Inherited from: ServerConnection

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

getUserId

▸ getUserId(): string

Gets the user identifier.

Returns: string

Inherited from: ServerConnection

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

getVideoDirection

▸ getVideoDirection(): string

Gets the video direction. Null if disabled.

Returns: string

Inherited from: ServerConnection

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

getVideoEnabledConnectionUpdateAttempts

▸ getVideoEnabledConnectionUpdateAttempts(): number

Gets the amount of attempts this connection has made to enabled video on a connection. These attempts happen after the connection has been updated to disabled video due to network constraints.

Returns: number

Inherited from: ServerConnection

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

getVideoEnabledUpdateConnectionPolicy

▸ getVideoEnabledUpdateConnectionPolicy(): IFunction1<number, number>

Gets a method that determines when to enable video again on a connection that dynamically disables video. Optional. If not set, default policy will be used. Takes in an interger parameter that represents the amount of attempts already tried. Will return an interger value as a time period in seconds for how long to wait for the next attempt or -1 for no more attempts.

Returns: IFunction1<number, number>

Inherited from: ServerConnection

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

getVideoRetentionPolicy

▸ getVideoRetentionPolicy(): VideoRetentionPolicy

Gets the Video Retention Policy. This will determine how we will handle video on the connection when the connection is of poor quality.

Returns: VideoRetentionPolicy

Inherited from: ServerConnection

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

getVideoStream

▸ getVideoStream(): VideoStream

Gets the video stream.

Returns: VideoStream

Inherited from: ServerConnection

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

getVideoUnmuteDisabled

▸ getVideoUnmuteDisabled(): boolean

Gets whether the ability to unmute video is disabled.

Returns: boolean

Inherited from: ServerConnection

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

getWmsAddress

▸ getWmsAddress(): string

Gets the WMS endpoint address.

Returns: string

Inherited from: ServerConnection

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

getWmsConnectionToken

▸ getWmsConnectionToken(): string

Gets WMS connection token.

Returns: string

Inherited from: ServerConnection

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

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

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

metricMonitorOnStateChange

▸ ProtectedmetricMonitorOnStateChange(eventArgs: MetricMonitorStateChangeEventArgs): void

Handles metric monitor state changes.

Parameters:

Name Type
eventArgs MetricMonitorStateChangeEventArgs

Returns: void

Overrides: ServerConnection

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

noRttMonitoringStrategy

▸ noRttMonitoringStrategy(rtt: number): void

The no rtt strategy.

Parameters:

Name Type
rtt number

Returns: void

Inherited from: ServerConnection

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

open

▸ open(): Future<Object>

Opens the connection.

Returns: Future<Object>

Inherited from: ServerConnection

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

processAnswer

▸ ProtectedprocessAnswer(message: Message): void

Processes an answer.

Parameters:

Name Type Description
message Message The message.

Returns: void

Inherited from: ServerConnection

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

processError

▸ ProtectedprocessError(message: Message): void

Processes an error message.

Parameters:

Name Type Description
message Message The message.

Returns: void

Inherited from: ServerConnection

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

processIceServers

▸ ProtectedprocessIceServers(message: Message): void

Processes an iceServers message.

Parameters:

Name Type Description
message Message The message.

Returns: void

Inherited from: ServerConnection

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

processLocalError

▸ ProtectedprocessLocalError(error: Error): void

Processes a local failure.

Parameters:

Name Type Description
error Error The error.

Returns: void

Inherited from: ServerConnection

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

processMediaIntentResponse

▸ ProtectedprocessMediaIntentResponse(message: Message): void

Processes an MediaIntentResponse message.

Parameters:

Name Type Description
message Message The message.

Returns: void

Inherited from: ServerConnection

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

processRtcpDataChannelSignallingActivation

▸ ProtectedprocessRtcpDataChannelSignallingActivation(message: Message): void

Processes inband signalling activation.

Parameters:

Name Type
message Message

Returns: void

Inherited from: ServerConnection

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

processSimulcastNotification

▸ ProtectedprocessSimulcastNotification(message: Message): void

Processes a simulcast notification

Parameters:

Name Type Description
message Message The simulcast notificaiton message.

Returns: void

Inherited from: ServerConnection

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

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

Inherited from: ServerConnection

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

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

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

raiseLocalCandidate

▸ ProtectedraiseLocalCandidate(localCandidate: Candidate): void

Raises a local candidate.

Parameters:

Name Type Description
localCandidate Candidate The local candidate.

Returns: void

Inherited from: ServerConnection

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

raiseNoMediaServersAvailable

▸ ProtectedraiseNoMediaServersAvailable(args: NoMediaServersAvailableEventArgs): void

Raises the OnNoMediaServersAvailable event.

Parameters:

Name Type
args NoMediaServersAvailableEventArgs

Returns: void

Inherited from: ServerConnection

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

raiseNoWebSocketMediaServersAvailable

▸ ProtectedraiseNoWebSocketMediaServersAvailable(args: NoWebSocketMediaServersAvailableEventArgs): void

Raises the OnNoWebSocketMediaServersAvailable event.

Parameters:

Name Type
args NoWebSocketMediaServersAvailableEventArgs

Returns: void

Inherited from: ServerConnection

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

raiseRemoteCandidate

▸ ProtectedraiseRemoteCandidate(remoteCandidate: Candidate): void

Raises a remote candidate.

Parameters:

Name Type Description
remoteCandidate Candidate The remote candidate.

Returns: void

Inherited from: ServerConnection

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

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

Inherited from: ServerConnection

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

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

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

removeOnAudioUnmuteDisabled

▸ removeOnAudioUnmuteDisabled(value: IAction0): void

Removes a handler that is raised when the ability to unmute audio is disabled.

Parameters:

Name Type
value IAction0

Returns: void

Inherited from: ServerConnection

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

removeOnAudioUnmuteEnabled

▸ removeOnAudioUnmuteEnabled(value: IAction0): void

Removes a handler that is raised when the ability to unmute audio is enabled.

Parameters:

Name Type
value IAction0

Returns: void

Inherited from: ServerConnection

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

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

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

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

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

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

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

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

Inherited from: ServerConnection

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

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

Inherited from: ServerConnection

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

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

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

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

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

removeOnMediaQuality

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

Removes a handler that is raised every [[fm.liveswitch.managedConnection.statsEventInterval]] milliseconds with the current estimated media quality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.

Parameters:

Name Type
value IAction1<number>

Returns: void

Inherited from: ServerConnection

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

removeOnNetworkQuality

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

Removes a handler that is raised every [[fm.liveswitch.managedConnection.statsEventInterval]] milliseconds with the current estimated network quality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.

Parameters:

Name Type
value IAction1<number>

Returns: void

Inherited from: ServerConnection

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

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

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

removeOnNoWebSocketMediaServersAvailable

▸ removeOnNoWebSocketMediaServersAvailable(value: IAction2<ManagedConnection, NoWebSocketMediaServersAvailableEventArgs>): void

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

Parameters:

Name Type
value IAction2<ManagedConnection, NoWebSocketMediaServersAvailableEventArgs>

Returns: void

Inherited from: ServerConnection

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

removeOnRecordingDisabled

▸ removeOnRecordingDisabled(value: IAction1<string>): void

Removes a handler that is raised when this connection is no longer being recorded.

Parameters:

Name Type
value IAction1<string>

Returns: void

Inherited from: ServerConnection

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

removeOnRecordingEnabled

▸ removeOnRecordingEnabled(value: IAction1<string>): void

Removes a handler that is raised when this connection is being recorded.

Parameters:

Name Type
value IAction1<string>

Returns: void

Inherited from: ServerConnection

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

removeOnStats

▸ removeOnStats(value: IAction1<ConnectionStats>): void

Removes a handler that is raised every [[fm.liveswitch.managedConnection.statsEventInterval]] milliseconds with the current connection stats.

Parameters:

Name Type
value IAction1<ConnectionStats>

Returns: void

Inherited from: ServerConnection

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

removeOnVideoEnabledChange

▸ removeOnVideoEnabledChange(value: IAction2<ManagedConnection, boolean>): void

Removes a handler that is raised when a connection has it's video state changed from disabled or enabled. Due to connection constrainsts. Parameters:

  • connection - the connection
  • videoEnabled - the value indicating true if the video has been enabled or false for disabled.

Parameters:

Name Type
value IAction2<ManagedConnection, boolean>

Returns: void

Inherited from: ServerConnection

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

removeOnVideoUnmuteDisabled

▸ removeOnVideoUnmuteDisabled(value: IAction0): void

Removes a handler that is raised when the ability to unmute video is disabled.

Parameters:

Name Type
value IAction0

Returns: void

Inherited from: ServerConnection

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

removeOnVideoUnmuteEnabled

▸ removeOnVideoUnmuteEnabled(value: IAction0): void

Removes a handler that is raised when the ability to unmute video is enabled.

Parameters:

Name Type
value IAction0

Returns: void

Inherited from: ServerConnection

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

send

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

Sends a message.

Parameters:

Name Type Description
message Message The message.

Returns: Future<Message>

Inherited from: ServerConnection

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

setBundlePolicy

▸ setBundlePolicy(value: BundlePolicy): void

Sets the Bundle Policy.

Parameters:

Name Type
value BundlePolicy

Returns: void

Inherited from: ServerConnection

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

setDeadStreamTimeout

▸ setDeadStreamTimeout(value: number): void

Sets the amount of time (in milliseconds) to wait before declaring the connection dead. When there are no candidate pairs connected, the timer will start. When a candidate pair becomes connected the timer will be reset and stopped. If no candidate pairs become connected before the timeout is reached, the state of the connection will change to failed. Defaults to 15,000.

Parameters:

Name Type
value number

Returns: void

Inherited from: ServerConnection

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

setDisableAutomaticIceServers

▸ setDisableAutomaticIceServers(value: boolean): void

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

Parameters:

Name Type
value boolean

Returns: void

Inherited from: ServerConnection

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

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

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

setIceGatherPolicy

▸ setIceGatherPolicy(value: IceGatherPolicy): void

Sets the ICE gather policy.

Parameters:

Name Type
value IceGatherPolicy

Returns: void

Inherited from: ServerConnection

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

setIceServer

▸ setIceServer(value: IceServer): void

Sets the ICE server.

Parameters:

Name Type
value IceServer

Returns: void

Inherited from: ServerConnection

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

setIceServers

▸ setIceServers(value: IceServer[]): void

Sets the ICE servers.

Parameters:

Name Type
value IceServer[]

Returns: void

Inherited from: ServerConnection

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

setLayoutPriority

▸ setLayoutPriority(value: number): void

Sets the LayoutPriority.

Parameters:

Name Type
value number

Returns: void

Inherited from: ServerConnection

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

setLayoutZone

▸ setLayoutZone(value: string): void

Sets the LayoutZone.

Parameters:

Name Type
value string

Returns: void

Inherited from: ServerConnection

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

setLocalAudioFormats

▸ ProtectedsetLocalAudioFormats(value: FormatInfo[]): void

Sets the local audio formats.

Parameters:

Name Type
value FormatInfo[]

Returns: void

Inherited from: ServerConnection

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

setLocalVideoFormats

▸ ProtectedsetLocalVideoFormats(value: FormatInfo[]): void

Sets the local video formats.

Parameters:

Name Type
value FormatInfo[]

Returns: void

Inherited from: ServerConnection

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

setMaxNoMediaServerRetryBackoff

▸ setMaxNoMediaServerRetryBackoff(value: number): void

Sets the maximum retry backoff timeout, in milliseconds, before we retry a request after receiving no Media Servers are available for either ICE servers or SFU/MCU offer processing.
The default value is 1500ms.

Parameters:

Name Type
value number

Returns: void

Inherited from: ServerConnection

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

setMediaId

▸ ProtectedsetMediaId(value: string): void

Sets the media identifier.

Parameters:

Name Type
value string

Returns: void

Inherited from: ServerConnection

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

setMinNoMediaServerRetryBackoff

▸ setMinNoMediaServerRetryBackoff(value: number): void

Sets the mininum retry backoff timeout, in milliseconds, before we retry a request after receiving no Media Servers are available for either ICE servers or SFU/MCU offer processing.
The default value is 1000ms.

Parameters:

Name Type
value number

Returns: void

Inherited from: ServerConnection

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

setNoMediaServerTimeout

▸ setNoMediaServerTimeout(value: number): void

Sets the timeout, in milliseconds, before failing a request where no Media Servers are available for either ICE servers or SFU/MCU offer processing.

Parameters:

Name Type
value number

Returns: void

Inherited from: ServerConnection

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

setPreferredMediaServerId

▸ setPreferredMediaServerId(value: string): void

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

Parameters:

Name Type
value string

Returns: void

Inherited from: ServerConnection

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

setRemoteAudioEncoding

▸ ProtectedsetRemoteAudioEncoding(value: EncodingInfo): void

Sets the remote audio encoding.

Parameters:

Name Type
value EncodingInfo

Returns: void

Inherited from: ServerConnection

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

setRemoteAudioFormats

▸ ProtectedsetRemoteAudioFormats(value: FormatInfo[]): void

Sets the remote audio formats.

Parameters:

Name Type
value FormatInfo[]

Returns: void

Inherited from: ServerConnection

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

setRemoteAudioMuted

▸ setRemoteAudioMuted(value: boolean): void

Sets whether the remote audio is muted.

Parameters:

Name Type
value boolean

Returns: void

Inherited from: ServerConnection

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

setRemoteConnectionId

▸ ProtectedsetRemoteConnectionId(value: string): void

Sets the remote connection identifier, if available.

Parameters:

Name Type
value string

Returns: void

Inherited from: ServerConnection

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

setRemoteMediaId

▸ ProtectedsetRemoteMediaId(value: string): void

Sets the remote media identifier, if available.

Parameters:

Name Type
value string

Returns: void

Inherited from: ServerConnection

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

setRemoteTag

▸ ProtectedsetRemoteTag(value: string): void

Sets the remote tag, if applicable.

Parameters:

Name Type
value string

Returns: void

Inherited from: ServerConnection

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

setRemoteVideoEncoding

▸ ProtectedsetRemoteVideoEncoding(value: EncodingInfo): void

Sets the remote video encoding.

Parameters:

Name Type
value EncodingInfo

Returns: void

Inherited from: ServerConnection

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

setRemoteVideoFormats

▸ ProtectedsetRemoteVideoFormats(value: FormatInfo[]): void

Sets the remote video formats.

Parameters:

Name Type
value FormatInfo[]

Returns: void

Inherited from: ServerConnection

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

setRemoteVideoMuted

▸ setRemoteVideoMuted(value: boolean): void

Sets whether the remote video is muted.

Parameters:

Name Type
value boolean

Returns: void

Inherited from: ServerConnection

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

setRttMonitoringStrategy

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

Sets the RTT strategy.

Parameters:

Name Type
value IAction1<number>

Returns: void

Inherited from: ServerConnection

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

setStatsEventInterval

▸ setStatsEventInterval(value: number): void

Sets the interval, in milliseconds, between stats events raised locally by [[fm.liveswitch.managedConnection.addOnStats]].
The default value is 1000 (1 second).

Parameters:

Name Type
value number

Returns: void

Inherited from: ServerConnection

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

setStatsInterval

▸ setStatsInterval(value: number): void

Sets the default interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).

deprecated Use StatsReportInterval instead.

Parameters:

Name Type
value number

Returns: void

Inherited from: ServerConnection

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

setStatsReportInterval

▸ setStatsReportInterval(value: number): void

Sets the interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).

Parameters:

Name Type
value number

Returns: void

Inherited from: ServerConnection

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

setTag

▸ setTag(value: string): void

Sets the tag.

Parameters:

Name Type
value string

Returns: void

Inherited from: ServerConnection

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

setTrickleIcePolicy

▸ setTrickleIcePolicy(value: TrickleIcePolicy): void

Sets the trickle-ICE policy.

Parameters:

Name Type
value TrickleIcePolicy

Returns: void

Inherited from: ServerConnection

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

setUseWebSocketsForMedia

▸ ProtectedsetUseWebSocketsForMedia(value: boolean): void

Sets if we should use WebSockets for sending media.

Parameters:

Name Type
value boolean

Returns: void

Inherited from: ServerConnection

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

setVideoEnabledUpdateConnectionPolicy

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

Sets a method that determines when to enable video again on a connection that dynamically disables video. Optional. If not set, default policy will be used. Takes in an interger parameter that represents the amount of attempts already tried. Will return an interger value as a time period in seconds for how long to wait for the next attempt or -1 for no more attempts.

Parameters:

Name Type
value IFunction1<number, number>

Returns: void

Inherited from: ServerConnection

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

setVideoRetentionPolicy

▸ setVideoRetentionPolicy(value: VideoRetentionPolicy): void

Sets the Video Retention Policy. This will determine how we will handle video on the connection when the connection is of poor quality.

Parameters:

Name Type
value VideoRetentionPolicy

Returns: void

Inherited from: ServerConnection

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

setWmsAddress

▸ setWmsAddress(value: string): void

Sets the WMS endpoint address.

Parameters:

Name Type
value string

Returns: void

Inherited from: ServerConnection

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

setWmsConnectionToken

▸ setWmsConnectionToken(value: string): void

Sets WMS connection token.

Parameters:

Name Type
value string

Returns: void

Inherited from: ServerConnection

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

trySendRtcpDataChannel

▸ ProtectedtrySendRtcpDataChannel(message: Message): boolean

Sends bitrate messages.

Parameters:

Name Type Description
message Message The message to send.

Returns: boolean

Inherited from: ServerConnection

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

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

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

update

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

Updates this connection.

Parameters:

Name Type Description
config ConnectionConfig The connection configuration.

Returns: Future<Object>

A future that resolves when the connection has been updated.

Inherited from: ServerConnection

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

getDefaultNoMediaServerTimeout

▸ StaticgetDefaultNoMediaServerTimeout(): number

Gets the default timeout, in milliseconds, before we fail the connection attempt where no Media Servers are available for either ICE servers or SFU/MCU offer processing.
The default value is 120,000 (2 minutes).

Returns: number

Inherited from: ServerConnection

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

getDefaultStatsEventInterval

▸ StaticgetDefaultStatsEventInterval(): number

Gets the default interval, in milliseconds, between stats events raised locally by [[fm.liveswitch.managedConnection.addOnStats]].
The default value is 1,000 (1 second).

Returns: number

Inherited from: ServerConnection

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

getDefaultStatsInterval

▸ StaticgetDefaultStatsInterval(): number

Gets the default interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).

deprecated Use DefaultStatsReportInterval instead.

Returns: number

Inherited from: ServerConnection

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

getDefaultStatsReportInterval

▸ StaticgetDefaultStatsReportInterval(): number

Gets the default interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).

Returns: number

Inherited from: ServerConnection

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

setDefaultNoMediaServerTimeout

▸ StaticsetDefaultNoMediaServerTimeout(value: number): void

Sets the default timeout, in milliseconds, before we fail the connection attempt where no Media Servers are available for either ICE servers or SFU/MCU offer processing.
The default value is 120,000 (2 minutes).

Parameters:

Name Type
value number

Returns: void

Inherited from: ServerConnection

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

setDefaultStatsEventInterval

▸ StaticsetDefaultStatsEventInterval(value: number): void

Sets the default interval, in milliseconds, between stats events raised locally by [[fm.liveswitch.managedConnection.addOnStats]].
The default value is 1,000 (1 second).

Parameters:

Name Type
value number

Returns: void

Inherited from: ServerConnection

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

setDefaultStatsInterval

▸ StaticsetDefaultStatsInterval(value: number): void

Sets the default interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).

deprecated Use DefaultStatsReportInterval instead.

Parameters:

Name Type
value number

Returns: void

Inherited from: ServerConnection

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

setDefaultStatsReportInterval

▸ StaticsetDefaultStatsReportInterval(value: number): void

Sets the default interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).

Parameters:

Name Type
value number

Returns: void

Inherited from: ServerConnection

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