/ fm / liveswitch / ManagedConnection
Class: ManagedConnection
fm.liveswitch.ManagedConnection
A managed connection.
Hierarchy
-
↳ ManagedConnection
Table of contents
Methods
- addOnAudioUnmuteDisabled
- addOnAudioUnmuteEnabled
- addOnAutomaticIceServers
- addOnGatheringStateChange
- addOnIceConnectionStateChange
- addOnLocalCandidate
- addOnLocalDescription
- addOnMediaQuality
- addOnNetworkQuality
- addOnNoMediaServersAvailable
- addOnNoWebSocketMediaServersAvailable
- addOnRecordingDisabled
- addOnRecordingEnabled
- addOnRemoteAudioEncodingSwitch
- addOnRemoteCandidate
- addOnRemoteDescription
- addOnRemoteUpdate
- addOnRemoteVideoEncodingSwitch
- addOnSignallingStateChange
- addOnStateChange
- addOnStats
- addOnVideoUnmuteDisabled
- addOnVideoUnmuteEnabled
- close
- detachInternalEventHandlers
- doCreateCandidateMessage
- doCreateCloseMessage
- doCreateUpdateMessage
- doCreateUseWebSocketServiceMessage
- doOpen
- doProcessMessage
- fmliveswitchManagedConnectionInit
- getApplicationId
- getAudioDirection
- getAudioStream
- getAudioUnmuteDisabled
- getBundlePolicy
- getCanonicalName
- getChannelId
- getClientId
- getConfig
- getDataDirection
- getDataStream
- getDeadStreamTimeout
- getDeviceId
- getDisableAutomaticIceServers
- getDynamicProperties
- getDynamicValue
- getError
- getExternalId
- getGatheringState
- getHasAudio
- getHasData
- getHasVideo
- getIceConnectionState
- getIceGatherPolicy
- getIceServer
- getIceServers
- getId
- getInfo
- getInternalRtcpDataChannel
- getLayoutPriority
- getLayoutZone
- getLocalAudioDirection
- getLocalAudioDisabled
- getLocalAudioFormats
- getLocalAudioMuted
- getLocalDataDirection
- getLocalDataDisabled
- getLocalDescription
- getLocalVideoDirection
- getLocalVideoDisabled
- getLocalVideoFormats
- getLocalVideoMuted
- getMaxNoMediaServerRetryBackoff
- getMediaId
- getMediaProtocol
- getMediaQuality
- getMinNoMediaServerRetryBackoff
- getNetworkQuality
- getNoMediaServerTimeout
- getRandomizer
- 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
- getUseWebSocketsForMedia
- getUserId
- getVideoDirection
- getVideoStream
- getVideoUnmuteDisabled
- getWmsAddress
- getWmsConnectionToken
- isMediaDirectionAllowed
- open
- processAnswer
- processError
- processIceServers
- processLocalError
- processMediaIntentResponse
- processRtcpDataChannelSignallingActivation
- raiseAudioBitrateNotification
- raiseAudioBitrateRequest
- raiseLocalCandidate
- raiseNoMediaServersAvailable
- raiseNoWebSocketMediaServersAvailable
- raiseRemoteCandidate
- raiseVideoBitrateNotification
- raiseVideoBitrateRequest
- removeOnAudioUnmuteDisabled
- removeOnAudioUnmuteEnabled
- removeOnAutomaticIceServers
- removeOnGatheringStateChange
- removeOnIceConnectionStateChange
- removeOnLocalCandidate
- removeOnLocalDescription
- removeOnMediaQuality
- removeOnNetworkQuality
- removeOnNoMediaServersAvailable
- removeOnNoWebSocketMediaServersAvailable
- removeOnRecordingDisabled
- removeOnRecordingEnabled
- removeOnRemoteAudioEncodingSwitch
- removeOnRemoteCandidate
- removeOnRemoteDescription
- removeOnRemoteUpdate
- removeOnRemoteVideoEncodingSwitch
- removeOnSignallingStateChange
- removeOnStateChange
- removeOnStats
- removeOnVideoUnmuteDisabled
- removeOnVideoUnmuteEnabled
- send
- setBundlePolicy
- setDeadStreamTimeout
- setDisableAutomaticIceServers
- setDynamicValue
- setIceGatherPolicy
- setIceServer
- setIceServers
- setLayoutPriority
- setLayoutZone
- setLocalAudioFormats
- setLocalVideoFormats
- setMaxNoMediaServerRetryBackoff
- setMediaId
- setMinNoMediaServerRetryBackoff
- setNoMediaServerTimeout
- setRemoteAudioEncoding
- setRemoteAudioFormats
- setRemoteAudioMuted
- setRemoteConnectionId
- setRemoteMediaId
- setRemoteTag
- setRemoteVideoEncoding
- setRemoteVideoFormats
- setRemoteVideoMuted
- setStatsEventInterval
- setStatsInterval
- setStatsReportInterval
- setTag
- setTrickleIcePolicy
- setUseWebSocketsForMedia
- setWmsAddress
- setWmsConnectionToken
- 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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:679
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:691
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:706
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:720
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:734
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:749
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:764
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:778
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:792
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:804
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:816
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:828
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:840
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:852
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:867
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:882
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:894
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:906
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:920
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:934
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:946
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:958
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:970
close
▸ close(): Future<Object>
Closes the connection.
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:998
detachInternalEventHandlers
▸ Protected
detachInternalEventHandlers(): void
Detaches internal event handlers.
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1041
doCreateCandidateMessage
▸ Protected
Abstract
doCreateCandidateMessage(candidate
: Candidate): Message
Creates a candidate message.
Parameters:
Name | Type | Description |
---|---|---|
candidate |
Candidate | The candidate. |
Returns: Message
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1104
doCreateCloseMessage
▸ Protected
Abstract
doCreateCloseMessage(): Message
Creates a close message.
Returns: Message
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1110
doCreateUpdateMessage
▸ Protected
doCreateUpdateMessage(config
: ConnectionConfig): Message
Creates an update message.
Parameters:
Name | Type | Description |
---|---|---|
config |
ConnectionConfig | The connection config. |
Returns: Message
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1117
doCreateUseWebSocketServiceMessage
▸ Protected
doCreateUseWebSocketServiceMessage(): Message
Create the message to use WebSockets for media
Returns: Message
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1129
doOpen
▸ Protected
Abstract
doOpen(): void
Opens the connection.
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1141
doProcessMessage
▸ Protected
Abstract
doProcessMessage(message
: Message): void
Processes a message.
Parameters:
Name | Type | Description |
---|---|---|
message |
Message | The message. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1148
fmliveswitchManagedConnectionInit
▸ Private
fmliveswitchManagedConnectionInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:248
getApplicationId
▸ getApplicationId(): string
Gets the application identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1602
getAudioDirection
▸ getAudioDirection(): string
Gets the audio direction. Null if disabled.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1614
getAudioStream
▸ getAudioStream(): AudioStream
Gets the audio stream.
Returns: AudioStream
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1626
getAudioUnmuteDisabled
▸ getAudioUnmuteDisabled(): boolean
Gets whether the ability to unmute audio is disabled.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1638
getBundlePolicy
▸ getBundlePolicy(): BundlePolicy
Gets the Bundle Policy.
Returns: BundlePolicy
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1650
getCanonicalName
▸ getCanonicalName(): string
Gets the connection's canonical name.
deprecated
Use MediaStream.LocalCanonicalName instead.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1663
getChannelId
▸ getChannelId(): string
Gets the channel identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1675
getClientId
▸ getClientId(): string
Gets the client identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1687
getConfig
▸ getConfig(): ConnectionConfig
Gets the current configuration.
Returns: ConnectionConfig
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1699
getDataDirection
▸ getDataDirection(): string
Gets the data direction. Null if disabled.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1721
getDataStream
▸ getDataStream(): DataStream
Gets the data stream.
Returns: DataStream
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1733
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1749
getDeviceId
▸ getDeviceId(): string
Gets the device identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1761
getDisableAutomaticIceServers
▸ getDisableAutomaticIceServers(): boolean
Gets whether to disable automatic ICE servers (embedded TURN).
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1773
getDynamicProperties
▸ getDynamicProperties(): Hash<string, Object>
Gets all dynamic properties on this instance.
Returns: Hash<string, Object>
Inherited from: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:37
getDynamicValue
▸ getDynamicValue(key
: string): Object
Gets a property value from the local cache.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions. |
Returns: Object
The stored value, if found; otherwise null.
Inherited from: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:61
getError
▸ getError(): Error
Gets the error, if an error exists.
Returns: Error
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1785
getExternalId
▸ getExternalId(): string
Gets the external connection identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1797
getGatheringState
▸ getGatheringState(): IceGatheringState
Gets the state of the ice gathering.
Returns: IceGatheringState
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1809
getHasAudio
▸ getHasAudio(): boolean
Gets whether this connection has an audio stream.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1821
getHasData
▸ getHasData(): boolean
Gets whether this connection has a data stream.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1833
getHasVideo
▸ getHasVideo(): boolean
Gets whether this connection has a video stream.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1845
getIceConnectionState
▸ getIceConnectionState(): IceConnectionState
Gets the state of the ice connection.
Returns: IceConnectionState
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1857
getIceGatherPolicy
▸ getIceGatherPolicy(): IceGatherPolicy
Gets the ICE gather policy.
Returns: IceGatherPolicy
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1869
getIceServer
▸ getIceServer(): IceServer
Gets the ICE server.
Returns: IceServer
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1881
getIceServers
▸ getIceServers(): IceServer[]
Gets the ICE servers.
Returns: IceServer[]
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1893
getId
▸ getId(): string
Gets the connection identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1905
getInfo
▸ getInfo(): ConnectionInfo
Gets the connection info.
Returns: ConnectionInfo
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1917
getInternalRtcpDataChannel
▸ Protected
getInternalRtcpDataChannel(): DataChannel
Gets Data Channel for inband signalling.
Returns: DataChannel
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1971
getLayoutPriority
▸ getLayoutPriority(): number
Gets the LayoutPriority.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1983
getLayoutZone
▸ getLayoutZone(): string
Gets the LayoutZone.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1995
getLocalAudioDirection
▸ getLocalAudioDirection(): string
Gets the local audio direction. Null if disabled.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2007
getLocalAudioDisabled
▸ getLocalAudioDisabled(): boolean
Gets if local audio is disabled.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2019
getLocalAudioFormats
▸ getLocalAudioFormats(): FormatInfo[]
Gets the local audio formats.
Returns: FormatInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2031
getLocalAudioMuted
▸ getLocalAudioMuted(): boolean
Gets whether the local audio is muted.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2043
getLocalDataDirection
▸ getLocalDataDirection(): string
Gets the local data direction. Null if disabled.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2058
getLocalDataDisabled
▸ getLocalDataDisabled(): boolean
Gets if local data is disabled.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2070
getLocalDescription
▸ getLocalDescription(): SessionDescription
Gets the local description.
Returns: SessionDescription
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2082
getLocalVideoDirection
▸ getLocalVideoDirection(): string
Gets the local video direction. Null if disabled.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2094
getLocalVideoDisabled
▸ getLocalVideoDisabled(): boolean
Gets if local video is disabled.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2106
getLocalVideoFormats
▸ getLocalVideoFormats(): FormatInfo[]
Gets the local video formats.
Returns: FormatInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2118
getLocalVideoMuted
▸ getLocalVideoMuted(): boolean
Gets whether the local video is muted.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2130
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2148
getMediaId
▸ getMediaId(): string
Gets the media identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2160
getMediaProtocol
▸ getMediaProtocol(): MediaProtocol
Gets the media protocol in use on this connection.
Returns: MediaProtocol
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2180
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2194
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2209
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2223
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2236
getRandomizer
▸ Protected
getRandomizer(): Randomizer
Gets a randomizer for backoff timers
Returns: Randomizer
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2248
getRecordingEnabled
▸ getRecordingEnabled(): boolean
Gets whether this connection is being recorded.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2260
getRemoteAudioDisabled
▸ getRemoteAudioDisabled(): boolean
Gets if remote audio is disabled.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2272
getRemoteAudioEncoding
▸ getRemoteAudioEncoding(): EncodingInfo
Gets the remote audio encoding.
Returns: EncodingInfo
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2284
getRemoteAudioFormats
▸ getRemoteAudioFormats(): FormatInfo[]
Gets the remote audio formats.
Returns: FormatInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2296
getRemoteAudioMuted
▸ getRemoteAudioMuted(): boolean
Gets whether the remote audio is muted.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2308
getRemoteClosed
▸ getRemoteClosed(): boolean
Gets a value indicating whether the connection was closed by the remote host.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2324
getRemoteConnectionId
▸ getRemoteConnectionId(): string
Gets the remote connection identifier, if available.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2336
getRemoteDataDisabled
▸ getRemoteDataDisabled(): boolean
Gets if remote data is disabled.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2348
getRemoteDescription
▸ getRemoteDescription(): SessionDescription
Gets the remote description.
Returns: SessionDescription
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2360
getRemoteMediaId
▸ getRemoteMediaId(): string
Gets the remote media identifier, if available.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2380
getRemoteRejected
▸ getRemoteRejected(): boolean
Gets a value indicating whether the connection was rejected by the remote host.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2393
getRemoteTag
▸ getRemoteTag(): string
Gets the remote tag, if applicable.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2405
getRemoteVideoDisabled
▸ getRemoteVideoDisabled(): boolean
Gets if remote video is disabled.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2417
getRemoteVideoEncoding
▸ getRemoteVideoEncoding(): EncodingInfo
Gets the remote video encoding.
Returns: EncodingInfo
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2429
getRemoteVideoFormats
▸ getRemoteVideoFormats(): FormatInfo[]
Gets the remote video formats.
Returns: FormatInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2441
getRemoteVideoMuted
▸ getRemoteVideoMuted(): boolean
Gets whether the remote video is muted.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2453
getSignallingState
▸ getSignallingState(): SignallingState
Gets the state of the signalling.
Returns: SignallingState
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2468
getState
▸ getState(): ConnectionState
Gets the state of the connection.
Returns: ConnectionState
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2480
getStats
▸ getStats(): Future<ConnectionStats>
Gets the current connection stats.
Returns: Future<ConnectionStats>
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2504
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2518
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2533
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2547
getTag
▸ getTag(): string
Gets the tag.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2559
getTrickleIcePolicy
▸ getTrickleIcePolicy(): TrickleIcePolicy
Gets the trickle-ICE policy.
Returns: TrickleIcePolicy
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2609
getType
▸ getType(): string
Gets the connection type.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2621
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:10
getUseWebSocketsForMedia
▸ getUseWebSocketsForMedia(): boolean
Gets if we should use WebSockets for sending media.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2645
getUserId
▸ getUserId(): string
Gets the user identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2633
getVideoDirection
▸ getVideoDirection(): string
Gets the video direction. Null if disabled.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2657
getVideoStream
▸ getVideoStream(): VideoStream
Gets the video stream.
Returns: VideoStream
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2669
getVideoUnmuteDisabled
▸ getVideoUnmuteDisabled(): boolean
Gets whether the ability to unmute video is disabled.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2681
getWmsAddress
▸ getWmsAddress(): string
Gets the WMS endpoint address.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2693
getWmsConnectionToken
▸ getWmsConnectionToken(): string
Gets WMS connection token.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2705
isMediaDirectionAllowed
▸ Protected
Abstract
isMediaDirectionAllowed(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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2718
open
▸ open(): Future<Object>
Opens the connection.
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2838
processAnswer
▸ Protected
Abstract
processAnswer(message
: Message): void
Processes an answer.
Parameters:
Name | Type | Description |
---|---|---|
message |
Message | The message. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2898
processError
▸ Protected
processError(message
: Message): void
Processes an error message.
Parameters:
Name | Type | Description |
---|---|---|
message |
Message | The message. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3010
processIceServers
▸ Protected
processIceServers(message
: Message): void
Processes an iceServers message.
Parameters:
Name | Type | Description |
---|---|---|
message |
Message | The message. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3038
processLocalError
▸ Protected
processLocalError(error
: Error): void
Processes a local failure.
Parameters:
Name | Type | Description |
---|---|---|
error |
Error | The error. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3085
processMediaIntentResponse
▸ Protected
processMediaIntentResponse(message
: Message): void
Processes an iceServers message.
Parameters:
Name | Type | Description |
---|---|---|
message |
Message | The message. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3100
processRtcpDataChannelSignallingActivation
▸ Protected
processRtcpDataChannelSignallingActivation(message
: Message): void
Processes inband signalling activation.
Parameters:
Name | Type |
---|---|
message |
Message |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3328
raiseAudioBitrateNotification
▸ Protected
raiseAudioBitrateNotification(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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3374
raiseAudioBitrateRequest
▸ Protected
raiseAudioBitrateRequest(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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3388
raiseLocalCandidate
▸ Protected
raiseLocalCandidate(localCandidate
: Candidate): void
Raises a local candidate.
Parameters:
Name | Type | Description |
---|---|---|
localCandidate |
Candidate | The local candidate. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3401
raiseNoMediaServersAvailable
▸ Protected
raiseNoMediaServersAvailable(args
: NoMediaServersAvailableEventArgs): void
Raises the OnNoMediaServersAvailable event.
Parameters:
Name | Type |
---|---|
args |
NoMediaServersAvailableEventArgs |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3419
raiseNoWebSocketMediaServersAvailable
▸ Protected
raiseNoWebSocketMediaServersAvailable(args
: NoWebSocketMediaServersAvailableEventArgs): void
Raises the OnNoWebSocketMediaServersAvailable event.
Parameters:
Name | Type |
---|---|
args |
NoWebSocketMediaServersAvailableEventArgs |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3434
raiseRemoteCandidate
▸ Protected
raiseRemoteCandidate(remoteCandidate
: Candidate): void
Raises a remote candidate.
Parameters:
Name | Type | Description |
---|---|---|
remoteCandidate |
Candidate | The remote candidate. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3450
raiseVideoBitrateNotification
▸ Protected
raiseVideoBitrateNotification(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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3515
raiseVideoBitrateRequest
▸ Protected
raiseVideoBitrateRequest(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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3529
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3553
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3565
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3580
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3594
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3608
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3623
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3638
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3652
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3666
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3678
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3690
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3702
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3714
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3726
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3741
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3756
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3768
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3780
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3794
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3808
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3820
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3832
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3844
send
▸ Protected
send(message
: Message): Future<Message>
Sends a message.
Parameters:
Name | Type | Description |
---|---|---|
message |
Message | The message. |
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3945
setBundlePolicy
▸ setBundlePolicy(value
: BundlePolicy): void
Sets the Bundle Policy.
Parameters:
Name | Type |
---|---|
value |
BundlePolicy |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4107
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4147
setDisableAutomaticIceServers
▸ setDisableAutomaticIceServers(value
: boolean): void
Sets whether to disable automatic ICE servers (embedded TURN).
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4168
setDynamicValue
▸ setDynamicValue(key
: string, value
: Object): void
Sets a property value in the local cache.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions. |
value |
Object | The property value. This can be any object that needs to be stored for future use. |
Returns: void
Inherited from: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:98
setIceGatherPolicy
▸ setIceGatherPolicy(value
: IceGatherPolicy): void
Sets the ICE gather policy.
Parameters:
Name | Type |
---|---|
value |
IceGatherPolicy |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4180
setIceServer
▸ setIceServer(value
: IceServer): void
Sets the ICE server.
Parameters:
Name | Type |
---|---|
value |
IceServer |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4193
setIceServers
▸ setIceServers(value
: IceServer[]): void
Sets the ICE servers.
Parameters:
Name | Type |
---|---|
value |
IceServer[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4205
setLayoutPriority
▸ setLayoutPriority(value
: number): void
Sets the LayoutPriority.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4233
setLayoutZone
▸ setLayoutZone(value
: string): void
Sets the LayoutZone.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4245
setLocalAudioFormats
▸ Protected
setLocalAudioFormats(value
: FormatInfo[]): void
Sets the local audio formats.
Parameters:
Name | Type |
---|---|
value |
FormatInfo[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4257
setLocalVideoFormats
▸ Protected
setLocalVideoFormats(value
: FormatInfo[]): void
Sets the local video formats.
Parameters:
Name | Type |
---|---|
value |
FormatInfo[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4269
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4284
setMediaId
▸ Protected
setMediaId(value
: string): void
Sets the media identifier.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4297
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4328
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4350
setRemoteAudioEncoding
▸ Protected
setRemoteAudioEncoding(value
: EncodingInfo): void
Sets the remote audio encoding.
Parameters:
Name | Type |
---|---|
value |
EncodingInfo |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4371
setRemoteAudioFormats
▸ Protected
setRemoteAudioFormats(value
: FormatInfo[]): void
Sets the remote audio formats.
Parameters:
Name | Type |
---|---|
value |
FormatInfo[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4391
setRemoteAudioMuted
▸ setRemoteAudioMuted(value
: boolean): void
Sets whether the remote audio is muted.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4403
setRemoteConnectionId
▸ Protected
setRemoteConnectionId(value
: string): void
Sets the remote connection identifier, if available.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4425
setRemoteMediaId
▸ Protected
setRemoteMediaId(value
: string): void
Sets the remote media identifier, if available.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4445
setRemoteTag
▸ Protected
setRemoteTag(value
: string): void
Sets the remote tag, if applicable.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4465
setRemoteVideoEncoding
▸ Protected
setRemoteVideoEncoding(value
: EncodingInfo): void
Sets the remote video encoding.
Parameters:
Name | Type |
---|---|
value |
EncodingInfo |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4477
setRemoteVideoFormats
▸ Protected
setRemoteVideoFormats(value
: FormatInfo[]): void
Sets the remote video formats.
Parameters:
Name | Type |
---|---|
value |
FormatInfo[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4497
setRemoteVideoMuted
▸ setRemoteVideoMuted(value
: boolean): void
Sets whether the remote video is muted.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4509
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4525
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4541
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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4556
setTag
▸ setTag(value
: string): void
Sets the tag.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4569
setTrickleIcePolicy
▸ setTrickleIcePolicy(value
: TrickleIcePolicy): void
Sets the trickle-ICE policy.
Parameters:
Name | Type |
---|---|
value |
TrickleIcePolicy |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4581
setUseWebSocketsForMedia
▸ Protected
setUseWebSocketsForMedia(value
: boolean): void
Sets if we should use WebSockets for sending media.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4609
setWmsAddress
▸ setWmsAddress(value
: string): void
Sets the WMS endpoint address.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4637
setWmsConnectionToken
▸ setWmsConnectionToken(value
: string): void
Sets WMS connection token.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4649
trySendRtcpDataChannel
▸ Protected
trySendRtcpDataChannel(message
: Message): boolean
Sends bitrate messages.
Parameters:
Name | Type | Description |
---|---|---|
message |
Message | The message to send. |
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4696
unsetDynamicValue
▸ unsetDynamicValue(key
: string): boolean
Removes a property value from the local cache. Returns true if the value was removed and returns false otherwise.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions. |
Returns: boolean
true
if the value was removed; otherwise, false
.
Inherited from: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:125
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.
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4710
getDefaultNoMediaServerTimeout
▸ Static
getDefaultNoMediaServerTimeout(): 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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:554
getDefaultStatsEventInterval
▸ Static
getDefaultStatsEventInterval(): 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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:569
getDefaultStatsInterval
▸ Static
getDefaultStatsInterval(): 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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:585
getDefaultStatsReportInterval
▸ Static
getDefaultStatsReportInterval(): number
Gets the default interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:600
setDefaultNoMediaServerTimeout
▸ Static
setDefaultNoMediaServerTimeout(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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:616
setDefaultStatsEventInterval
▸ Static
setDefaultStatsEventInterval(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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:632
setDefaultStatsInterval
▸ Static
setDefaultStatsInterval(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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:649
setDefaultStatsReportInterval
▸ Static
setDefaultStatsReportInterval(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
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:665