/ fm / liveswitch / PeerConnection
Class: PeerConnection
fm.liveswitch.PeerConnection
A peer connection.
Hierarchy
-
↳ PeerConnection
Table of contents
Constructors
Methods
- addOnAudioUnmuteDisabled
- addOnAudioUnmuteEnabled
- addOnAutomaticIceServers
- addOnGatheringStateChange
- addOnIceConnectionStateChange
- addOnLocalCandidate
- addOnLocalDescription
- addOnMediaQuality
- addOnNetworkQuality
- addOnNoMediaServersAvailable
- addOnNoWebSocketMediaServersAvailable
- addOnRecordingDisabled
- addOnRecordingEnabled
- addOnRemoteAudioEncodingSwitch
- addOnRemoteCandidate
- addOnRemoteDescription
- addOnRemoteUpdate
- addOnRemoteVideoEncodingSwitch
- addOnSignallingStateChange
- addOnStateChange
- addOnStats
- addOnVideoEnabledChange
- addOnVideoUnmuteDisabled
- addOnVideoUnmuteEnabled
- close
- detachInternalEventHandlers
- doCreateCandidateMessage
- doCreateCloseMessage
- doCreateUpdateMessage
- doCreateUseWebSocketServiceMessage
- doOpen
- doProcessMessage
- fmliveswitchPeerConnectionInit
- 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
- getRemoteClientInfo
- getRemoteClosed
- getRemoteConnectionId
- getRemoteDataDisabled
- getRemoteDescription
- getRemoteMediaId
- getRemoteRejected
- getRemoteTag
- getRemoteVideoDisabled
- getRemoteVideoEncoding
- getRemoteVideoFormats
- getRemoteVideoMuted
- getRole
- getSignallingState
- getState
- getStats
- getStatsEventInterval
- getStatsInterval
- getStatsReportInterval
- getTag
- getTrickleIcePolicy
- getType
- getTypeString
- getUseWebSocketsForMedia
- getUserId
- getVideoDirection
- getVideoEnabledConnectionUpdateAttempts
- getVideoEnabledUpdateConnectionPolicy
- getVideoRetentionPolicy
- getVideoStream
- getVideoUnmuteDisabled
- getWmsAddress
- getWmsConnectionToken
- isMediaDirectionAllowed
- open
- processAnswer
- processError
- processIceServers
- processLocalError
- processMediaIntentResponse
- processRtcpDataChannelSignallingActivation
- processSimulcastNotification
- 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
- removeOnVideoEnabledChange
- 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
- setVideoEnabledUpdateConnectionPolicy
- setVideoRetentionPolicy
- setWmsAddress
- setWmsConnectionToken
- trySendRtcpDataChannel
- unsetDynamicValue
- update
- getDefaultNoMediaServerTimeout
- getDefaultStatsEventInterval
- getDefaultStatsInterval
- getDefaultStatsReportInterval
- setDefaultNoMediaServerTimeout
- setDefaultStatsEventInterval
- setDefaultStatsInterval
- setDefaultStatsReportInterval
Constructors
constructor
+ new PeerConnection(sharedLock: Object, applicationId: string, channelId: string, userId: string, deviceId: string, clientId: string, send: IFunction1<Message, Future<Message>>, remoteClientInfo: ClientInfo, audioStream: AudioStream, videoStream: VideoStream, dataStream: DataStream): PeerConnection
Parameters:
| Name | Type |
|---|---|
sharedLock |
Object |
applicationId |
string |
channelId |
string |
userId |
string |
deviceId |
string |
clientId |
string |
send |
IFunction1<Message, Future<Message>> |
remoteClientInfo |
ClientInfo |
audioStream |
AudioStream |
videoStream |
VideoStream |
dataStream |
DataStream |
Returns: PeerConnection
Defined in: Tools/BuildAPIDocs/Generated/TypeScript/fm.liveswitch/PeerConnection.ts:29
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:701
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:713
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:728
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:742
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:756
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:771
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:786
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:800
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:814
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:826
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:838
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:850
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:862
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:874
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:889
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:904
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:916
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:928
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:942
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:956
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:968
addOnVideoEnabledChange
▸ addOnVideoEnabledChange(value: IAction2<ManagedConnection, boolean>): void
Adds a handler that is raised when a connection has it's video state changed from disabled or enabled. Due to connection constrainsts. Parameters:
- connection - the connection
- videoEnabled - the value indicating true if the video has been enabled or false for disabled.
Parameters:
| Name | Type |
|---|---|
value |
IAction2<ManagedConnection, boolean> |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:983
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:995
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:1007
close
▸ close(): Future<Object>
Closes the connection.
Returns: Future<Object>
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1035
detachInternalEventHandlers
▸ ProtecteddetachInternalEventHandlers(): void
Detaches internal event handlers.
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:89
doCreateCandidateMessage
▸ ProtecteddoCreateCandidateMessage(candidate: Candidate): Message
Creates a candidate message.
Parameters:
| Name | Type | Description |
|---|---|---|
candidate |
Candidate | The candidate. |
Returns: Message
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:104
doCreateCloseMessage
▸ ProtecteddoCreateCloseMessage(): Message
Creates a close message.
Returns: Message
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:116
doCreateUpdateMessage
▸ ProtecteddoCreateUpdateMessage(config: ConnectionConfig): Message
Creates an update message.
Parameters:
| Name | Type | Description |
|---|---|---|
config |
ConnectionConfig | The connection config. |
Returns: Message
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:129
doCreateUseWebSocketServiceMessage
▸ ProtecteddoCreateUseWebSocketServiceMessage(): Message
Create the message to use WebSockets for media
Returns: Message
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1178
doOpen
▸ ProtecteddoOpen(): void
Opens the connection.
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:141
doProcessMessage
▸ ProtecteddoProcessMessage(message: Message): void
Processes a message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Message | The message. |
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:216
fmliveswitchPeerConnectionInit
▸ PrivatefmliveswitchPeerConnectionInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:24
getApplicationId
▸ getApplicationId(): string
Gets the application identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1685
getAudioDirection
▸ getAudioDirection(): string
Gets the audio direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1697
getAudioStream
▸ getAudioStream(): AudioStream
Gets the audio stream.
Returns: AudioStream
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1709
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:1721
getBundlePolicy
▸ getBundlePolicy(): BundlePolicy
Gets the Bundle Policy.
Returns: BundlePolicy
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1733
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:1746
getChannelId
▸ getChannelId(): string
Gets the channel identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1758
getClientId
▸ getClientId(): string
Gets the client identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1770
getConfig
▸ getConfig(): ConnectionConfig
Gets the current configuration.
Returns: ConnectionConfig
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1782
getDataDirection
▸ getDataDirection(): string
Gets the data direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1804
getDataStream
▸ getDataStream(): DataStream
Gets the data stream.
Returns: DataStream
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1816
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:1832
getDeviceId
▸ getDeviceId(): string
Gets the device identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1844
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:1856
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:61
getError
▸ getError(): Error
Gets the error, if an error exists.
Returns: Error
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1868
getExternalId
▸ getExternalId(): string
Gets the external connection identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1880
getGatheringState
▸ getGatheringState(): IceGatheringState
Gets the state of the ice gathering.
Returns: IceGatheringState
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1892
getHasAudio
▸ getHasAudio(): boolean
Gets whether this connection has an audio stream.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1904
getHasData
▸ getHasData(): boolean
Gets whether this connection has a data stream.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1916
getHasVideo
▸ getHasVideo(): boolean
Gets whether this connection has a video stream.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1928
getIceConnectionState
▸ getIceConnectionState(): IceConnectionState
Gets the state of the ice connection.
Returns: IceConnectionState
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1940
getIceGatherPolicy
▸ getIceGatherPolicy(): IceGatherPolicy
Gets the ICE gather policy.
Returns: IceGatherPolicy
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1952
getIceServer
▸ getIceServer(): IceServer
Gets the ICE server.
Returns: IceServer
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1964
getIceServers
▸ getIceServers(): IceServer[]
Gets the ICE servers.
Returns: IceServer[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1976
getId
▸ getId(): string
Gets the connection identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:1988
getInfo
▸ getInfo(): ConnectionInfo
Gets the connection info.
Returns: ConnectionInfo
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2000
getInternalRtcpDataChannel
▸ ProtectedgetInternalRtcpDataChannel(): DataChannel
Gets Data Channel for inband signalling.
Returns: DataChannel
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2054
getLayoutPriority
▸ getLayoutPriority(): number
Gets the LayoutPriority.
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2066
getLayoutZone
▸ getLayoutZone(): string
Gets the LayoutZone.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2078
getLocalAudioDirection
▸ getLocalAudioDirection(): string
Gets the local audio direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2090
getLocalAudioDisabled
▸ getLocalAudioDisabled(): boolean
Gets if local audio is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2102
getLocalAudioFormats
▸ getLocalAudioFormats(): FormatInfo[]
Gets the local audio formats.
Returns: FormatInfo[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2114
getLocalAudioMuted
▸ getLocalAudioMuted(): boolean
Gets whether the local audio is muted.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2126
getLocalDataDirection
▸ getLocalDataDirection(): string
Gets the local data direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2141
getLocalDataDisabled
▸ getLocalDataDisabled(): boolean
Gets if local data is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2153
getLocalDescription
▸ getLocalDescription(): SessionDescription
Gets the local description.
Returns: SessionDescription
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2165
getLocalVideoDirection
▸ getLocalVideoDirection(): string
Gets the local video direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2177
getLocalVideoDisabled
▸ getLocalVideoDisabled(): boolean
Gets if local video is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2189
getLocalVideoFormats
▸ getLocalVideoFormats(): FormatInfo[]
Gets the local video formats.
Returns: FormatInfo[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2201
getLocalVideoMuted
▸ getLocalVideoMuted(): boolean
Gets whether the local video is muted.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2213
getMaxNoMediaServerRetryBackoff
▸ getMaxNoMediaServerRetryBackoff(): number
Gets the maximum retry backoff timeout, in milliseconds, before we retry a request
after receiving no Media Servers are available for either ICE servers or SFU/MCU offer processing.
The default value is 1500ms.
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2231
getMediaId
▸ getMediaId(): string
Gets the media identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2243
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:2263
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:2277
getMinNoMediaServerRetryBackoff
▸ getMinNoMediaServerRetryBackoff(): number
Gets the mininum retry backoff timeout, in milliseconds, before we retry a request
after receiving no Media Servers are available for either ICE servers or SFU/MCU offer processing.
The default value is 1000ms.
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2292
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:2306
getNoMediaServerTimeout
▸ getNoMediaServerTimeout(): number
Gets the timeout, in milliseconds, before failing a request where no Media Servers are available for either ICE servers or SFU/MCU offer processing.
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2319
getRandomizer
▸ ProtectedgetRandomizer(): Randomizer
Gets a randomizer for backoff timers
Returns: Randomizer
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2331
getRecordingEnabled
▸ getRecordingEnabled(): boolean
Gets whether this connection is being recorded.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2343
getRemoteAudioDisabled
▸ getRemoteAudioDisabled(): boolean
Gets if remote audio is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2355
getRemoteAudioEncoding
▸ getRemoteAudioEncoding(): EncodingInfo
Gets the remote audio encoding.
Returns: EncodingInfo
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2367
getRemoteAudioFormats
▸ getRemoteAudioFormats(): FormatInfo[]
Gets the remote audio formats.
Returns: FormatInfo[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2379
getRemoteAudioMuted
▸ getRemoteAudioMuted(): boolean
Gets whether the remote audio is muted.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2391
getRemoteClientInfo
▸ getRemoteClientInfo(): ClientInfo
Gets the remote client information.
Returns: ClientInfo
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:230
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:2407
getRemoteConnectionId
▸ getRemoteConnectionId(): string
Gets the remote connection identifier, if available.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2419
getRemoteDataDisabled
▸ getRemoteDataDisabled(): boolean
Gets if remote data is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2431
getRemoteDescription
▸ getRemoteDescription(): SessionDescription
Gets the remote description.
Returns: SessionDescription
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2443
getRemoteMediaId
▸ getRemoteMediaId(): string
Gets the remote media identifier, if available.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2463
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:2476
getRemoteTag
▸ getRemoteTag(): string
Gets the remote tag, if applicable.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2488
getRemoteVideoDisabled
▸ getRemoteVideoDisabled(): boolean
Gets if remote video is disabled.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2500
getRemoteVideoEncoding
▸ getRemoteVideoEncoding(): EncodingInfo
Gets the remote video encoding.
Returns: EncodingInfo
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2512
getRemoteVideoFormats
▸ getRemoteVideoFormats(): FormatInfo[]
Gets the remote video formats.
Returns: FormatInfo[]
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2524
getRemoteVideoMuted
▸ getRemoteVideoMuted(): boolean
Gets whether the remote video is muted.
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2536
getRole
▸ getRole(): PeerRole
Gets the role.
Returns: PeerRole
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:242
getSignallingState
▸ getSignallingState(): SignallingState
Gets the state of the signalling.
Returns: SignallingState
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2551
getState
▸ getState(): ConnectionState
Gets the state of the connection.
Returns: ConnectionState
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2563
getStats
▸ getStats(): Future<ConnectionStats>
Gets the current connection stats.
Returns: Future<ConnectionStats>
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2587
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:2601
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:2616
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:2630
getTag
▸ getTag(): string
Gets the tag.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2642
getTrickleIcePolicy
▸ getTrickleIcePolicy(): TrickleIcePolicy
Gets the trickle-ICE policy.
Returns: TrickleIcePolicy
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2692
getType
▸ getType(): string
Gets the connection type.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2704
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.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:2728
getUserId
▸ getUserId(): string
Gets the user identifier.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2716
getVideoDirection
▸ getVideoDirection(): string
Gets the video direction. Null if disabled.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2740
getVideoEnabledConnectionUpdateAttempts
▸ getVideoEnabledConnectionUpdateAttempts(): number
Gets the amount of attempts this connection has made to enabled video on a connection. These attempts happen after the connection has been updated to disabled video due to network constraints.
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2753
getVideoEnabledUpdateConnectionPolicy
▸ getVideoEnabledUpdateConnectionPolicy(): IFunction1<number, number>
Gets a method that determines when to enable video again on a connection that dynamically disables video. Optional. If not set, default policy will be used. Takes in an interger parameter that represents the amount of attempts already tried. Will return an interger value as a time period in seconds for how long to wait for the next attempt or -1 for no more attempts.
Returns: IFunction1<number, number>
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2766
getVideoRetentionPolicy
▸ getVideoRetentionPolicy(): VideoRetentionPolicy
Gets the Video Retention Policy. This will determine how we will handle video on the connection when the connection is of poor quality.
Returns: VideoRetentionPolicy
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2779
getVideoStream
▸ getVideoStream(): VideoStream
Gets the video stream.
Returns: VideoStream
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2791
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:2803
getWmsAddress
▸ getWmsAddress(): string
Gets the WMS endpoint address.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2815
getWmsConnectionToken
▸ getWmsConnectionToken(): string
Gets WMS connection token.
Returns: string
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2827
isMediaDirectionAllowed
▸ ProtectedisMediaDirectionAllowed(direction: string): boolean
Gets a value indicating whether the given media direction is allowed for this connection.
Parameters:
| Name | Type | Description |
|---|---|---|
direction |
string | The direction. |
Returns: boolean
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:255
open
▸ open(): Future<Object>
Opens the connection.
Returns: Future<Object>
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:2960
processAnswer
▸ ProtectedprocessAnswer(message: Message): void
Processes an answer.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Message | The message. |
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:288
processError
▸ ProtectedprocessError(message: Message): void
Processes an error message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Message | The message. |
Returns: void
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:311
processIceServers
▸ ProtectedprocessIceServers(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:3160
processLocalError
▸ ProtectedprocessLocalError(error: Error): void
Processes a local failure.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
Error | The error. |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3207
processMediaIntentResponse
▸ ProtectedprocessMediaIntentResponse(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:3222
processRtcpDataChannelSignallingActivation
▸ ProtectedprocessRtcpDataChannelSignallingActivation(message: Message): void
Processes inband signalling activation.
Parameters:
| Name | Type |
|---|---|
message |
Message |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3454
processSimulcastNotification
▸ ProtectedprocessSimulcastNotification(message: Message): void
Processes a simulcast notification
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Message | The simulcast notificaiton message. |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3466
raiseAudioBitrateNotification
▸ ProtectedraiseAudioBitrateNotification(audioStream: AudioStream, bitrateNotification: BitrateNotification): void
Raises an audio bitrate notification.
Parameters:
| Name | Type | Description |
|---|---|---|
audioStream |
AudioStream | The audio stream. |
bitrateNotification |
BitrateNotification | The bitrate notification. |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3563
raiseAudioBitrateRequest
▸ ProtectedraiseAudioBitrateRequest(audioStream: AudioStream, bitrateRequest: BitrateRequest): void
Raises an audio bitrate request.
Parameters:
| Name | Type | Description |
|---|---|---|
audioStream |
AudioStream | The audio stream. |
bitrateRequest |
BitrateRequest | The bitrate request. |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3577
raiseLocalCandidate
▸ ProtectedraiseLocalCandidate(localCandidate: Candidate): void
Raises a local candidate.
Parameters:
| Name | Type | Description |
|---|---|---|
localCandidate |
Candidate | The local candidate. |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3590
raiseNoMediaServersAvailable
▸ ProtectedraiseNoMediaServersAvailable(args: NoMediaServersAvailableEventArgs): void
Raises the OnNoMediaServersAvailable event.
Parameters:
| Name | Type |
|---|---|
args |
NoMediaServersAvailableEventArgs |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3608
raiseNoWebSocketMediaServersAvailable
▸ ProtectedraiseNoWebSocketMediaServersAvailable(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:3623
raiseRemoteCandidate
▸ ProtectedraiseRemoteCandidate(remoteCandidate: Candidate): void
Raises a remote candidate.
Parameters:
| Name | Type | Description |
|---|---|---|
remoteCandidate |
Candidate | The remote candidate. |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3639
raiseVideoBitrateNotification
▸ ProtectedraiseVideoBitrateNotification(videoStream: VideoStream, bitrateNotification: BitrateNotification): void
Raises a video bitrate notification.
Parameters:
| Name | Type | Description |
|---|---|---|
videoStream |
VideoStream | The video stream. |
bitrateNotification |
BitrateNotification | The bitrate notification. |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3704
raiseVideoBitrateRequest
▸ ProtectedraiseVideoBitrateRequest(videoStream: VideoStream, bitrateRequest: BitrateRequest): void
Raises a video bitrate request.
Parameters:
| Name | Type | Description |
|---|---|---|
videoStream |
VideoStream | The video stream. |
bitrateRequest |
BitrateRequest | The bitrate request. |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:3718
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:3742
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:3754
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:3769
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:3783
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:3797
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:3812
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:3827
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:3841
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:3855
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:3867
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:3879
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:3891
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:3903
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:3915
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:3930
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:3945
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:3957
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:3969
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:3983
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:3997
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:4009
removeOnVideoEnabledChange
▸ removeOnVideoEnabledChange(value: IAction2<ManagedConnection, boolean>): void
Removes a handler that is raised when a connection has it's video state changed from disabled or enabled. Due to connection constrainsts. Parameters:
- connection - the connection
- videoEnabled - the value indicating true if the video has been enabled or false for disabled.
Parameters:
| Name | Type |
|---|---|
value |
IAction2<ManagedConnection, boolean> |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4024
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:4036
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:4048
send
▸ Protectedsend(message: Message): Future<Message>
Sends a message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Message | The message. |
Overrides: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/PeerConnection.ts:350
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:4311
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:4351
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:4372
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:98
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:4384
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:4397
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:4409
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:4437
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:4449
setLocalAudioFormats
▸ ProtectedsetLocalAudioFormats(value: FormatInfo[]): void
Sets the local audio formats.
Parameters:
| Name | Type |
|---|---|
value |
FormatInfo[] |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4461
setLocalVideoFormats
▸ ProtectedsetLocalVideoFormats(value: FormatInfo[]): void
Sets the local video formats.
Parameters:
| Name | Type |
|---|---|
value |
FormatInfo[] |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4473
setMaxNoMediaServerRetryBackoff
▸ setMaxNoMediaServerRetryBackoff(value: number): void
Sets the maximum retry backoff timeout, in milliseconds, before we retry a request
after receiving no Media Servers are available for either ICE servers or SFU/MCU offer processing.
The default value is 1500ms.
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4488
setMediaId
▸ ProtectedsetMediaId(value: string): void
Sets the media identifier.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4501
setMinNoMediaServerRetryBackoff
▸ setMinNoMediaServerRetryBackoff(value: number): void
Sets the mininum retry backoff timeout, in milliseconds, before we retry a request
after receiving no Media Servers are available for either ICE servers or SFU/MCU offer processing.
The default value is 1000ms.
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4532
setNoMediaServerTimeout
▸ setNoMediaServerTimeout(value: number): void
Sets the timeout, in milliseconds, before failing a request where no Media Servers are available for either ICE servers or SFU/MCU offer processing.
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4554
setRemoteAudioEncoding
▸ ProtectedsetRemoteAudioEncoding(value: EncodingInfo): void
Sets the remote audio encoding.
Parameters:
| Name | Type |
|---|---|
value |
EncodingInfo |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4575
setRemoteAudioFormats
▸ ProtectedsetRemoteAudioFormats(value: FormatInfo[]): void
Sets the remote audio formats.
Parameters:
| Name | Type |
|---|---|
value |
FormatInfo[] |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4595
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:4607
setRemoteConnectionId
▸ ProtectedsetRemoteConnectionId(value: string): void
Sets the remote connection identifier, if available.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4629
setRemoteMediaId
▸ ProtectedsetRemoteMediaId(value: string): void
Sets the remote media identifier, if available.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4649
setRemoteTag
▸ ProtectedsetRemoteTag(value: string): void
Sets the remote tag, if applicable.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4669
setRemoteVideoEncoding
▸ ProtectedsetRemoteVideoEncoding(value: EncodingInfo): void
Sets the remote video encoding.
Parameters:
| Name | Type |
|---|---|
value |
EncodingInfo |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4681
setRemoteVideoFormats
▸ ProtectedsetRemoteVideoFormats(value: FormatInfo[]): void
Sets the remote video formats.
Parameters:
| Name | Type |
|---|---|
value |
FormatInfo[] |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4701
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:4713
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:4729
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:4745
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:4760
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:4773
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:4785
setUseWebSocketsForMedia
▸ ProtectedsetUseWebSocketsForMedia(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:4813
setVideoEnabledUpdateConnectionPolicy
▸ setVideoEnabledUpdateConnectionPolicy(value: IFunction1<number, number>): void
Sets a method that determines when to enable video again on a connection that dynamically disables video. Optional. If not set, default policy will be used. Takes in an interger parameter that represents the amount of attempts already tried. Will return an interger value as a time period in seconds for how long to wait for the next attempt or -1 for no more attempts.
Parameters:
| Name | Type |
|---|---|
value |
IFunction1<number, number> |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4835
setVideoRetentionPolicy
▸ setVideoRetentionPolicy(value: VideoRetentionPolicy): void
Sets the Video Retention Policy. This will determine how we will handle video on the connection when the connection is of poor quality.
Parameters:
| Name | Type |
|---|---|
value |
VideoRetentionPolicy |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4848
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:4876
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:4888
trySendRtcpDataChannel
▸ ProtectedtrySendRtcpDataChannel(message: Message): boolean
Sends bitrate messages.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Message | The message to send. |
Returns: boolean
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4935
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:125
update
▸ update(config: ConnectionConfig): Future<Object>
Updates this connection.
Parameters:
| Name | Type | Description |
|---|---|---|
config |
ConnectionConfig | The connection configuration. |
Returns: Future<Object>
A future that resolves when the connection has been updated.
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:4949
getDefaultNoMediaServerTimeout
▸ StaticgetDefaultNoMediaServerTimeout(): number
Gets the default timeout, in milliseconds, before we fail the connection attempt
where no Media Servers are available for either ICE servers or SFU/MCU offer processing.
The default value is 120,000 (2 minutes).
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:576
getDefaultStatsEventInterval
▸ StaticgetDefaultStatsEventInterval(): number
Gets the default interval, in milliseconds, between stats events raised locally by [[fm.liveswitch.managedConnection.addOnStats]].
The default value is 1,000 (1 second).
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:591
getDefaultStatsInterval
▸ StaticgetDefaultStatsInterval(): number
Gets the default interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).
deprecated Use DefaultStatsReportInterval instead.
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:607
getDefaultStatsReportInterval
▸ StaticgetDefaultStatsReportInterval(): number
Gets the default interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).
Returns: number
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:622
setDefaultNoMediaServerTimeout
▸ StaticsetDefaultNoMediaServerTimeout(value: number): void
Sets the default timeout, in milliseconds, before we fail the connection attempt
where no Media Servers are available for either ICE servers or SFU/MCU offer processing.
The default value is 120,000 (2 minutes).
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:638
setDefaultStatsEventInterval
▸ StaticsetDefaultStatsEventInterval(value: number): void
Sets the default interval, in milliseconds, between stats events raised locally by [[fm.liveswitch.managedConnection.addOnStats]].
The default value is 1,000 (1 second).
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:654
setDefaultStatsInterval
▸ StaticsetDefaultStatsInterval(value: number): void
Sets the default interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).
deprecated Use DefaultStatsReportInterval instead.
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:671
setDefaultStatsReportInterval
▸ StaticsetDefaultStatsReportInterval(value: number): void
Sets the default interval, in milliseconds, between stats reports sent to the Gateway.
The default value is 10,000 (10 seconds).
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Inherited from: ManagedConnection
Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnection.ts:687