/ 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
- addOnNoWebSocketMediaServersAvailable
- addOnRecordingDisabled
- addOnRecordingEnabled
- addOnRemoteAudioEncodingSwitch
- addOnRemoteCandidate
- addOnRemoteDescription
- addOnRemoteUpdate
- addOnRemoteVideoEncodingSwitch
- addOnSignallingStateChange
- addOnStateChange
- addOnStats
- addOnVideoUnmuteDisabled
- addOnVideoUnmuteEnabled
- close
- detachInternalEventHandlers
- doCreateCandidateMessage
- doCreateCloseMessage
- doCreateOfferMessage
- doCreateUpdateMessage
- doCreateUseWebSocketServiceMessage
- doOpen
- doProcessMessage
- fmliveswitchServerConnectionInit
- 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
- getInboundAudioBitrate
- getInboundVideoBitrate
- getInfo
- getInternalRtcpDataChannel
- getLayoutPriority
- getLayoutZone
- getLocalAudioDirection
- getLocalAudioDisabled
- getLocalAudioFormats
- getLocalAudioMuted
- getLocalDataDirection
- getLocalDataDisabled
- getLocalDescription
- getLocalVideoDirection
- getLocalVideoDisabled
- getLocalVideoFormats
- getLocalVideoMuted
- getMediaId
- getMediaProtocol
- 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
- 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
- removeOnInboundAudioBitrateChange
- removeOnInboundVideoBitrateChange
- 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
- setMediaId
- setNoMediaServerTimeout
- setPreferredMediaServerId
- 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
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:639
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:651
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:666
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:680
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:694
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:172
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:184
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:709
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:724
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:738
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:752
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:764
addOnNoWebSocketMediaServersAvailable
▸ addOnNoWebSocketMediaServersAvailable(value
: IAction2<ManagedConnection, NoWebSocketMediaServersAvailableEventArgs>): void
Adds a handler that is raised when there are no WebSocket Media Servers available.
Parameters:
Name | Type |
---|---|
value |
IAction2<ManagedConnection, NoWebSocketMediaServersAvailableEventArgs> |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:776
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:788
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:800
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:812
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:827
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:842
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:854
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:866
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:880
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:894
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:906
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:918
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:930
close
▸ close(): Future<Object>
Closes the connection.
Returns: Future<Object>
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:942
detachInternalEventHandlers
▸ Protected
detachInternalEventHandlers(): void
Detaches internal event handlers.
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:196
doCreateCandidateMessage
▸ Protected
doCreateCandidateMessage(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:215
doCreateCloseMessage
▸ Protected
doCreateCloseMessage(): Message
Creates a close message.
Returns: Message
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:227
doCreateOfferMessage
▸ Protected
Abstract
doCreateOfferMessage(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:240
doCreateUpdateMessage
▸ Protected
doCreateUpdateMessage(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:1055
doCreateUseWebSocketServiceMessage
▸ Protected
doCreateUseWebSocketServiceMessage(): Message
Create the message to use WebSockets for media
Returns: Message
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1067
doOpen
▸ Protected
doOpen(): void
Opens the connection.
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:246
doProcessMessage
▸ Protected
doProcessMessage(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:276
fmliveswitchServerConnectionInit
▸ Private
fmliveswitchServerConnectionInit(): 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:1429
getAudioDirection
▸ getAudioDirection(): string
Gets the audio direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1441
getAudioStream
▸ getAudioStream(): AudioStream
Gets the audio stream.
Returns: AudioStream
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1453
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:1465
getBundlePolicy
▸ getBundlePolicy(): BundlePolicy
Gets the Bundle Policy.
Returns: BundlePolicy
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1477
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:1490
getChannelId
▸ getChannelId(): string
Gets the channel identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1502
getClientId
▸ getClientId(): string
Gets the client identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1514
getConfig
▸ getConfig(): ConnectionConfig
Gets the current configuration.
Returns: ConnectionConfig
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1526
getDataDirection
▸ getDataDirection(): string
Gets the data direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1548
getDataStream
▸ getDataStream(): DataStream
Gets the data stream.
Returns: DataStream
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1560
getDeadStreamTimeout
▸ getDeadStreamTimeout(): number
Gets the amount of time (in milliseconds) to wait before declaring the connection dead. When there are no candidate pairs connected, the timer will start. When a candidate pair becomes connected the timer will be reset and stopped. If no candidate pairs become connected before the timeout is reached, the state of the connection will change to failed. Defaults to 15,000.
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1576
getDeviceId
▸ getDeviceId(): string
Gets the device identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1588
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:1600
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:1612
getExternalId
▸ getExternalId(): string
Gets the external connection identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1624
getGatheringState
▸ getGatheringState(): IceGatheringState
Gets the state of the ice gathering.
Returns: IceGatheringState
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1636
getHasAudio
▸ getHasAudio(): boolean
Gets whether this connection has an audio stream.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1648
getHasData
▸ getHasData(): boolean
Gets whether this connection has a data stream.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1660
getHasVideo
▸ getHasVideo(): boolean
Gets whether this connection has a video stream.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1672
getIceConnectionState
▸ getIceConnectionState(): IceConnectionState
Gets the state of the ice connection.
Returns: IceConnectionState
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1684
getIceGatherPolicy
▸ getIceGatherPolicy(): IceGatherPolicy
Gets the ICE gather policy.
Returns: IceGatherPolicy
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1696
getIceServer
▸ getIceServer(): IceServer
Gets the ICE server.
Returns: IceServer
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1708
getIceServers
▸ getIceServers(): IceServer[]
Gets the ICE servers.
Returns: IceServer[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1720
getId
▸ getId(): string
Gets the connection identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1732
getInboundAudioBitrate
▸ getInboundAudioBitrate(): number
Gets the current inbound audio bitrate.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:290
getInboundVideoBitrate
▸ getInboundVideoBitrate(): number
Gets the current inbound video bitrate.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:302
getInfo
▸ getInfo(): ConnectionInfo
Gets the connection info.
Returns: ConnectionInfo
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1744
getInternalRtcpDataChannel
▸ Protected
getInternalRtcpDataChannel(): DataChannel
Gets Data Channel for inband signalling.
Returns: DataChannel
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1798
getLayoutPriority
▸ getLayoutPriority(): number
Gets the LayoutPriority.
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1810
getLayoutZone
▸ getLayoutZone(): string
Gets the LayoutZone.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1822
getLocalAudioDirection
▸ getLocalAudioDirection(): string
Gets the local audio direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1834
getLocalAudioDisabled
▸ getLocalAudioDisabled(): boolean
Gets if local audio is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1846
getLocalAudioFormats
▸ getLocalAudioFormats(): FormatInfo[]
Gets the local audio formats.
Returns: FormatInfo[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1858
getLocalAudioMuted
▸ getLocalAudioMuted(): boolean
Gets whether the local audio is muted.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1870
getLocalDataDirection
▸ getLocalDataDirection(): string
Gets the local data direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1885
getLocalDataDisabled
▸ getLocalDataDisabled(): boolean
Gets if local data is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1897
getLocalDescription
▸ getLocalDescription(): SessionDescription
Gets the local description.
Returns: SessionDescription
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1909
getLocalVideoDirection
▸ getLocalVideoDirection(): string
Gets the local video direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1921
getLocalVideoDisabled
▸ getLocalVideoDisabled(): boolean
Gets if local video is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1933
getLocalVideoFormats
▸ getLocalVideoFormats(): FormatInfo[]
Gets the local video formats.
Returns: FormatInfo[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1945
getLocalVideoMuted
▸ getLocalVideoMuted(): boolean
Gets whether the local video is muted.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1957
getMediaId
▸ getMediaId(): string
Gets the media identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1972
getMediaProtocol
▸ getMediaProtocol(): MediaProtocol
Gets the media protocol in use on this connection.
Returns: MediaProtocol
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1992
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:2006
getMediaServerId
▸ getMediaServerId(): string
Gets the identifier of the Media Server handling this connection.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:314
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:2020
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:2033
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:334
getRecordingEnabled
▸ getRecordingEnabled(): boolean
Gets whether this connection is being recorded.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2045
getRemoteAudioDisabled
▸ getRemoteAudioDisabled(): boolean
Gets if remote audio is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2057
getRemoteAudioEncoding
▸ getRemoteAudioEncoding(): EncodingInfo
Gets the remote audio encoding.
Returns: EncodingInfo
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2069
getRemoteAudioFormats
▸ getRemoteAudioFormats(): FormatInfo[]
Gets the remote audio formats.
Returns: FormatInfo[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2081
getRemoteAudioMuted
▸ getRemoteAudioMuted(): boolean
Gets whether the remote audio is muted.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2093
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:2109
getRemoteConnectionId
▸ getRemoteConnectionId(): string
Gets the remote connection identifier, if available.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2121
getRemoteDataDisabled
▸ getRemoteDataDisabled(): boolean
Gets if remote data is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2133
getRemoteDescription
▸ getRemoteDescription(): SessionDescription
Gets the remote description.
Returns: SessionDescription
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2145
getRemoteMediaId
▸ getRemoteMediaId(): string
Gets the remote media identifier, if available.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2165
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:2178
getRemoteTag
▸ getRemoteTag(): string
Gets the remote tag, if applicable.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2190
getRemoteVideoDisabled
▸ getRemoteVideoDisabled(): boolean
Gets if remote video is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2202
getRemoteVideoEncoding
▸ getRemoteVideoEncoding(): EncodingInfo
Gets the remote video encoding.
Returns: EncodingInfo
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2214
getRemoteVideoFormats
▸ getRemoteVideoFormats(): FormatInfo[]
Gets the remote video formats.
Returns: FormatInfo[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2226
getRemoteVideoMuted
▸ getRemoteVideoMuted(): boolean
Gets whether the remote video is muted.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2238
getSignallingState
▸ getSignallingState(): SignallingState
Gets the state of the signalling.
Returns: SignallingState
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2253
getState
▸ getState(): ConnectionState
Gets the state of the connection.
Returns: ConnectionState
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2265
getStats
▸ getStats(): Future<ConnectionStats>
Gets the current connection stats.
Returns: Future<ConnectionStats>
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2289
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:2303
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:2318
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:2332
getTag
▸ getTag(): string
Gets the tag.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2344
getTrickleIcePolicy
▸ getTrickleIcePolicy(): TrickleIcePolicy
Gets the trickle-ICE policy.
Returns: TrickleIcePolicy
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2394
getType
▸ getType(): string
Gets the connection type.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2406
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:10
getUseWebSocketsForMedia
▸ getUseWebSocketsForMedia(): boolean
Gets if we should use WebSockets for sending media.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2430
getUserId
▸ getUserId(): string
Gets the user identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2418
getVideoDirection
▸ getVideoDirection(): string
Gets the video direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2442
getVideoStream
▸ getVideoStream(): VideoStream
Gets the video stream.
Returns: VideoStream
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2454
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:2466
getWmsAddress
▸ getWmsAddress(): string
Gets the WMS endpoint address.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2478
getWmsConnectionToken
▸ getWmsConnectionToken(): string
Gets WMS connection token.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2490
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
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2503
open
▸ open(): Future<Object>
Opens the connection.
Returns: Future<Object>
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2623
processAnswer
▸ Protected
processAnswer(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:386
processError
▸ Protected
processError(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:407
processIceServers
▸ Protected
processIceServers(message
: Message): void
Processes an iceServers message.
Parameters:
Name | Type | Description |
---|---|---|
message |
Message | The message. |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2823
processLocalError
▸ Protected
processLocalError(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:2870
processMediaIntentResponse
▸ Protected
processMediaIntentResponse(message
: Message): void
Processes an MediaIntentResponse message.
Parameters:
Name | Type | Description |
---|---|---|
message |
Message | The message. |
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:430
processRtcpDataChannelSignallingActivation
▸ Protected
processRtcpDataChannelSignallingActivation(message
: Message): void
Processes inband signalling activation.
Parameters:
Name | Type |
---|---|
message |
Message |
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:444
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
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:488
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
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3155
raiseLocalCandidate
▸ Protected
raiseLocalCandidate(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:3168
raiseNoMediaServersAvailable
▸ Protected
raiseNoMediaServersAvailable(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:3186
raiseNoWebSocketMediaServersAvailable
▸ Protected
raiseNoWebSocketMediaServersAvailable(args
: NoWebSocketMediaServersAvailableEventArgs): void
Raises the OnNoWebSocketMediaServersAvailable event.
Parameters:
Name | Type |
---|---|
args |
NoWebSocketMediaServersAvailableEventArgs |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3201
raiseRemoteCandidate
▸ Protected
raiseRemoteCandidate(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:3217
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
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ServerConnection.ts:507
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
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3296
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:3320
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:3332
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:3347
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:3361
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:3375
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:535
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:547
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:3390
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:3405
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:3419
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:3433
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:3445
removeOnNoWebSocketMediaServersAvailable
▸ removeOnNoWebSocketMediaServersAvailable(value
: IAction2<ManagedConnection, NoWebSocketMediaServersAvailableEventArgs>): void
Removes a handler that is raised when there are no WebSocket Media Servers available.
Parameters:
Name | Type |
---|---|
value |
IAction2<ManagedConnection, NoWebSocketMediaServersAvailableEventArgs> |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3457
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:3469
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:3481
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:3493
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:3508
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:3523
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:3535
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:3547
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:3561
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:3575
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:3587
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:3599
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:3611
send
▸ Protected
send(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:571
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:3898
setDeadStreamTimeout
▸ setDeadStreamTimeout(value
: number): void
Sets the amount of time (in milliseconds) to wait before declaring the connection dead. When there are no candidate pairs connected, the timer will start. When a candidate pair becomes connected the timer will be reset and stopped. If no candidate pairs become connected before the timeout is reached, the state of the connection will change to failed. Defaults to 15,000.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3938
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:3959
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:3971
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:3984
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:3996
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:4024
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:4036
setLocalAudioFormats
▸ Protected
setLocalAudioFormats(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:4048
setLocalVideoFormats
▸ Protected
setLocalVideoFormats(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:4060
setMediaId
▸ Protected
setMediaId(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:4072
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:4109
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:649
setRemoteAudioEncoding
▸ Protected
setRemoteAudioEncoding(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:4130
setRemoteAudioFormats
▸ Protected
setRemoteAudioFormats(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:4150
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:4162
setRemoteConnectionId
▸ Protected
setRemoteConnectionId(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:4184
setRemoteMediaId
▸ Protected
setRemoteMediaId(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:4204
setRemoteTag
▸ Protected
setRemoteTag(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:4224
setRemoteVideoEncoding
▸ Protected
setRemoteVideoEncoding(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:4236
setRemoteVideoFormats
▸ Protected
setRemoteVideoFormats(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:4256
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:4268
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:4284
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:4300
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:4315
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:4328
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:4340
setUseWebSocketsForMedia
▸ Protected
setUseWebSocketsForMedia(value
: boolean): void
Sets if we should use WebSockets for sending media.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4368
setWmsAddress
▸ setWmsAddress(value
: string): void
Sets the WMS endpoint address.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4396
setWmsConnectionToken
▸ setWmsConnectionToken(value
: string): void
Sets WMS connection token.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4408
trySendRtcpDataChannel
▸ Protected
trySendRtcpDataChannel(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:674
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:4469
getDefaultNoMediaServerTimeout
▸ Static
getDefaultNoMediaServerTimeout(): 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:514
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
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:529
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
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:545
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
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:560
setDefaultNoMediaServerTimeout
▸ Static
setDefaultNoMediaServerTimeout(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:576
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
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:592
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
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:609
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
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:625