/ fm / liveswitch / ServerConnection
Class: ServerConnection
fm.liveswitch.ServerConnection
A server connection.
Hierarchy
-
↳ ServerConnection
Table of contents
Methods
- addOnAudioUnmuteDisabled
- addOnAudioUnmuteEnabled
- addOnAutomaticIceServers
- addOnGatheringStateChange
- addOnIceConnectionStateChange
- addOnInboundAudioBitrateChange
- addOnInboundVideoBitrateChange
- addOnLocalCandidate
- addOnLocalDescription
- addOnMediaQuality
- addOnNetworkQuality
- addOnNoMediaServersAvailable
- addOnRecordingDisabled
- addOnRecordingEnabled
- addOnRemoteAudioEncodingSwitch
- addOnRemoteCandidate
- addOnRemoteDescription
- addOnRemoteUpdate
- addOnRemoteVideoEncodingSwitch
- addOnSignallingStateChange
- addOnStateChange
- addOnStats
- addOnVideoUnmuteDisabled
- addOnVideoUnmuteEnabled
- close
- detachInternalEventHandlers
- doCreateCandidateMessage
- doCreateCloseMessage
- doCreateOfferMessage
- doCreateUpdateMessage
- doOpen
- doProcessMessage
- fmliveswitchServerConnectionInit
- getApplicationId
- getAudioDirection
- getAudioStream
- getAudioUnmuteDisabled
- getBundlePolicy
- getCanonicalName
- getChannelId
- getClientId
- getConfig
- getDataDirection
- getDataStream
- getDeviceId
- getDisableAutomaticIceServers
- getDynamicProperties
- getDynamicValue
- getError
- getExternalId
- getGatheringState
- getHasAudio
- getHasData
- getHasVideo
- getIceConnectionState
- getIceGatherPolicy
- getIceServer
- getIceServers
- getId
- getInboundAudioBitrate
- getInboundVideoBitrate
- getInfo
- getInternalRtcpDataChannel
- getLayoutPriority
- getLayoutZone
- getLocalAudioDisabled
- getLocalAudioFormats
- getLocalAudioMuted
- getLocalDataDisabled
- getLocalDescription
- getLocalVideoDisabled
- getLocalVideoFormats
- getLocalVideoMuted
- getMediaId
- getMediaQuality
- getMediaServerId
- getNetworkQuality
- getNoMediaServerTimeout
- getPreferredMediaServerId
- getRecordingEnabled
- getRemoteAudioDisabled
- getRemoteAudioEncoding
- getRemoteAudioFormats
- getRemoteAudioMuted
- getRemoteClosed
- getRemoteConnectionId
- getRemoteDataDisabled
- getRemoteDescription
- getRemoteMediaId
- getRemoteRejected
- getRemoteTag
- getRemoteVideoDisabled
- getRemoteVideoEncoding
- getRemoteVideoFormats
- getRemoteVideoMuted
- getSignallingState
- getState
- getStats
- getStatsEventInterval
- getStatsInterval
- getStatsReportInterval
- getTag
- getTrickleIcePolicy
- getType
- getTypeString
- getUserId
- getVideoDirection
- getVideoStream
- getVideoUnmuteDisabled
- isMediaDirectionAllowed
- open
- processAnswer
- processError
- processIceServers
- processLocalError
- processRtcpDataChannelSignallingActivation
- raiseAudioBitrateNotification
- raiseAudioBitrateRequest
- raiseLocalCandidate
- raiseNoMediaServersAvailable
- raiseRemoteCandidate
- raiseVideoBitrateNotification
- raiseVideoBitrateRequest
- removeOnAudioUnmuteDisabled
- removeOnAudioUnmuteEnabled
- removeOnAutomaticIceServers
- removeOnGatheringStateChange
- removeOnIceConnectionStateChange
- removeOnInboundAudioBitrateChange
- removeOnInboundVideoBitrateChange
- removeOnLocalCandidate
- removeOnLocalDescription
- removeOnMediaQuality
- removeOnNetworkQuality
- removeOnNoMediaServersAvailable
- removeOnRecordingDisabled
- removeOnRecordingEnabled
- removeOnRemoteAudioEncodingSwitch
- removeOnRemoteCandidate
- removeOnRemoteDescription
- removeOnRemoteUpdate
- removeOnRemoteVideoEncodingSwitch
- removeOnSignallingStateChange
- removeOnStateChange
- removeOnStats
- removeOnVideoUnmuteDisabled
- removeOnVideoUnmuteEnabled
- send
- setBundlePolicy
- setDisableAutomaticIceServers
- setDynamicValue
- setIceGatherPolicy
- setIceServer
- setIceServers
- setLayoutPriority
- setLayoutZone
- setLocalAudioFormats
- setLocalVideoFormats
- setMediaId
- setNoMediaServerTimeout
- setPreferredMediaServerId
- setRemoteAudioEncoding
- setRemoteAudioFormats
- setRemoteAudioMuted
- setRemoteConnectionId
- setRemoteMediaId
- setRemoteTag
- setRemoteVideoEncoding
- setRemoteVideoFormats
- setRemoteVideoMuted
- setStatsEventInterval
- setStatsInterval
- setStatsReportInterval
- setTag
- setTrickleIcePolicy
- trySendRtcpDataChannel
- unsetDynamicValue
- update
- getDefaultNoMediaServerTimeout
- getDefaultStatsEventInterval
- getDefaultStatsInterval
- getDefaultStatsReportInterval
- setDefaultNoMediaServerTimeout
- setDefaultStatsEventInterval
- setDefaultStatsInterval
- setDefaultStatsReportInterval
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:498
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:510
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:525
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:539
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:553
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: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:109
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: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:121
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:568
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:583
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:597
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:611
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:623
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:635
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:647
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:659
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:674
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:689
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:701
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:713
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:727
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:741
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:753
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:765
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:777
close
▸ close(): Future<Object>
Closes the connection.
Returns: Future<Object>
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:789
detachInternalEventHandlers
▸ ProtecteddetachInternalEventHandlers(): void
Detaches internal event handlers.
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:133
doCreateCandidateMessage
▸ ProtecteddoCreateCandidateMessage(candidate: Candidate): Message
Creates a candidate message.
Parameters:
| Name | Type | Description |
|---|---|---|
candidate |
Candidate | The candidate. |
Returns: Message
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:152
doCreateCloseMessage
▸ ProtecteddoCreateCloseMessage(): Message
Creates a close message.
Returns: Message
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:164
doCreateOfferMessage
▸ Protected AbstractdoCreateOfferMessage(offer: SessionDescription): Message
Creates an offer message.
Parameters:
| Name | Type | Description |
|---|---|---|
offer |
SessionDescription | The offer. |
Returns: Message
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:177
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:893
doOpen
▸ ProtecteddoOpen(): void
Opens the connection.
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:183
doProcessMessage
▸ ProtecteddoProcessMessage(message: Message): void
Processes a message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Message | The message. |
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:211
fmliveswitchServerConnectionInit
▸ PrivatefmliveswitchServerConnectionInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:54
getApplicationId
▸ getApplicationId(): string
Gets the application identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1210
getAudioDirection
▸ getAudioDirection(): string
Gets thes audio direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1222
getAudioStream
▸ getAudioStream(): AudioStream
Gets the audio stream.
Returns: AudioStream
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1234
getAudioUnmuteDisabled
▸ getAudioUnmuteDisabled(): boolean
Gets whether the ability to unmute audio is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1246
getBundlePolicy
▸ getBundlePolicy(): BundlePolicy
Gets the Bundle Policy.
Returns: BundlePolicy
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1258
getCanonicalName
▸ getCanonicalName(): string
Gets the connection's canonical name.
deprecated Use MediaStream.LocalCanonicalName instead.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1271
getChannelId
▸ getChannelId(): string
Gets the channel identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1283
getClientId
▸ getClientId(): string
Gets the client identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1295
getConfig
▸ getConfig(): ConnectionConfig
Gets the current configuration.
Returns: ConnectionConfig
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1307
getDataDirection
▸ getDataDirection(): string
Gets the data direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1329
getDataStream
▸ getDataStream(): DataStream
Gets the data stream.
Returns: DataStream
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1341
getDeviceId
▸ getDeviceId(): string
Gets the device identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1353
getDisableAutomaticIceServers
▸ getDisableAutomaticIceServers(): boolean
Gets whether to disable automatic ICE servers (embedded TURN).
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1365
getDynamicProperties
▸ getDynamicProperties(): Hash<string, Object>
Gets all dynamic properties on this instance.
Returns: Hash<string, Object>
Inherited from: ManagedConnection
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:58
getError
▸ getError(): Error
Gets the error, if an error exists.
Returns: Error
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1377
getExternalId
▸ getExternalId(): string
Gets the external connection identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1389
getGatheringState
▸ getGatheringState(): IceGatheringState
Gets the state of the ice gathering.
Returns: IceGatheringState
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1401
getHasAudio
▸ getHasAudio(): boolean
Gets whether this connection has an audio stream.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1413
getHasData
▸ getHasData(): boolean
Gets whether this connection has a data stream.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1425
getHasVideo
▸ getHasVideo(): boolean
Gets whether this connection has a video stream.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1437
getIceConnectionState
▸ getIceConnectionState(): IceConnectionState
Gets the state of the ice connection.
Returns: IceConnectionState
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1449
getIceGatherPolicy
▸ getIceGatherPolicy(): IceGatherPolicy
Gets the ICE gather policy.
Returns: IceGatherPolicy
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1461
getIceServer
▸ getIceServer(): IceServer
Gets the ICE server.
Returns: IceServer
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1473
getIceServers
▸ getIceServers(): IceServer[]
Gets the ICE servers.
Returns: IceServer[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1485
getId
▸ getId(): string
Gets the connection identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1497
getInboundAudioBitrate
▸ getInboundAudioBitrate(): number
Gets the current inbound audio bitrate.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:225
getInboundVideoBitrate
▸ getInboundVideoBitrate(): number
Gets the current inbound video bitrate.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:237
getInfo
▸ getInfo(): ConnectionInfo
Gets the connection info.
Returns: ConnectionInfo
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1509
getInternalRtcpDataChannel
▸ ProtectedgetInternalRtcpDataChannel(): DataChannel
Gets Data Channel for inband signalling.
Returns: DataChannel
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1562
getLayoutPriority
▸ getLayoutPriority(): number
Gets the LayoutPriority.
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1574
getLayoutZone
▸ getLayoutZone(): string
Gets the LayoutZone.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1586
getLocalAudioDisabled
▸ getLocalAudioDisabled(): boolean
Gets if local audio is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1598
getLocalAudioFormats
▸ getLocalAudioFormats(): FormatInfo[]
Gets the local audio formats.
Returns: FormatInfo[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1610
getLocalAudioMuted
▸ getLocalAudioMuted(): boolean
Gets whether the local audio is muted.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1622
getLocalDataDisabled
▸ getLocalDataDisabled(): boolean
Gets if local data is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1637
getLocalDescription
▸ getLocalDescription(): SessionDescription
Gets the local description.
Returns: SessionDescription
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1649
getLocalVideoDisabled
▸ getLocalVideoDisabled(): boolean
Gets if local video is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1661
getLocalVideoFormats
▸ getLocalVideoFormats(): FormatInfo[]
Gets the local video formats.
Returns: FormatInfo[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1673
getLocalVideoMuted
▸ getLocalVideoMuted(): boolean
Gets whether the local video is muted.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1685
getMediaId
▸ getMediaId(): string
Gets the media identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1700
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1714
getMediaServerId
▸ getMediaServerId(): string
Gets the identifier of the Media Server handling this connection.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:249
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1728
getNoMediaServerTimeout
▸ getNoMediaServerTimeout(): number
Gets the timeout, in milliseconds, between retries for cases where no Media Servers are available for either ICE servers or SFU/MCU offer processing.
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1741
getPreferredMediaServerId
▸ getPreferredMediaServerId(): string
Gets the preferred identifier of the Media Server to handle this connection.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:261
getRecordingEnabled
▸ getRecordingEnabled(): boolean
Gets whether this connection is being recorded.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1753
getRemoteAudioDisabled
▸ getRemoteAudioDisabled(): boolean
Gets if remote audio is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1765
getRemoteAudioEncoding
▸ getRemoteAudioEncoding(): EncodingInfo
Gets the remote audio encoding.
Returns: EncodingInfo
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1777
getRemoteAudioFormats
▸ getRemoteAudioFormats(): FormatInfo[]
Gets the remote audio formats.
Returns: FormatInfo[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1789
getRemoteAudioMuted
▸ getRemoteAudioMuted(): boolean
Gets whether the remote audio is muted.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1801
getRemoteClosed
▸ getRemoteClosed(): boolean
Gets a value indicating whether the connection was closed by the remote host.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1817
getRemoteConnectionId
▸ getRemoteConnectionId(): string
Gets the remote connection identifier, if available.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1829
getRemoteDataDisabled
▸ getRemoteDataDisabled(): boolean
Gets if remote data is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1841
getRemoteDescription
▸ getRemoteDescription(): SessionDescription
Gets the remote description.
Returns: SessionDescription
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1853
getRemoteMediaId
▸ getRemoteMediaId(): string
Gets the remote media identifier, if available.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1873
getRemoteRejected
▸ getRemoteRejected(): boolean
Gets a value indicating whether the connection was rejected by the remote host.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1886
getRemoteTag
▸ getRemoteTag(): string
Gets the remote tag, if applicable.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1898
getRemoteVideoDisabled
▸ getRemoteVideoDisabled(): boolean
Gets if remote video is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1910
getRemoteVideoEncoding
▸ getRemoteVideoEncoding(): EncodingInfo
Gets the remote video encoding.
Returns: EncodingInfo
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1922
getRemoteVideoFormats
▸ getRemoteVideoFormats(): FormatInfo[]
Gets the remote video formats.
Returns: FormatInfo[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1934
getRemoteVideoMuted
▸ getRemoteVideoMuted(): boolean
Gets whether the remote video is muted.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1946
getSignallingState
▸ getSignallingState(): SignallingState
Gets the state of the signalling.
Returns: SignallingState
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1961
getState
▸ getState(): ConnectionState
Gets the state of the connection.
Returns: ConnectionState
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1973
getStats
▸ getStats(): Future<ConnectionStats>
Gets the current connection stats.
Returns: Future<ConnectionStats>
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1997
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2011
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2026
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2040
getTag
▸ getTag(): string
Gets the tag.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2052
getTrickleIcePolicy
▸ getTrickleIcePolicy(): TrickleIcePolicy
Gets the trickle-ICE policy.
Returns: TrickleIcePolicy
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2101
getType
▸ getType(): string
Gets the connection type.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2113
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:10
getUserId
▸ getUserId(): string
Gets the user identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2125
getVideoDirection
▸ getVideoDirection(): string
Gets the video direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2137
getVideoStream
▸ getVideoStream(): VideoStream
Gets the video stream.
Returns: VideoStream
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2149
getVideoUnmuteDisabled
▸ getVideoUnmuteDisabled(): boolean
Gets whether the ability to unmute video is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2161
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2174
open
▸ open(): Future<Object>
Opens the connection.
Returns: Future<Object>
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2285
processAnswer
▸ ProtectedprocessAnswer(message: Message): void
Processes an answer.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Message | The message. |
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:313
processError
▸ ProtectedprocessError(message: Message): void
Processes an error message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Message | The message. |
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:334
processIceServers
▸ ProtectedprocessIceServers(message: Message): void
Processes an iceServers message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Message | The message. |
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:357
processLocalError
▸ ProtectedprocessLocalError(error: Error): void
Processes a local failure.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
Error | The error. |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2506
processRtcpDataChannelSignallingActivation
▸ ProtectedprocessRtcpDataChannelSignallingActivation(message: Message): void
Processes inband signalling activation.
Parameters:
| Name | Type |
|---|---|
message |
Message |
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:371
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: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:415
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2747
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2760
raiseNoMediaServersAvailable
▸ ProtectedraiseNoMediaServersAvailable(args: NoMediaServersAvailableEventArgs): void
Raises the OnNoMediaServersAvailable event.
Parameters:
| Name | Type |
|---|---|
args |
NoMediaServersAvailableEventArgs |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2778
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2794
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: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:434
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2873
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2885
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2897
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2912
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2926
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2940
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: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:462
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: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:474
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2955
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2970
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2984
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2998
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3010
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3022
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3034
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3046
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3061
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3076
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3088
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3100
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3114
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3128
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3140
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3152
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3164
send
▸ Protectedsend(message: Message): Future<Message>
Sends a message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Message | The message. |
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:498
setBundlePolicy
▸ setBundlePolicy(value: BundlePolicy): void
Sets the Bundle Policy.
Parameters:
| Name | Type |
|---|---|
value |
BundlePolicy |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3373
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: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3417
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: Generated/TypeScript/fm.liveswitch/Dynamic.ts:95
setIceGatherPolicy
▸ setIceGatherPolicy(value: IceGatherPolicy): void
Sets the ICE gather policy.
Parameters:
| Name | Type |
|---|---|
value |
IceGatherPolicy |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3429
setIceServer
▸ setIceServer(value: IceServer): void
Sets the ICE server.
Parameters:
| Name | Type |
|---|---|
value |
IceServer |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3441
setIceServers
▸ setIceServers(value: IceServer[]): void
Sets the ICE servers.
Parameters:
| Name | Type |
|---|---|
value |
IceServer[] |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3453
setLayoutPriority
▸ setLayoutPriority(value: number): void
Sets the LayoutPriority.
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3481
setLayoutZone
▸ setLayoutZone(value: string): void
Sets the LayoutZone.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3493
setLocalAudioFormats
▸ ProtectedsetLocalAudioFormats(value: FormatInfo[]): void
Sets the local audio formats.
Parameters:
| Name | Type |
|---|---|
value |
FormatInfo[] |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3505
setLocalVideoFormats
▸ ProtectedsetLocalVideoFormats(value: FormatInfo[]): void
Sets the local video formats.
Parameters:
| Name | Type |
|---|---|
value |
FormatInfo[] |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3517
setMediaId
▸ ProtectedsetMediaId(value: string): void
Sets the media identifier.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3529
setNoMediaServerTimeout
▸ setNoMediaServerTimeout(value: number): void
Sets the timeout, in milliseconds, between retries for cases where no Media Servers are available for either ICE servers or SFU/MCU offer processing.
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3558
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: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:566
setRemoteAudioEncoding
▸ ProtectedsetRemoteAudioEncoding(value: EncodingInfo): void
Sets the remote audio encoding.
Parameters:
| Name | Type |
|---|---|
value |
EncodingInfo |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3579
setRemoteAudioFormats
▸ ProtectedsetRemoteAudioFormats(value: FormatInfo[]): void
Sets the remote audio formats.
Parameters:
| Name | Type |
|---|---|
value |
FormatInfo[] |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3599
setRemoteAudioMuted
▸ setRemoteAudioMuted(value: boolean): void
Sets whether the remote audio is muted.
Parameters:
| Name | Type |
|---|---|
value |
boolean |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3611
setRemoteConnectionId
▸ ProtectedsetRemoteConnectionId(value: string): void
Sets the remote connection identifier, if available.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3633
setRemoteMediaId
▸ ProtectedsetRemoteMediaId(value: string): void
Sets the remote media identifier, if available.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3653
setRemoteTag
▸ ProtectedsetRemoteTag(value: string): void
Sets the remote tag, if applicable.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3673
setRemoteVideoEncoding
▸ ProtectedsetRemoteVideoEncoding(value: EncodingInfo): void
Sets the remote video encoding.
Parameters:
| Name | Type |
|---|---|
value |
EncodingInfo |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3685
setRemoteVideoFormats
▸ ProtectedsetRemoteVideoFormats(value: FormatInfo[]): void
Sets the remote video formats.
Parameters:
| Name | Type |
|---|---|
value |
FormatInfo[] |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3705
setRemoteVideoMuted
▸ setRemoteVideoMuted(value: boolean): void
Sets whether the remote video is muted.
Parameters:
| Name | Type |
|---|---|
value |
boolean |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3717
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3733
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3749
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3764
setTag
▸ setTag(value: string): void
Sets the tag.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3777
setTrickleIcePolicy
▸ setTrickleIcePolicy(value: TrickleIcePolicy): void
Sets the trickle-ICE policy.
Parameters:
| Name | Type |
|---|---|
value |
TrickleIcePolicy |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3789
trySendRtcpDataChannel
▸ ProtectedtrySendRtcpDataChannel(message: Message): boolean
Sends bitrate messages.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Message | The message to send. |
Returns: boolean
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:591
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:122
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3882
getDefaultNoMediaServerTimeout
▸ StaticgetDefaultNoMediaServerTimeout(): number
Gets the default timeout, in milliseconds, between retries for cases
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:373
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:388
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:404
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:419
setDefaultNoMediaServerTimeout
▸ StaticsetDefaultNoMediaServerTimeout(value: number): void
Sets the default timeout, in milliseconds, between retries for cases
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:435
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:451
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:468
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: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:484