A managed connection. More...

Public Member Functions
void	addOnAudioUnmuteDisabled (fm.liveswitch.IAction0 value)
	Adds a handler that is raised when the ability to unmute audio is disabled. More...

void	addOnAudioUnmuteEnabled (fm.liveswitch.IAction0 value)
	Adds a handler that is raised when the ability to unmute audio is enabled. More...

void	addOnAutomaticIceServers (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.IceServerCollection > value)
	Adds a handler that is raised when automatic ICE servers have been received. More...

void	addOnGatheringStateChange (fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value)
	Adds a handler that is raised when the ICE gathering state changes. More...

void	addOnIceConnectionStateChange (fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value)
	Adds a handler that is raised when the ICE connection state changes. More...

void	addOnLocalCandidate (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.Candidate > value)
	Adds a handler that is raised when a local candidate is ready. More...

void	addOnLocalDescription (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.SessionDescription > value)
	Adds a handler that is raised when the local description is ready. More...

void	addOnMediaQuality (fm.liveswitch.IAction1< Double > value)
	Adds a handler that is raised every fm.liveswitch.ManagedConnection#getStatsEventInterval milliseconds with the current estimated media quality. More...

void	addOnNetworkQuality (fm.liveswitch.IAction1< Double > value)
	Adds a handler that is raised every fm.liveswitch.ManagedConnection#getStatsEventInterval milliseconds with the current estimated network quality. More...

void	addOnNoMediaServersAvailable (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.NoMediaServersAvailableEventArgs > value)
	Adds a handler that is raised when there are no Media Servers available. More...

void	addOnNoWebSocketMediaServersAvailable (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.NoWebSocketMediaServersAvailableEventArgs > value)
	Adds a handler that is raised when there are no WebSocket Media Servers available. More...

void	addOnRecordingDisabled (fm.liveswitch.IAction1< String > value)
	Adds a handler that is raised when this connection is no longer being recorded. More...

void	addOnRecordingEnabled (fm.liveswitch.IAction1< String > value)
	Adds a handler that is raised when this connection is being recorded. More...

void	addOnRemoteAudioEncodingSwitch (fm.liveswitch.IAction2< fm.liveswitch.EncodingInfo, fm.liveswitch.EncodingInfo > value)
	Adds a handler that is raised when the remote audio encoding is switched by the server. More...

void	addOnRemoteCandidate (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.Candidate > value)
	Adds a handler that is raised when a remote candidate is ready. More...

void	addOnRemoteDescription (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.SessionDescription > value)
	Adds a handler that is raised when the remote description is ready. More...

void	addOnRemoteUpdate (fm.liveswitch.IAction2< fm.liveswitch.ConnectionInfo, fm.liveswitch.ConnectionInfo > value)
	Adds a handler that is raised when a remote connection has been updated. More...

void	addOnRemoteVideoEncodingSwitch (fm.liveswitch.IAction2< fm.liveswitch.EncodingInfo, fm.liveswitch.EncodingInfo > value)
	Adds a handler that is raised when the remote video encoding is switched by the server. More...

void	addOnSignallingStateChange (fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value)
	Adds a handler that is raised when the signalling state changes. More...

void	addOnStateChange (fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value)
	Adds a handler that is raised when the connection state changes. More...

void	addOnStats (fm.liveswitch.IAction1< fm.liveswitch.ConnectionStats > value)
	Adds a handler that is raised every fm.liveswitch.ManagedConnection#getStatsEventInterval milliseconds with the current connection stats. More...

void	addOnVideoEnabledChange (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, Boolean > value)
	Adds a handler that is raised when a connection has it's video state changed from disabled or enabled. More...

void	addOnVideoUnmuteDisabled (fm.liveswitch.IAction0 value)
	Adds a handler that is raised when the ability to unmute video is disabled. More...

void	addOnVideoUnmuteEnabled (fm.liveswitch.IAction0 value)
	Adds a handler that is raised when the ability to unmute video is enabled. More...

fm.liveswitch.Future< Object >	close ()
	Closes the connection. More...

String	getApplicationId ()
	Gets the application identifier. More...

String	getAudioDirection ()
	Gets the audio direction. More...

fm.liveswitch.AudioStream	getAudioStream ()
	Gets the audio stream. More...

boolean	getAudioUnmuteDisabled ()
	Gets whether the ability to unmute audio is disabled. More...

fm.liveswitch.BundlePolicy	getBundlePolicy ()
	Gets the Bundle Policy. More...

String	getCanonicalName ()
	Gets the connection's canonical name. More...

String	getChannelId ()
	Gets the channel identifier. More...

String	getClientId ()
	Gets the client identifier. More...

fm.liveswitch.ConnectionConfig	getConfig ()
	Gets the current configuration. More...

fm.liveswitch.IFunction1< fm.liveswitch.DatagramSocketCreateArgs, fm.liveswitch.DatagramSocket >	getCreateDatagramSocket ()
	Gets a method that creates Datagram sockets. More...

fm.liveswitch.IFunction1< fm.liveswitch.StreamSocketCreateArgs, fm.liveswitch.StreamSocket >	getCreateStreamSocket ()
	Gets a method that creates Stream sockets. More...

String	getDataDirection ()
	Gets the data direction. More...

fm.liveswitch.DataStream	getDataStream ()
	Gets the data stream. More...

int	getDeadStreamTimeout ()
	Gets the amount of time (in milliseconds) to wait before declaring the connection dead. More...

String	getDeviceId ()
	Gets the device identifier. More...

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

fm.liveswitch.DtlsCipherSuite[]	getDtlsCipherSuites ()
	Gets the DTLS cipher suites to use. More...

fm.liveswitch.DtlsProtocolVersion	getDtlsClientVersion ()
	Gets the protocol version to use when in the DTLS client role. More...

fm.liveswitch.DtlsProtocolVersion	getDtlsServerMaxVersion ()
	Gets the maximum protocol version to allow when in the DTLS server role. More...

fm.liveswitch.DtlsProtocolVersion	getDtlsServerMinVersion ()
	Gets the minimum protocol version to allow when in the DTLS server role. More...

fm.liveswitch.Error	getError ()
	Gets the error, if an error exists. More...

String	getExternalId ()
	Gets the external connection identifier. More...

fm.liveswitch.IceGatheringState	getGatheringState ()
	Gets the state of the ice gathering. More...

boolean	getHasAudio ()
	Gets whether this connection has an audio stream. More...

boolean	getHasData ()
	Gets whether this connection has a data stream. More...

boolean	getHasVideo ()
	Gets whether this connection has a video stream. More...

fm.liveswitch.AddressType[]	getIceAddressTypes ()
	Gets the ICE address types. More...

fm.liveswitch.IceConnectionState	getIceConnectionState ()
	Gets the state of the ice connection. More...

fm.liveswitch.IceGatherPolicy	getIceGatherPolicy ()
	Gets the ICE gather policy. More...

fm.liveswitch.IcePolicy	getIcePolicy ()
	Gets policy indicating whether ICE is required (and enabled) or disabled (and not required for this connection). More...

fm.liveswitch.IcePortRange	getIcePortRange ()
	Gets the ICE port range. More...

fm.liveswitch.IceRole	getIceRole ()
	Gets the ICE role. More...

fm.liveswitch.IceServer	getIceServer ()
	Gets the ICE server. More...

fm.liveswitch.IceServer[]	getIceServers ()
	Gets the ICE servers. More...

String	getId ()
	Gets the connection identifier. More...

fm.liveswitch.ConnectionInfo	getInfo ()
	Gets the connection info. More...

int	getKeepAliveInterval ()
	Gets a value indicating how many milliseconds must elapse between STUN keep-alive binding requests. More...

fm.liveswitch.NullableInteger	getLayoutPriority ()
	Gets the LayoutPriority. More...

String	getLayoutZone ()
	Gets the LayoutZone. More...

String	getLocalAudioDirection ()
	Gets the local audio direction. More...

boolean	getLocalAudioDisabled ()
	Gets if local audio is disabled. More...

fm.liveswitch.FormatInfo[]	getLocalAudioFormats ()
	Gets the local audio formats. More...

boolean	getLocalAudioMuted ()
	Gets whether the local audio is muted. More...

String	getLocalDataDirection ()
	Gets the local data direction. More...

boolean	getLocalDataDisabled ()
	Gets if local data is disabled. More...

fm.liveswitch.SessionDescription	getLocalDescription ()
	Gets the local description. More...

fm.liveswitch.DtlsCertificate	getLocalDtlsCertificate ()
	Gets the local DTLS certificate. More...

fm.liveswitch.DtlsCertificate[]	getLocalDtlsCertificates ()
	Gets the local DTLS certificates. More...

String	getLocalVideoDirection ()
	Gets the local video direction. More...

boolean	getLocalVideoDisabled ()
	Gets if local video is disabled. More...

fm.liveswitch.FormatInfo[]	getLocalVideoFormats ()
	Gets the local video formats. More...

boolean	getLocalVideoMuted ()
	Gets whether the local video is muted. More...

int	getMaxNoMediaServerRetryBackoff ()
	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. More...

String	getMediaId ()
	Gets the media identifier. More...

fm.liveswitch.MediaProtocol	getMediaProtocol ()
	Gets the media protocol in use on this connection. More...

double	getMediaQuality ()
	Gets the current estimated media quality. More...

int	getMinNoMediaServerRetryBackoff ()
	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. More...

fm.liveswitch.MultiplexPolicy	getMultiplexPolicy ()
	Gets the multiplex policy. More...

double	getNetworkQuality ()
	Gets the current estimated network quality. More...

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

String	getPrivateIPAddress ()
	Gets the private IP address of this device. More...

String[]	getPrivateIPAddresses ()
	Gets the private IP address of this device. More...

boolean	getRecordingEnabled ()
	Gets whether this connection is being recorded. More...

boolean	getRemoteAudioDisabled ()
	Gets if remote audio is disabled. More...

fm.liveswitch.EncodingInfo	getRemoteAudioEncoding ()
	Gets the remote audio encoding. More...

fm.liveswitch.FormatInfo[]	getRemoteAudioFormats ()
	Gets the remote audio formats. More...

boolean	getRemoteAudioMuted ()
	Gets whether the remote audio is muted. More...

boolean	getRemoteClosed ()
	Gets a value indicating whether the connection was closed by the remote host. More...

String	getRemoteConnectionId ()
	Gets the remote connection identifier, if available. More...

boolean	getRemoteDataDisabled ()
	Gets if remote data is disabled. More...

fm.liveswitch.SessionDescription	getRemoteDescription ()
	Gets the remote description. More...

String	getRemoteMediaId ()
	Gets the remote media identifier, if available. More...

boolean	getRemoteRejected ()
	Gets a value indicating whether the connection was rejected by the remote host. More...

String	getRemoteTag ()
	Gets the remote tag, if applicable. More...

boolean	getRemoteVideoDisabled ()
	Gets if remote video is disabled. More...

fm.liveswitch.EncodingInfo	getRemoteVideoEncoding ()
	Gets the remote video encoding. More...

fm.liveswitch.FormatInfo[]	getRemoteVideoFormats ()
	Gets the remote video formats. More...

boolean	getRemoteVideoMuted ()
	Gets whether the remote video is muted. More...

fm.liveswitch.SignallingState	getSignallingState ()
	Gets the state of the signalling. More...

fm.liveswitch.ConnectionState	getState ()
	Gets the state of the connection. More...

fm.liveswitch.Future< fm.liveswitch.ConnectionStats >	getStats ()
	Gets the current connection stats. More...

int	getStatsEventInterval ()
	Gets the interval, in milliseconds, between stats events raised locally by fm.liveswitch.ManagedConnection#addOnStats. More...

int	getStatsInterval ()
	Gets the default interval, in milliseconds, between stats reports sent to the Gateway. More...

int	getStatsReportInterval ()
	Gets the interval, in milliseconds, between stats reports sent to the Gateway. More...

int	getStunBindingRequestLimit ()
	Gets the limit on the the number of Turn Allocate request messages when trying to establish allocation on a Turn server. More...

int	getStunRequestTimeout ()
	Gets the timeout for individual Stun (and Turn) request messages in ms. More...

String	getTag ()
	Gets the tag. More...

int	getTcpConnectTimeout ()
	Gets connection timeout for stream sockets in ms. More...

fm.liveswitch.IFunction1< fm.liveswitch.DataBuffer, fm.liveswitch.DataBuffer >	getTestReceivedRtpBuffer ()
	Gets a method that can be used to test and optionally modify inbound RTP buffers. More...

int	getTestRoundTripTime ()
	Gets a fixed round-trip time (in milliseconds) to use in the network transport. More...

fm.liveswitch.IFunction1< fm.liveswitch.DataBuffer, fm.liveswitch.DataBuffer >	getTestSendingRtpBuffer ()
	Gets a method that can be used to test and optionally modify outbound RTP buffers. More...

fm.liveswitch.TrickleIcePolicy	getTrickleIcePolicy ()
	Gets the trickle-ICE policy. More...

int	getTurnAllocateRequestLimit ()
	Gets the limit on the the number of Turn Allocate request messages when trying to establish allocation on a Turn server. More...

String	getType ()
	Gets the connection type. More...

String	getUserId ()
	Gets the user identifier. More...

boolean	getUseWebSocketsForMedia ()
	Gets if we should use WebSockets for sending media. More...

String	getVideoDirection ()
	Gets the video direction. More...

int	getVideoEnabledConnectionUpdateAttempts ()
	Gets the amount of attempts this connection has made to enabled video on a connection. More...

fm.liveswitch.IFunction1< Integer, Integer >	getVideoEnabledUpdateConnectionPolicy ()
	Gets a method that determines when to enable video again on a connection that dynamically disables video. More...

fm.liveswitch.VideoRetentionPolicy	getVideoRetentionPolicy ()
	Gets the Video Retention Policy. More...

fm.liveswitch.VideoStream	getVideoStream ()
	Gets the video stream. More...

boolean	getVideoUnmuteDisabled ()
	Gets whether the ability to unmute video is disabled. More...

String	getWmsAddress ()
	Gets the WMS endpoint address. More...

String	getWmsConnectionToken ()
	Gets WMS connection token. More...

fm.liveswitch.Future< Object >	open ()
	Opens the connection. More...

void	removeOnAudioUnmuteDisabled (fm.liveswitch.IAction0 value)
	Removes a handler that is raised when the ability to unmute audio is disabled. More...

void	removeOnAudioUnmuteEnabled (fm.liveswitch.IAction0 value)
	Removes a handler that is raised when the ability to unmute audio is enabled. More...

void	removeOnAutomaticIceServers (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.IceServerCollection > value)
	Removes a handler that is raised when automatic ICE servers have been received. More...

void	removeOnGatheringStateChange (fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value)
	Removes a handler that is raised when the ICE gathering state changes. More...

void	removeOnIceConnectionStateChange (fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value)
	Removes a handler that is raised when the ICE connection state changes. More...

void	removeOnLocalCandidate (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.Candidate > value)
	Removes a handler that is raised when a local candidate is ready. More...

void	removeOnLocalDescription (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.SessionDescription > value)
	Removes a handler that is raised when the local description is ready. More...

void	removeOnMediaQuality (fm.liveswitch.IAction1< Double > value)
	Removes a handler that is raised every fm.liveswitch.ManagedConnection#getStatsEventInterval milliseconds with the current estimated media quality. More...

void	removeOnNetworkQuality (fm.liveswitch.IAction1< Double > value)
	Removes a handler that is raised every fm.liveswitch.ManagedConnection#getStatsEventInterval milliseconds with the current estimated network quality. More...

void	removeOnNoMediaServersAvailable (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.NoMediaServersAvailableEventArgs > value)
	Removes a handler that is raised when there are no Media Servers available. More...

void	removeOnNoWebSocketMediaServersAvailable (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.NoWebSocketMediaServersAvailableEventArgs > value)
	Removes a handler that is raised when there are no WebSocket Media Servers available. More...

void	removeOnRecordingDisabled (fm.liveswitch.IAction1< String > value)
	Removes a handler that is raised when this connection is no longer being recorded. More...

void	removeOnRecordingEnabled (fm.liveswitch.IAction1< String > value)
	Removes a handler that is raised when this connection is being recorded. More...

void	removeOnRemoteAudioEncodingSwitch (fm.liveswitch.IAction2< fm.liveswitch.EncodingInfo, fm.liveswitch.EncodingInfo > value)
	Removes a handler that is raised when the remote audio encoding is switched by the server. More...

void	removeOnRemoteCandidate (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.Candidate > value)
	Removes a handler that is raised when a remote candidate is ready. More...

void	removeOnRemoteDescription (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.SessionDescription > value)
	Removes a handler that is raised when the remote description is ready. More...

void	removeOnRemoteUpdate (fm.liveswitch.IAction2< fm.liveswitch.ConnectionInfo, fm.liveswitch.ConnectionInfo > value)
	Removes a handler that is raised when a remote connection has been updated. More...

void	removeOnRemoteVideoEncodingSwitch (fm.liveswitch.IAction2< fm.liveswitch.EncodingInfo, fm.liveswitch.EncodingInfo > value)
	Removes a handler that is raised when the remote video encoding is switched by the server. More...

void	removeOnSignallingStateChange (fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value)
	Removes a handler that is raised when the signalling state changes. More...

void	removeOnStateChange (fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value)
	Removes a handler that is raised when the connection state changes. More...

void	removeOnStats (fm.liveswitch.IAction1< fm.liveswitch.ConnectionStats > value)
	Removes a handler that is raised every fm.liveswitch.ManagedConnection#getStatsEventInterval milliseconds with the current connection stats. More...

void	removeOnVideoEnabledChange (fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, Boolean > value)
	Removes a handler that is raised when a connection has it's video state changed from disabled or enabled. More...

void	removeOnVideoUnmuteDisabled (fm.liveswitch.IAction0 value)
	Removes a handler that is raised when the ability to unmute video is disabled. More...

void	removeOnVideoUnmuteEnabled (fm.liveswitch.IAction0 value)
	Removes a handler that is raised when the ability to unmute video is enabled. More...

void	setBundlePolicy (fm.liveswitch.BundlePolicy value)
	Sets the Bundle Policy. More...

void	setCreateDatagramSocket (fm.liveswitch.IFunction1< fm.liveswitch.DatagramSocketCreateArgs, fm.liveswitch.DatagramSocket > value)
	Sets a method that creates Datagram sockets. More...

void	setCreateStreamSocket (fm.liveswitch.IFunction1< fm.liveswitch.StreamSocketCreateArgs, fm.liveswitch.StreamSocket > value)
	Sets a method that creates Stream sockets. More...

void	setDeadStreamTimeout (int value)
	Sets the amount of time (in milliseconds) to wait before declaring the connection dead. More...

void	setDisableAutomaticIceServers (boolean value)
	Sets whether to disable automatic ICE servers (embedded TURN). More...

void	setDtlsCipherSuites (fm.liveswitch.DtlsCipherSuite[] value)
	Sets the DTLS cipher suites to use. More...

void	setDtlsClientVersion (fm.liveswitch.DtlsProtocolVersion value)
	Sets the protocol version to use when in the DTLS client role. More...

void	setDtlsServerMaxVersion (fm.liveswitch.DtlsProtocolVersion value)
	Sets the maximum protocol version to allow when in the DTLS server role. More...

void	setDtlsServerMinVersion (fm.liveswitch.DtlsProtocolVersion value)
	Sets the minimum protocol version to allow when in the DTLS server role. More...

void	setIceAddressTypes (fm.liveswitch.AddressType[] value)
	Sets the ICE address types. More...

void	setIceGatherPolicy (fm.liveswitch.IceGatherPolicy value)
	Sets the ICE gather policy. More...

void	setIcePolicy (fm.liveswitch.IcePolicy value)
	Sets policy indicating whether ICE is required (and enabled) or disabled (and not required for this connection). More...

void	setIcePortRange (fm.liveswitch.IcePortRange value)
	Sets the ICE port range. More...

void	setIceServer (fm.liveswitch.IceServer value)
	Sets the ICE server. More...

void	setIceServers (fm.liveswitch.IceServer[] value)
	Sets the ICE servers. More...

void	setKeepAliveInterval (int value)
	Sets a value indicating how many milliseconds must elapse between STUN keep-alive binding requests. More...

void	setLayoutPriority (fm.liveswitch.NullableInteger value)
	Sets the LayoutPriority. More...

void	setLayoutZone (String value)
	Sets the LayoutZone. More...

void	setLocalDtlsCertificate (fm.liveswitch.DtlsCertificate value)
	Sets the local DTLS certificate. More...

void	setLocalDtlsCertificates (fm.liveswitch.DtlsCertificate[] value)
	Sets the local DTLS certificates. More...

void	setMaxNoMediaServerRetryBackoff (int value)
	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. More...

void	setMinNoMediaServerRetryBackoff (int value)
	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. More...

void	setMultiplexPolicy (fm.liveswitch.MultiplexPolicy value)
	Sets the multiplex policy. More...

void	setNoMediaServerTimeout (int value)
	Sets the timeout, in milliseconds, before failing a request where no Media Servers are available for either ICE servers or SFU/MCU offer processing. More...

void	setPrivateIPAddress (String value)
	Sets the private IP address of this device. More...

void	setPrivateIPAddresses (String[] value)
	Sets the private IP address of this device. More...

void	setRemoteAudioMuted (boolean value)
	Sets whether the remote audio is muted. More...

void	setRemoteVideoMuted (boolean value)
	Sets whether the remote video is muted. More...

void	setStatsEventInterval (int value)
	Sets the interval, in milliseconds, between stats events raised locally by fm.liveswitch.ManagedConnection#addOnStats. More...

void	setStatsInterval (int value)
	Sets the default interval, in milliseconds, between stats reports sent to the Gateway. More...

void	setStatsReportInterval (int value)
	Sets the interval, in milliseconds, between stats reports sent to the Gateway. More...

void	setStunBindingRequestLimit (int value)
	Sets the limit on the the number of Turn Allocate request messages when trying to establish allocation on a Turn server. More...

void	setStunRequestTimeout (int value)
	Sets the timeout for individual Stun (and Turn) request messages in ms. More...

void	setTag (String value)
	Sets the tag. More...

void	setTcpConnectTimeout (int value)
	Sets connection timeout for stream sockets in ms. More...

void	setTestReceivedRtpBuffer (fm.liveswitch.IFunction1< fm.liveswitch.DataBuffer, fm.liveswitch.DataBuffer > value)
	Sets a method that can be used to test and optionally modify inbound RTP buffers. More...

void	setTestRoundTripTime (int value)
	Sets a fixed round-trip time (in milliseconds) to use in the network transport. More...

void	setTestSendingRtpBuffer (fm.liveswitch.IFunction1< fm.liveswitch.DataBuffer, fm.liveswitch.DataBuffer > value)
	Sets a method that can be used to test and optionally modify outbound RTP buffers. More...

void	setTrickleIcePolicy (fm.liveswitch.TrickleIcePolicy value)
	Sets the trickle-ICE policy. More...

void	setTurnAllocateRequestLimit (int value)
	Sets the limit on the the number of Turn Allocate request messages when trying to establish allocation on a Turn server. More...

void	setVideoEnabledUpdateConnectionPolicy (fm.liveswitch.IFunction1< Integer, Integer > value)
	Sets a method that determines when to enable video again on a connection that dynamically disables video. More...

void	setVideoRetentionPolicy (fm.liveswitch.VideoRetentionPolicy value)
	Sets the Video Retention Policy. More...

void	setWmsAddress (String value)
	Sets the WMS endpoint address. More...

void	setWmsConnectionToken (String value)
	Sets WMS connection token. More...

fm.liveswitch.Future< Object >	update (fm.liveswitch.ConnectionConfig config)
	Updates this connection. More...

Public Member Functions inherited from fm.liveswitch.Dynamic
java.util.HashMap< String, Object >	getDynamicProperties ()
	Gets all dynamic properties on this instance. More...

Object	getDynamicValue (String key)
	Gets a property value from the local cache. More...

void	setDynamicValue (String key, Object value)
	Sets a property value in the local cache. More...

boolean	unsetDynamicValue (String key)
	Removes a property value from the local cache. More...

Static Public Member Functions
static fm.liveswitch.DtlsCertificate	getDefaultLocalDtlsCertificate ()
	Gets the default local DTLS certificate. More...

static fm.liveswitch.DtlsCertificate[]	getDefaultLocalDtlsCertificates ()
	Gets the default local DTLS certificates. More...

static int	getDefaultNoMediaServerTimeout ()
	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. More...

static int	getDefaultStatsEventInterval ()
	Gets the default interval, in milliseconds, between stats events raised locally by fm.liveswitch.ManagedConnection#addOnStats. More...

static int	getDefaultStatsInterval ()
	Gets the default interval, in milliseconds, between stats reports sent to the Gateway. More...

static int	getDefaultStatsReportInterval ()
	Gets the default interval, in milliseconds, between stats reports sent to the Gateway. More...

static void	setDefaultLocalDtlsCertificate (fm.liveswitch.DtlsCertificate value)
	Sets the default local DTLS certificate. More...

static void	setDefaultLocalDtlsCertificates (fm.liveswitch.DtlsCertificate[] value)
	Sets the default local DTLS certificates. More...

static void	setDefaultNoMediaServerTimeout (int value)
	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. More...

static void	setDefaultStatsEventInterval (int value)
	Sets the default interval, in milliseconds, between stats events raised locally by fm.liveswitch.ManagedConnection#addOnStats. More...

static void	setDefaultStatsInterval (int value)
	Sets the default interval, in milliseconds, between stats reports sent to the Gateway. More...

static void	setDefaultStatsReportInterval (int value)
	Sets the default interval, in milliseconds, between stats reports sent to the Gateway. More...

Protected Member Functions
void	detachInternalEventHandlers ()
	Detaches internal event handlers. More...

abstract fm.liveswitch.Message	doCreateCandidateMessage (fm.liveswitch.Candidate candidate)
	Creates a candidate message. More...

abstract fm.liveswitch.Message	doCreateCloseMessage ()
	Creates a close message. More...

fm.liveswitch.Message	doCreateUpdateMessage (fm.liveswitch.ConnectionConfig config)
	Creates an update message. More...

fm.liveswitch.Message	doCreateUseWebSocketServiceMessage ()
	Create the message to use WebSockets for media. More...

abstract void	doOpen ()
	Opens the connection. More...

abstract void	doProcessMessage (fm.liveswitch.Message message)
	Processes a message. More...

fm.liveswitch.DataChannel	getInternalRtcpDataChannel ()
	Gets Data Channel for inband signalling. More...

String[]	getMediaIntents ()
	Gets media intents reflected by Gateway. More...

fm.liveswitch.Randomizer	getRandomizer ()
	Gets a randomizer for backoff timers. More...

abstract boolean	isMediaDirectionAllowed (String direction)
	Gets a value indicating whether the given direction is allowed for this connection. More...

	ManagedConnection (Object sharedLock, String applicationId, String channelId, String userId, String deviceId, String clientId, fm.liveswitch.IFunction1< fm.liveswitch.Message, fm.liveswitch.Future< fm.liveswitch.Message >> doSend, String type, fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream, String mediaId)
	ManagedConnection constructor. More...

	ManagedConnection (Object sharedLock, String applicationId, String channelId, String userId, String deviceId, String clientId, fm.liveswitch.IFunction1< fm.liveswitch.Message, fm.liveswitch.Future< fm.liveswitch.Message >> doSend, String type, fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream, String mediaId, boolean useWebSocketsForMedia)
	ManagedConnection constructor. More...

abstract void	processAnswer (fm.liveswitch.Message message)
	Processes an answer. More...

void	processError (fm.liveswitch.Message message)
	Processes an error message. More...

void	processIceServers (fm.liveswitch.Message message)
	Processes an iceServers message. More...

void	processLocalError (fm.liveswitch.Error error)
	Processes a local failure. More...

void	processMediaIntentResponse (fm.liveswitch.Message message)
	Processes an iceServers message. More...

void	processRtcpDataChannelSignallingActivation (fm.liveswitch.Message message)
	Processes inband signalling activation. More...

void	processSimulcastNotification (fm.liveswitch.Message message)
	Processes a simulcast notification. More...

void	raiseAudioBitrateNotification (fm.liveswitch.AudioStream audioStream, fm.liveswitch.BitrateNotification bitrateNotification)
	Raises an audio bitrate notification. More...

void	raiseAudioBitrateRequest (fm.liveswitch.AudioStream audioStream, fm.liveswitch.BitrateRequest bitrateRequest)
	Raises an audio bitrate request. More...

void	raiseLocalCandidate (fm.liveswitch.Candidate localCandidate)
	Raises a local candidate. More...

void	raiseNoMediaServersAvailable (fm.liveswitch.NoMediaServersAvailableEventArgs args)
	Raises the OnNoMediaServersAvailable event. More...

void	raiseNoWebSocketMediaServersAvailable (fm.liveswitch.NoWebSocketMediaServersAvailableEventArgs args)
	Raises the OnNoWebSocketMediaServersAvailable event. More...

void	raiseRemoteCandidate (fm.liveswitch.Candidate remoteCandidate)
	Raises a remote candidate. More...

void	raiseVideoBitrateNotification (fm.liveswitch.VideoStream videoStream, fm.liveswitch.BitrateNotification bitrateNotification)
	Raises a video bitrate notification. More...

void	raiseVideoBitrateRequest (fm.liveswitch.VideoStream videoStream, fm.liveswitch.BitrateRequest bitrateRequest)
	Raises a video bitrate request. More...

fm.liveswitch.Future< fm.liveswitch.Message >	send (fm.liveswitch.Message message)
	Sends a message. More...

void	setLocalAudioFormats (fm.liveswitch.FormatInfo[] value)
	Sets the local audio formats. More...

void	setLocalVideoFormats (fm.liveswitch.FormatInfo[] value)
	Sets the local video formats. More...

void	setMediaId (String value)
	Sets the media identifier. More...

void	setRemoteAudioEncoding (fm.liveswitch.EncodingInfo value)
	Sets the remote audio encoding. More...

void	setRemoteAudioFormats (fm.liveswitch.FormatInfo[] value)
	Sets the remote audio formats. More...

void	setRemoteConnectionId (String value)
	Sets the remote connection identifier, if available. More...

void	setRemoteMediaId (String value)
	Sets the remote media identifier, if available. More...

void	setRemoteTag (String value)
	Sets the remote tag, if applicable. More...

void	setRemoteVideoEncoding (fm.liveswitch.EncodingInfo value)
	Sets the remote video encoding. More...

void	setRemoteVideoFormats (fm.liveswitch.FormatInfo[] value)
	Sets the remote video formats. More...

void	setUseWebSocketsForMedia (boolean value)
	Sets if we should use WebSockets for sending media. More...

boolean	trySendRtcpDataChannel (fm.liveswitch.Message message)
	Sends bitrate messages. More...

Protected Member Functions inherited from fm.liveswitch.Dynamic
	Dynamic ()

Protected Member Functions inherited from fm.liveswitch.Serializable
boolean	getIsDirty ()
	Gets a value indicating whether this instance is dirty. More...

	Serializable ()
	Initializes a new instance of the fm.liveswitch.Serializable class. More...

void	setIsDirty (boolean value)
	Sets a value indicating whether this instance is dirty. More...

Detailed Description

A managed connection.

Constructor & Destructor Documentation

◆ ManagedConnection() [1/2]

fm.liveswitch.ManagedConnection.ManagedConnection	(	Object	sharedLock,
		String	applicationId,
		String	channelId,
		String	userId,
		String	deviceId,
		String	clientId,
		fm.liveswitch.IFunction1< fm.liveswitch.Message, fm.liveswitch.Future< fm.liveswitch.Message >>	doSend,
		String	type,
		fm.liveswitch.AudioStream	audioStream,
		fm.liveswitch.VideoStream	videoStream,
		fm.liveswitch.DataStream	dataStream,
		String	mediaId
	)

protected

ManagedConnection constructor.

Parameters

sharedLock
applicationId
channelId
userId
deviceId
clientId
doSend
type
audioStream
videoStream
dataStream
mediaId

◆ ManagedConnection() [2/2]

fm.liveswitch.ManagedConnection.ManagedConnection	(	Object	sharedLock,
		String	applicationId,
		String	channelId,
		String	userId,
		String	deviceId,
		String	clientId,
		fm.liveswitch.IFunction1< fm.liveswitch.Message, fm.liveswitch.Future< fm.liveswitch.Message >>	doSend,
		String	type,
		fm.liveswitch.AudioStream	audioStream,
		fm.liveswitch.VideoStream	videoStream,
		fm.liveswitch.DataStream	dataStream,
		String	mediaId,
		boolean	useWebSocketsForMedia
	)

protected

ManagedConnection constructor.

Parameters

sharedLock
applicationId
channelId
userId
deviceId
clientId
doSend
type
audioStream
videoStream
dataStream
mediaId
useWebSocketsForMedia

Member Function Documentation

◆ addOnAudioUnmuteDisabled()

void fm.liveswitch.ManagedConnection.addOnAudioUnmuteDisabled ( fm.liveswitch.IAction0 value )

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

◆ addOnAudioUnmuteEnabled()

void fm.liveswitch.ManagedConnection.addOnAudioUnmuteEnabled ( fm.liveswitch.IAction0 value )

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

◆ addOnAutomaticIceServers()

void fm.liveswitch.ManagedConnection.addOnAutomaticIceServers ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.IceServerCollection > value )

Adds a handler that is raised when automatic ICE servers have been received.

Parameters:

connection - the connection
automaticIceServers - the automatic ICE severs collection

◆ addOnGatheringStateChange()

void fm.liveswitch.ManagedConnection.addOnGatheringStateChange ( fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value )

Adds a handler that is raised when the ICE gathering state changes.

Parameters:

connection - the connection

◆ addOnIceConnectionStateChange()

void fm.liveswitch.ManagedConnection.addOnIceConnectionStateChange ( fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value )

Adds a handler that is raised when the ICE connection state changes.

Parameters:

connection - the connection

◆ addOnLocalCandidate()

void fm.liveswitch.ManagedConnection.addOnLocalCandidate ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.Candidate > value )

Adds a handler that is raised when a local candidate is ready.

Parameters:

connection - the connection
candidate - the local candidate

◆ addOnLocalDescription()

void fm.liveswitch.ManagedConnection.addOnLocalDescription ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.SessionDescription > value )

Adds a handler that is raised when the local description is ready.

Parameters:

connection - the connection
description - the local description

◆ addOnMediaQuality()

void fm.liveswitch.ManagedConnection.addOnMediaQuality ( fm.liveswitch.IAction1< Double > value )

Adds a handler that is raised every fm.liveswitch.ManagedConnection#getStatsEventInterval 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.

◆ addOnNetworkQuality()

void fm.liveswitch.ManagedConnection.addOnNetworkQuality ( fm.liveswitch.IAction1< Double > value )

Adds a handler that is raised every fm.liveswitch.ManagedConnection#getStatsEventInterval 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.

◆ addOnNoMediaServersAvailable()

void fm.liveswitch.ManagedConnection.addOnNoMediaServersAvailable ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.NoMediaServersAvailableEventArgs > value )

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

◆ addOnNoWebSocketMediaServersAvailable()

void fm.liveswitch.ManagedConnection.addOnNoWebSocketMediaServersAvailable ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.NoWebSocketMediaServersAvailableEventArgs > value )

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

◆ addOnRecordingDisabled()

void fm.liveswitch.ManagedConnection.addOnRecordingDisabled ( fm.liveswitch.IAction1< String > value )

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

◆ addOnRecordingEnabled()

void fm.liveswitch.ManagedConnection.addOnRecordingEnabled ( fm.liveswitch.IAction1< String > value )

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

◆ addOnRemoteAudioEncodingSwitch()

void fm.liveswitch.ManagedConnection.addOnRemoteAudioEncodingSwitch ( fm.liveswitch.IAction2< fm.liveswitch.EncodingInfo, fm.liveswitch.EncodingInfo > value )

Adds a handler that is raised when the remote audio encoding is switched by the server.

◆ addOnRemoteCandidate()

void fm.liveswitch.ManagedConnection.addOnRemoteCandidate ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.Candidate > value )

Adds a handler that is raised when a remote candidate is ready.

Parameters:

connection - the connection
candidate - the remote candidate

◆ addOnRemoteDescription()

void fm.liveswitch.ManagedConnection.addOnRemoteDescription ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.SessionDescription > value )

Adds a handler that is raised when the remote description is ready.

Parameters:

connection - the connection
description - the remote description

◆ addOnRemoteUpdate()

void fm.liveswitch.ManagedConnection.addOnRemoteUpdate ( fm.liveswitch.IAction2< fm.liveswitch.ConnectionInfo, fm.liveswitch.ConnectionInfo > value )

Adds a handler that is raised when a remote connection has been updated.

◆ addOnRemoteVideoEncodingSwitch()

void fm.liveswitch.ManagedConnection.addOnRemoteVideoEncodingSwitch ( fm.liveswitch.IAction2< fm.liveswitch.EncodingInfo, fm.liveswitch.EncodingInfo > value )

Adds a handler that is raised when the remote video encoding is switched by the server.

◆ addOnSignallingStateChange()

void fm.liveswitch.ManagedConnection.addOnSignallingStateChange ( fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value )

Adds a handler that is raised when the signalling state changes.

Parameters:

connection - the connection

◆ addOnStateChange()

void fm.liveswitch.ManagedConnection.addOnStateChange ( fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value )

Adds a handler that is raised when the connection state changes.

Parameters:

connection - the connection

◆ addOnStats()

void fm.liveswitch.ManagedConnection.addOnStats ( fm.liveswitch.IAction1< fm.liveswitch.ConnectionStats > value )

Adds a handler that is raised every fm.liveswitch.ManagedConnection#getStatsEventInterval milliseconds with the current connection stats.

◆ addOnVideoEnabledChange()

void fm.liveswitch.ManagedConnection.addOnVideoEnabledChange ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, Boolean > value )

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.

◆ addOnVideoUnmuteDisabled()

void fm.liveswitch.ManagedConnection.addOnVideoUnmuteDisabled ( fm.liveswitch.IAction0 value )

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

◆ addOnVideoUnmuteEnabled()

void fm.liveswitch.ManagedConnection.addOnVideoUnmuteEnabled ( fm.liveswitch.IAction0 value )

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

◆ close()

fm.liveswitch.Future<Object> fm.liveswitch.ManagedConnection.close ( )

Closes the connection.

◆ detachInternalEventHandlers()

void fm.liveswitch.ManagedConnection.detachInternalEventHandlers ( )

protected

Detaches internal event handlers.

Reimplemented in fm.liveswitch.ServerConnection, and fm.liveswitch.PeerConnection.

◆ doCreateCandidateMessage()

abstract fm.liveswitch.Message fm.liveswitch.ManagedConnection.doCreateCandidateMessage ( fm.liveswitch.Candidate candidate )

abstractprotected

Creates a candidate message.

Parameters

candidate The candidate.

Reimplemented in fm.liveswitch.ServerConnection, and fm.liveswitch.PeerConnection.

◆ doCreateCloseMessage()

abstract fm.liveswitch.Message fm.liveswitch.ManagedConnection.doCreateCloseMessage ( )

abstractprotected

Creates a close message.

Reimplemented in fm.liveswitch.ServerConnection, and fm.liveswitch.PeerConnection.

◆ doCreateUpdateMessage()

fm.liveswitch.Message fm.liveswitch.ManagedConnection.doCreateUpdateMessage ( fm.liveswitch.ConnectionConfig config )

protected

Creates an update message.

Parameters

config The connection config.

Reimplemented in fm.liveswitch.PeerConnection.

◆ doCreateUseWebSocketServiceMessage()

fm.liveswitch.Message fm.liveswitch.ManagedConnection.doCreateUseWebSocketServiceMessage ( )

protected

Create the message to use WebSockets for media.

Reimplemented in fm.liveswitch.SfuUpstreamConnection, and fm.liveswitch.SfuDownstreamConnection.

◆ doOpen()

abstract void fm.liveswitch.ManagedConnection.doOpen ( )

abstractprotected

Opens the connection.

Reimplemented in fm.liveswitch.ServerConnection, and fm.liveswitch.PeerConnection.

◆ doProcessMessage()

abstract void fm.liveswitch.ManagedConnection.doProcessMessage ( fm.liveswitch.Message message )

abstractprotected

Processes a message.

Parameters

message The message.

Reimplemented in fm.liveswitch.ServerConnection, and fm.liveswitch.PeerConnection.

◆ getApplicationId()

String fm.liveswitch.ManagedConnection.getApplicationId ( )

Gets the application identifier.

◆ getAudioDirection()

String fm.liveswitch.ManagedConnection.getAudioDirection ( )

Gets the audio direction.

Null if disabled.

◆ getAudioStream()

fm.liveswitch.AudioStream fm.liveswitch.ManagedConnection.getAudioStream ( )

Gets the audio stream.

◆ getAudioUnmuteDisabled()

boolean fm.liveswitch.ManagedConnection.getAudioUnmuteDisabled ( )

Gets whether the ability to unmute audio is disabled.

◆ getBundlePolicy()

fm.liveswitch.BundlePolicy fm.liveswitch.ManagedConnection.getBundlePolicy ( )

Gets the Bundle Policy.

◆ getCanonicalName()

String fm.liveswitch.ManagedConnection.getCanonicalName ( )

Gets the connection's canonical name.

Deprecated:: Use MediaStream.LocalCanonicalName instead.

◆ getChannelId()

String fm.liveswitch.ManagedConnection.getChannelId ( )

Gets the channel identifier.

◆ getClientId()

String fm.liveswitch.ManagedConnection.getClientId ( )

Gets the client identifier.

◆ getConfig()

fm.liveswitch.ConnectionConfig fm.liveswitch.ManagedConnection.getConfig ( )

Gets the current configuration.

◆ getCreateDatagramSocket()

fm.liveswitch.IFunction1<fm.liveswitch.DatagramSocketCreateArgs,fm.liveswitch.DatagramSocket> fm.liveswitch.ManagedConnection.getCreateDatagramSocket ( )

Gets a method that creates Datagram sockets.

Optional. If not set, default OS UDP socket is used.

◆ getCreateStreamSocket()

fm.liveswitch.IFunction1<fm.liveswitch.StreamSocketCreateArgs,fm.liveswitch.StreamSocket> fm.liveswitch.ManagedConnection.getCreateStreamSocket ( )

Gets a method that creates Stream sockets.

Optional. If not set, default OS TCP socket is used.

◆ getDataDirection()

String fm.liveswitch.ManagedConnection.getDataDirection ( )

Gets the data direction.

Null if disabled.

◆ getDataStream()

fm.liveswitch.DataStream fm.liveswitch.ManagedConnection.getDataStream ( )

Gets the data stream.

◆ getDeadStreamTimeout()

int fm.liveswitch.ManagedConnection.getDeadStreamTimeout ( )

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.

◆ getDefaultLocalDtlsCertificate()

static fm.liveswitch.DtlsCertificate fm.liveswitch.ManagedConnection.getDefaultLocalDtlsCertificate ( )

static

Gets the default local DTLS certificate.

◆ getDefaultLocalDtlsCertificates()

static fm.liveswitch.DtlsCertificate [] fm.liveswitch.ManagedConnection.getDefaultLocalDtlsCertificates ( )

static

Gets the default local DTLS certificates.

◆ getDefaultNoMediaServerTimeout()

static int fm.liveswitch.ManagedConnection.getDefaultNoMediaServerTimeout ( )

static

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).

◆ getDefaultStatsEventInterval()

static int fm.liveswitch.ManagedConnection.getDefaultStatsEventInterval ( )

static

Gets the default interval, in milliseconds, between stats events raised locally by fm.liveswitch.ManagedConnection#addOnStats.

The default value is 1,000 (1 second).

◆ getDefaultStatsInterval()

static int fm.liveswitch.ManagedConnection.getDefaultStatsInterval ( )

static

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.

◆ getDefaultStatsReportInterval()

static int fm.liveswitch.ManagedConnection.getDefaultStatsReportInterval ( )

static

Gets the default interval, in milliseconds, between stats reports sent to the Gateway.

The default value is 10,000 (10 seconds).

◆ getDeviceId()

String fm.liveswitch.ManagedConnection.getDeviceId ( )

Gets the device identifier.

◆ getDisableAutomaticIceServers()

boolean fm.liveswitch.ManagedConnection.getDisableAutomaticIceServers ( )

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

◆ getDtlsCipherSuites()

fm.liveswitch.DtlsCipherSuite [] fm.liveswitch.ManagedConnection.getDtlsCipherSuites ( )

Gets the DTLS cipher suites to use.

Defaults to: DtlsCipherSuite.EcdheEcdsaAes128Sha, DtlsCipherSuite.EcdheEcdsaAes128GcmSha256, DtlsCipherSuite.EcdheEcdsaAes128CbcSha256, DtlsCipherSuite.EcdheRsaAes128Sha, DtlsCipherSuite.EcdheRsaAes128GcmSha256, DtlsCipherSuite.EcdheRsaAes128CbcSha256, DtlsCipherSuite.RsaAes128Sha, DtlsCipherSuite.RsaAes128GcmSha256, DtlsCipherSuite.RsaAes128CbcSha256,

◆ getDtlsClientVersion()

fm.liveswitch.DtlsProtocolVersion fm.liveswitch.ManagedConnection.getDtlsClientVersion ( )

Gets the protocol version to use when in the DTLS client role.

Defaults to fm.liveswitch.DtlsProtocolVersion#Dtls10.

◆ getDtlsServerMaxVersion()

fm.liveswitch.DtlsProtocolVersion fm.liveswitch.ManagedConnection.getDtlsServerMaxVersion ( )

Gets the maximum protocol version to allow when in the DTLS server role.

Defaults to fm.liveswitch.DtlsProtocolVersion#Dtls12.

◆ getDtlsServerMinVersion()

fm.liveswitch.DtlsProtocolVersion fm.liveswitch.ManagedConnection.getDtlsServerMinVersion ( )

Gets the minimum protocol version to allow when in the DTLS server role.

Defaults to fm.liveswitch.DtlsProtocolVersion#Dtls10.

◆ getError()

fm.liveswitch.Error fm.liveswitch.ManagedConnection.getError ( )

Gets the error, if an error exists.

◆ getExternalId()

String fm.liveswitch.ManagedConnection.getExternalId ( )

Gets the external connection identifier.

◆ getGatheringState()

fm.liveswitch.IceGatheringState fm.liveswitch.ManagedConnection.getGatheringState ( )

Gets the state of the ice gathering.

◆ getHasAudio()

boolean fm.liveswitch.ManagedConnection.getHasAudio ( )

Gets whether this connection has an audio stream.

◆ getHasData()

boolean fm.liveswitch.ManagedConnection.getHasData ( )

Gets whether this connection has a data stream.

◆ getHasVideo()

boolean fm.liveswitch.ManagedConnection.getHasVideo ( )

Gets whether this connection has a video stream.

◆ getIceAddressTypes()

fm.liveswitch.AddressType [] fm.liveswitch.ManagedConnection.getIceAddressTypes ( )

Gets the ICE address types.

◆ getIceConnectionState()

fm.liveswitch.IceConnectionState fm.liveswitch.ManagedConnection.getIceConnectionState ( )

Gets the state of the ice connection.

◆ getIceGatherPolicy()

fm.liveswitch.IceGatherPolicy fm.liveswitch.ManagedConnection.getIceGatherPolicy ( )

Gets the ICE gather policy.

◆ getIcePolicy()

fm.liveswitch.IcePolicy fm.liveswitch.ManagedConnection.getIcePolicy ( )

Gets policy indicating whether ICE is required (and enabled) or disabled (and not required for this connection).

◆ getIcePortRange()

fm.liveswitch.IcePortRange fm.liveswitch.ManagedConnection.getIcePortRange ( )

Gets the ICE port range.

◆ getIceRole()

fm.liveswitch.IceRole fm.liveswitch.ManagedConnection.getIceRole ( )

Gets the ICE role.

◆ getIceServer()

fm.liveswitch.IceServer fm.liveswitch.ManagedConnection.getIceServer ( )

Gets the ICE server.

◆ getIceServers()

fm.liveswitch.IceServer [] fm.liveswitch.ManagedConnection.getIceServers ( )

Gets the ICE servers.

◆ getId()

String fm.liveswitch.ManagedConnection.getId ( )

Gets the connection identifier.

◆ getInfo()

fm.liveswitch.ConnectionInfo fm.liveswitch.ManagedConnection.getInfo ( )

Gets the connection info.

◆ getInternalRtcpDataChannel()

fm.liveswitch.DataChannel fm.liveswitch.ManagedConnection.getInternalRtcpDataChannel ( )

protected

Gets Data Channel for inband signalling.

◆ getKeepAliveInterval()

int fm.liveswitch.ManagedConnection.getKeepAliveInterval ( )

Gets a value indicating how many milliseconds must elapse between STUN keep-alive binding requests.

Defaults to 1000.

◆ getLayoutPriority()

fm.liveswitch.NullableInteger fm.liveswitch.ManagedConnection.getLayoutPriority ( )

Gets the LayoutPriority.

◆ getLayoutZone()

String fm.liveswitch.ManagedConnection.getLayoutZone ( )

Gets the LayoutZone.

◆ getLocalAudioDirection()

String fm.liveswitch.ManagedConnection.getLocalAudioDirection ( )

Gets the local audio direction.

Null if disabled.

◆ getLocalAudioDisabled()

boolean fm.liveswitch.ManagedConnection.getLocalAudioDisabled ( )

Gets if local audio is disabled.

◆ getLocalAudioFormats()

fm.liveswitch.FormatInfo [] fm.liveswitch.ManagedConnection.getLocalAudioFormats ( )

Gets the local audio formats.

◆ getLocalAudioMuted()

boolean fm.liveswitch.ManagedConnection.getLocalAudioMuted ( )

Gets whether the local audio is muted.

◆ getLocalDataDirection()

String fm.liveswitch.ManagedConnection.getLocalDataDirection ( )

Gets the local data direction.

Null if disabled.

◆ getLocalDataDisabled()

boolean fm.liveswitch.ManagedConnection.getLocalDataDisabled ( )

Gets if local data is disabled.

◆ getLocalDescription()

fm.liveswitch.SessionDescription fm.liveswitch.ManagedConnection.getLocalDescription ( )

Gets the local description.

◆ getLocalDtlsCertificate()

fm.liveswitch.DtlsCertificate fm.liveswitch.ManagedConnection.getLocalDtlsCertificate ( )

Gets the local DTLS certificate.

◆ getLocalDtlsCertificates()

fm.liveswitch.DtlsCertificate [] fm.liveswitch.ManagedConnection.getLocalDtlsCertificates ( )

Gets the local DTLS certificates.

◆ getLocalVideoDirection()

String fm.liveswitch.ManagedConnection.getLocalVideoDirection ( )

Gets the local video direction.

Null if disabled.

◆ getLocalVideoDisabled()

boolean fm.liveswitch.ManagedConnection.getLocalVideoDisabled ( )

Gets if local video is disabled.

◆ getLocalVideoFormats()

fm.liveswitch.FormatInfo [] fm.liveswitch.ManagedConnection.getLocalVideoFormats ( )

Gets the local video formats.

◆ getLocalVideoMuted()

boolean fm.liveswitch.ManagedConnection.getLocalVideoMuted ( )

Gets whether the local video is muted.

◆ getMaxNoMediaServerRetryBackoff()

int fm.liveswitch.ManagedConnection.getMaxNoMediaServerRetryBackoff ( )

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.

◆ getMediaId()

String fm.liveswitch.ManagedConnection.getMediaId ( )

Gets the media identifier.

◆ getMediaIntents()

String [] fm.liveswitch.ManagedConnection.getMediaIntents ( )

protected

Gets media intents reflected by Gateway.

◆ getMediaProtocol()

fm.liveswitch.MediaProtocol fm.liveswitch.ManagedConnection.getMediaProtocol ( )

Gets the media protocol in use on this connection.

◆ getMediaQuality()

double fm.liveswitch.ManagedConnection.getMediaQuality ( )

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.

◆ getMinNoMediaServerRetryBackoff()

int fm.liveswitch.ManagedConnection.getMinNoMediaServerRetryBackoff ( )

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.

◆ getMultiplexPolicy()

fm.liveswitch.MultiplexPolicy fm.liveswitch.ManagedConnection.getMultiplexPolicy ( )

Gets the multiplex policy.

◆ getNetworkQuality()

double fm.liveswitch.ManagedConnection.getNetworkQuality ( )

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.

◆ getNoMediaServerTimeout()

int fm.liveswitch.ManagedConnection.getNoMediaServerTimeout ( )

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

◆ getPrivateIPAddress()

String fm.liveswitch.ManagedConnection.getPrivateIPAddress ( )

Gets the private IP address of this device.

If set, this will bypass the local network discovery and use this as the sole host candidate.

◆ getPrivateIPAddresses()

String [] fm.liveswitch.ManagedConnection.getPrivateIPAddresses ( )

Gets the private IP address of this device.

If set, this will bypass the local network discovery and use this as the sole host candidate.

◆ getRandomizer()

fm.liveswitch.Randomizer fm.liveswitch.ManagedConnection.getRandomizer ( )

protected

Gets a randomizer for backoff timers.

◆ getRecordingEnabled()

boolean fm.liveswitch.ManagedConnection.getRecordingEnabled ( )

Gets whether this connection is being recorded.

◆ getRemoteAudioDisabled()

boolean fm.liveswitch.ManagedConnection.getRemoteAudioDisabled ( )

Gets if remote audio is disabled.

◆ getRemoteAudioEncoding()

fm.liveswitch.EncodingInfo fm.liveswitch.ManagedConnection.getRemoteAudioEncoding ( )

Gets the remote audio encoding.

◆ getRemoteAudioFormats()

fm.liveswitch.FormatInfo [] fm.liveswitch.ManagedConnection.getRemoteAudioFormats ( )

Gets the remote audio formats.

◆ getRemoteAudioMuted()

boolean fm.liveswitch.ManagedConnection.getRemoteAudioMuted ( )

Gets whether the remote audio is muted.

◆ getRemoteClosed()

boolean fm.liveswitch.ManagedConnection.getRemoteClosed ( )

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

◆ getRemoteConnectionId()

String fm.liveswitch.ManagedConnection.getRemoteConnectionId ( )

Gets the remote connection identifier, if available.

◆ getRemoteDataDisabled()

boolean fm.liveswitch.ManagedConnection.getRemoteDataDisabled ( )

Gets if remote data is disabled.

◆ getRemoteDescription()

fm.liveswitch.SessionDescription fm.liveswitch.ManagedConnection.getRemoteDescription ( )

Gets the remote description.

◆ getRemoteMediaId()

String fm.liveswitch.ManagedConnection.getRemoteMediaId ( )

Gets the remote media identifier, if available.

◆ getRemoteRejected()

boolean fm.liveswitch.ManagedConnection.getRemoteRejected ( )

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

◆ getRemoteTag()

String fm.liveswitch.ManagedConnection.getRemoteTag ( )

Gets the remote tag, if applicable.

◆ getRemoteVideoDisabled()

boolean fm.liveswitch.ManagedConnection.getRemoteVideoDisabled ( )

Gets if remote video is disabled.

◆ getRemoteVideoEncoding()

fm.liveswitch.EncodingInfo fm.liveswitch.ManagedConnection.getRemoteVideoEncoding ( )

Gets the remote video encoding.

◆ getRemoteVideoFormats()

fm.liveswitch.FormatInfo [] fm.liveswitch.ManagedConnection.getRemoteVideoFormats ( )

Gets the remote video formats.

◆ getRemoteVideoMuted()

boolean fm.liveswitch.ManagedConnection.getRemoteVideoMuted ( )

Gets whether the remote video is muted.

◆ getSignallingState()

fm.liveswitch.SignallingState fm.liveswitch.ManagedConnection.getSignallingState ( )

Gets the state of the signalling.

◆ getState()

fm.liveswitch.ConnectionState fm.liveswitch.ManagedConnection.getState ( )

Gets the state of the connection.

◆ getStats()

fm.liveswitch.Future<fm.liveswitch.ConnectionStats> fm.liveswitch.ManagedConnection.getStats ( )

Gets the current connection stats.

◆ getStatsEventInterval()

int fm.liveswitch.ManagedConnection.getStatsEventInterval ( )

Gets the interval, in milliseconds, between stats events raised locally by fm.liveswitch.ManagedConnection#addOnStats.

The default value is 1000 (1 second).

◆ getStatsInterval()

int fm.liveswitch.ManagedConnection.getStatsInterval ( )

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.

◆ getStatsReportInterval()

int fm.liveswitch.ManagedConnection.getStatsReportInterval ( )

Gets the interval, in milliseconds, between stats reports sent to the Gateway.

The default value is 10,000 (10 seconds).

◆ getStunBindingRequestLimit()

int fm.liveswitch.ManagedConnection.getStunBindingRequestLimit ( )

Gets the limit on the the number of Turn Allocate request messages when trying to establish allocation on a Turn server.

◆ getStunRequestTimeout()

int fm.liveswitch.ManagedConnection.getStunRequestTimeout ( )

Gets the timeout for individual Stun (and Turn) request messages in ms.

◆ getTag()

String fm.liveswitch.ManagedConnection.getTag ( )

Gets the tag.

◆ getTcpConnectTimeout()

int fm.liveswitch.ManagedConnection.getTcpConnectTimeout ( )

Gets connection timeout for stream sockets in ms.

◆ getTestReceivedRtpBuffer()

fm.liveswitch.IFunction1<fm.liveswitch.DataBuffer,fm.liveswitch.DataBuffer> fm.liveswitch.ManagedConnection.getTestReceivedRtpBuffer ( )

Gets a method that can be used to test and optionally modify inbound RTP buffers.

FOR TESTING PURPOSES ONLY. Returning

null

will cause the buffer to be discarded.

◆ getTestRoundTripTime()

int fm.liveswitch.ManagedConnection.getTestRoundTripTime ( )

Gets a fixed round-trip time (in milliseconds) to use in the network transport.

FOR TESTING PURPOSES ONLY. Defaults to -1, which indicates that normal round-trip time calculations should be used.

◆ getTestSendingRtpBuffer()

fm.liveswitch.IFunction1<fm.liveswitch.DataBuffer,fm.liveswitch.DataBuffer> fm.liveswitch.ManagedConnection.getTestSendingRtpBuffer ( )

Gets a method that can be used to test and optionally modify outbound RTP buffers.

FOR TESTING PURPOSES ONLY. Returning

null

will cause the buffer to be discarded.

◆ getTrickleIcePolicy()

fm.liveswitch.TrickleIcePolicy fm.liveswitch.ManagedConnection.getTrickleIcePolicy ( )

Gets the trickle-ICE policy.

◆ getTurnAllocateRequestLimit()

int fm.liveswitch.ManagedConnection.getTurnAllocateRequestLimit ( )

Gets the limit on the the number of Turn Allocate request messages when trying to establish allocation on a Turn server.

◆ getType()

String fm.liveswitch.ManagedConnection.getType ( )

Gets the connection type.

◆ getUserId()

String fm.liveswitch.ManagedConnection.getUserId ( )

Gets the user identifier.

◆ getUseWebSocketsForMedia()

boolean fm.liveswitch.ManagedConnection.getUseWebSocketsForMedia ( )

Gets if we should use WebSockets for sending media.

◆ getVideoDirection()

String fm.liveswitch.ManagedConnection.getVideoDirection ( )

Gets the video direction.

Null if disabled.

◆ getVideoEnabledConnectionUpdateAttempts()

int fm.liveswitch.ManagedConnection.getVideoEnabledConnectionUpdateAttempts ( )

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.

◆ getVideoEnabledUpdateConnectionPolicy()

fm.liveswitch.IFunction1<Integer,Integer> fm.liveswitch.ManagedConnection.getVideoEnabledUpdateConnectionPolicy ( )

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.

◆ getVideoRetentionPolicy()

fm.liveswitch.VideoRetentionPolicy fm.liveswitch.ManagedConnection.getVideoRetentionPolicy ( )

Gets the Video Retention Policy.

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

◆ getVideoStream()

fm.liveswitch.VideoStream fm.liveswitch.ManagedConnection.getVideoStream ( )

Gets the video stream.

◆ getVideoUnmuteDisabled()

boolean fm.liveswitch.ManagedConnection.getVideoUnmuteDisabled ( )

Gets whether the ability to unmute video is disabled.

◆ getWmsAddress()

String fm.liveswitch.ManagedConnection.getWmsAddress ( )

Gets the WMS endpoint address.

◆ getWmsConnectionToken()

String fm.liveswitch.ManagedConnection.getWmsConnectionToken ( )

Gets WMS connection token.

◆ isMediaDirectionAllowed()

abstract boolean fm.liveswitch.ManagedConnection.isMediaDirectionAllowed ( String direction )

abstractprotected

Gets a value indicating whether the given direction is allowed for this connection.

Parameters

direction The direction.

Reimplemented in fm.liveswitch.SfuUpstreamConnection, fm.liveswitch.SfuDownstreamConnection, fm.liveswitch.PeerConnection, and fm.liveswitch.McuConnection.

◆ open()

fm.liveswitch.Future<Object> fm.liveswitch.ManagedConnection.open ( )

Opens the connection.

◆ processAnswer()

abstract void fm.liveswitch.ManagedConnection.processAnswer ( fm.liveswitch.Message message )

abstractprotected

Processes an answer.

Parameters

message The message.

Reimplemented in fm.liveswitch.ServerConnection, and fm.liveswitch.PeerConnection.

◆ processError()

void fm.liveswitch.ManagedConnection.processError ( fm.liveswitch.Message message )

protected

Processes an error message.

Parameters

message The message.

Reimplemented in fm.liveswitch.ServerConnection, and fm.liveswitch.PeerConnection.

◆ processIceServers()

void fm.liveswitch.ManagedConnection.processIceServers ( fm.liveswitch.Message message )

protected

Processes an iceServers message.

Parameters

message The message.

◆ processLocalError()

void fm.liveswitch.ManagedConnection.processLocalError ( fm.liveswitch.Error error )

protected

Processes a local failure.

Parameters

error The error.

◆ processMediaIntentResponse()

void fm.liveswitch.ManagedConnection.processMediaIntentResponse ( fm.liveswitch.Message message )

protected

Processes an iceServers message.

Parameters

message The message.

Reimplemented in fm.liveswitch.ServerConnection.

◆ processRtcpDataChannelSignallingActivation()

void fm.liveswitch.ManagedConnection.processRtcpDataChannelSignallingActivation ( fm.liveswitch.Message message )

protected

Processes inband signalling activation.

Parameters

message

Reimplemented in fm.liveswitch.ServerConnection.

◆ processSimulcastNotification()

void fm.liveswitch.ManagedConnection.processSimulcastNotification ( fm.liveswitch.Message message )

protected

Processes a simulcast notification.

Parameters

message The simulcast notificaiton message.

◆ raiseAudioBitrateNotification()

void fm.liveswitch.ManagedConnection.raiseAudioBitrateNotification	(	fm.liveswitch.AudioStream	audioStream,
		fm.liveswitch.BitrateNotification	bitrateNotification
	)

protected

Raises an audio bitrate notification.

Parameters

audioStream	The audio stream.
bitrateNotification	The bitrate notification.

Reimplemented in fm.liveswitch.ServerConnection.

◆ raiseAudioBitrateRequest()

void fm.liveswitch.ManagedConnection.raiseAudioBitrateRequest	(	fm.liveswitch.AudioStream	audioStream,
		fm.liveswitch.BitrateRequest	bitrateRequest
	)

protected

Raises an audio bitrate request.

Parameters

audioStream	The audio stream.
bitrateRequest	The bitrate request.

◆ raiseLocalCandidate()

void fm.liveswitch.ManagedConnection.raiseLocalCandidate ( fm.liveswitch.Candidate localCandidate )

protected

Raises a local candidate.

Parameters

localCandidate The local candidate.

◆ raiseNoMediaServersAvailable()

void fm.liveswitch.ManagedConnection.raiseNoMediaServersAvailable ( fm.liveswitch.NoMediaServersAvailableEventArgs args )

protected

Raises the OnNoMediaServersAvailable event.

◆ raiseNoWebSocketMediaServersAvailable()

void fm.liveswitch.ManagedConnection.raiseNoWebSocketMediaServersAvailable ( fm.liveswitch.NoWebSocketMediaServersAvailableEventArgs args )

protected

Raises the OnNoWebSocketMediaServersAvailable event.

◆ raiseRemoteCandidate()

void fm.liveswitch.ManagedConnection.raiseRemoteCandidate ( fm.liveswitch.Candidate remoteCandidate )

protected

Raises a remote candidate.

Parameters

remoteCandidate The remote candidate.

◆ raiseVideoBitrateNotification()

void fm.liveswitch.ManagedConnection.raiseVideoBitrateNotification	(	fm.liveswitch.VideoStream	videoStream,
		fm.liveswitch.BitrateNotification	bitrateNotification
	)

protected

Raises a video bitrate notification.

Parameters

videoStream	The video stream.
bitrateNotification	The bitrate notification.

Reimplemented in fm.liveswitch.ServerConnection.

◆ raiseVideoBitrateRequest()

void fm.liveswitch.ManagedConnection.raiseVideoBitrateRequest	(	fm.liveswitch.VideoStream	videoStream,
		fm.liveswitch.BitrateRequest	bitrateRequest
	)

protected

Raises a video bitrate request.

Parameters

videoStream	The video stream.
bitrateRequest	The bitrate request.

◆ removeOnAudioUnmuteDisabled()

void fm.liveswitch.ManagedConnection.removeOnAudioUnmuteDisabled ( fm.liveswitch.IAction0 value )

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

◆ removeOnAudioUnmuteEnabled()

void fm.liveswitch.ManagedConnection.removeOnAudioUnmuteEnabled ( fm.liveswitch.IAction0 value )

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

◆ removeOnAutomaticIceServers()

void fm.liveswitch.ManagedConnection.removeOnAutomaticIceServers ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.IceServerCollection > value )

Removes a handler that is raised when automatic ICE servers have been received.

Parameters:

connection - the connection
automaticIceServers - the automatic ICE severs collection

◆ removeOnGatheringStateChange()

void fm.liveswitch.ManagedConnection.removeOnGatheringStateChange ( fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value )

Removes a handler that is raised when the ICE gathering state changes.

Parameters:

connection - the connection

◆ removeOnIceConnectionStateChange()

void fm.liveswitch.ManagedConnection.removeOnIceConnectionStateChange ( fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value )

Removes a handler that is raised when the ICE connection state changes.

Parameters:

connection - the connection

◆ removeOnLocalCandidate()

void fm.liveswitch.ManagedConnection.removeOnLocalCandidate ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.Candidate > value )

Removes a handler that is raised when a local candidate is ready.

Parameters:

connection - the connection
candidate - the local candidate

◆ removeOnLocalDescription()

void fm.liveswitch.ManagedConnection.removeOnLocalDescription ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.SessionDescription > value )

Removes a handler that is raised when the local description is ready.

Parameters:

connection - the connection
description - the local description

◆ removeOnMediaQuality()

void fm.liveswitch.ManagedConnection.removeOnMediaQuality ( fm.liveswitch.IAction1< Double > value )

Removes a handler that is raised every fm.liveswitch.ManagedConnection#getStatsEventInterval 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.

◆ removeOnNetworkQuality()

void fm.liveswitch.ManagedConnection.removeOnNetworkQuality ( fm.liveswitch.IAction1< Double > value )

Removes a handler that is raised every fm.liveswitch.ManagedConnection#getStatsEventInterval 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.

◆ removeOnNoMediaServersAvailable()

void fm.liveswitch.ManagedConnection.removeOnNoMediaServersAvailable ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.NoMediaServersAvailableEventArgs > value )

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

◆ removeOnNoWebSocketMediaServersAvailable()

void fm.liveswitch.ManagedConnection.removeOnNoWebSocketMediaServersAvailable ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.NoWebSocketMediaServersAvailableEventArgs > value )

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

◆ removeOnRecordingDisabled()

void fm.liveswitch.ManagedConnection.removeOnRecordingDisabled ( fm.liveswitch.IAction1< String > value )

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

◆ removeOnRecordingEnabled()

void fm.liveswitch.ManagedConnection.removeOnRecordingEnabled ( fm.liveswitch.IAction1< String > value )

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

◆ removeOnRemoteAudioEncodingSwitch()

void fm.liveswitch.ManagedConnection.removeOnRemoteAudioEncodingSwitch ( fm.liveswitch.IAction2< fm.liveswitch.EncodingInfo, fm.liveswitch.EncodingInfo > value )

Removes a handler that is raised when the remote audio encoding is switched by the server.

◆ removeOnRemoteCandidate()

void fm.liveswitch.ManagedConnection.removeOnRemoteCandidate ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.Candidate > value )

Removes a handler that is raised when a remote candidate is ready.

Parameters:

connection - the connection
candidate - the remote candidate

◆ removeOnRemoteDescription()

void fm.liveswitch.ManagedConnection.removeOnRemoteDescription ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, fm.liveswitch.SessionDescription > value )

Removes a handler that is raised when the remote description is ready.

Parameters:

connection - the connection
description - the remote description

◆ removeOnRemoteUpdate()

void fm.liveswitch.ManagedConnection.removeOnRemoteUpdate ( fm.liveswitch.IAction2< fm.liveswitch.ConnectionInfo, fm.liveswitch.ConnectionInfo > value )

Removes a handler that is raised when a remote connection has been updated.

◆ removeOnRemoteVideoEncodingSwitch()

void fm.liveswitch.ManagedConnection.removeOnRemoteVideoEncodingSwitch ( fm.liveswitch.IAction2< fm.liveswitch.EncodingInfo, fm.liveswitch.EncodingInfo > value )

Removes a handler that is raised when the remote video encoding is switched by the server.

◆ removeOnSignallingStateChange()

void fm.liveswitch.ManagedConnection.removeOnSignallingStateChange ( fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value )

Removes a handler that is raised when the signalling state changes.

Parameters:

connection - the connection

◆ removeOnStateChange()

void fm.liveswitch.ManagedConnection.removeOnStateChange ( fm.liveswitch.IAction1< fm.liveswitch.ManagedConnection > value )

Removes a handler that is raised when the connection state changes.

Parameters:

connection - the connection

◆ removeOnStats()

void fm.liveswitch.ManagedConnection.removeOnStats ( fm.liveswitch.IAction1< fm.liveswitch.ConnectionStats > value )

Removes a handler that is raised every fm.liveswitch.ManagedConnection#getStatsEventInterval milliseconds with the current connection stats.

◆ removeOnVideoEnabledChange()

void fm.liveswitch.ManagedConnection.removeOnVideoEnabledChange ( fm.liveswitch.IAction2< fm.liveswitch.ManagedConnection, Boolean > value )

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.

◆ removeOnVideoUnmuteDisabled()

void fm.liveswitch.ManagedConnection.removeOnVideoUnmuteDisabled ( fm.liveswitch.IAction0 value )

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

◆ removeOnVideoUnmuteEnabled()

void fm.liveswitch.ManagedConnection.removeOnVideoUnmuteEnabled ( fm.liveswitch.IAction0 value )

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

◆ send()

fm.liveswitch.Future<fm.liveswitch.Message> fm.liveswitch.ManagedConnection.send ( fm.liveswitch.Message message )

protected

Sends a message.

Parameters

message The message.

Reimplemented in fm.liveswitch.ServerConnection, and fm.liveswitch.PeerConnection.

◆ setBundlePolicy()

void fm.liveswitch.ManagedConnection.setBundlePolicy ( fm.liveswitch.BundlePolicy value )

Sets the Bundle Policy.

◆ setCreateDatagramSocket()

void fm.liveswitch.ManagedConnection.setCreateDatagramSocket ( fm.liveswitch.IFunction1< fm.liveswitch.DatagramSocketCreateArgs, fm.liveswitch.DatagramSocket > value )

Sets a method that creates Datagram sockets.

Optional. If not set, default OS UDP socket is used.

◆ setCreateStreamSocket()

void fm.liveswitch.ManagedConnection.setCreateStreamSocket ( fm.liveswitch.IFunction1< fm.liveswitch.StreamSocketCreateArgs, fm.liveswitch.StreamSocket > value )

Sets a method that creates Stream sockets.

Optional. If not set, default OS TCP socket is used.

◆ setDeadStreamTimeout()

void fm.liveswitch.ManagedConnection.setDeadStreamTimeout ( int value )

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.

◆ setDefaultLocalDtlsCertificate()

static void fm.liveswitch.ManagedConnection.setDefaultLocalDtlsCertificate ( fm.liveswitch.DtlsCertificate value )

static

Sets the default local DTLS certificate.

◆ setDefaultLocalDtlsCertificates()

static void fm.liveswitch.ManagedConnection.setDefaultLocalDtlsCertificates ( fm.liveswitch.DtlsCertificate[] value )

static

Sets the default local DTLS certificates.

◆ setDefaultNoMediaServerTimeout()

static void fm.liveswitch.ManagedConnection.setDefaultNoMediaServerTimeout ( int value )

static

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).

◆ setDefaultStatsEventInterval()

static void fm.liveswitch.ManagedConnection.setDefaultStatsEventInterval ( int value )

static

Sets the default interval, in milliseconds, between stats events raised locally by fm.liveswitch.ManagedConnection#addOnStats.

The default value is 1,000 (1 second).

◆ setDefaultStatsInterval()

static void fm.liveswitch.ManagedConnection.setDefaultStatsInterval ( int value )

static

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.

◆ setDefaultStatsReportInterval()

static void fm.liveswitch.ManagedConnection.setDefaultStatsReportInterval ( int value )

static

Sets the default interval, in milliseconds, between stats reports sent to the Gateway.

The default value is 10,000 (10 seconds).

◆ setDisableAutomaticIceServers()

void fm.liveswitch.ManagedConnection.setDisableAutomaticIceServers ( boolean value )

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

◆ setDtlsCipherSuites()

void fm.liveswitch.ManagedConnection.setDtlsCipherSuites ( fm.liveswitch.DtlsCipherSuite[] value )

Sets the DTLS cipher suites to use.

Defaults to: DtlsCipherSuite.EcdheEcdsaAes128Sha, DtlsCipherSuite.EcdheEcdsaAes128GcmSha256, DtlsCipherSuite.EcdheEcdsaAes128CbcSha256, DtlsCipherSuite.EcdheRsaAes128Sha, DtlsCipherSuite.EcdheRsaAes128GcmSha256, DtlsCipherSuite.EcdheRsaAes128CbcSha256, DtlsCipherSuite.RsaAes128Sha, DtlsCipherSuite.RsaAes128GcmSha256, DtlsCipherSuite.RsaAes128CbcSha256,

◆ setDtlsClientVersion()

void fm.liveswitch.ManagedConnection.setDtlsClientVersion ( fm.liveswitch.DtlsProtocolVersion value )

Sets the protocol version to use when in the DTLS client role.

Defaults to fm.liveswitch.DtlsProtocolVersion#Dtls10.

◆ setDtlsServerMaxVersion()

void fm.liveswitch.ManagedConnection.setDtlsServerMaxVersion ( fm.liveswitch.DtlsProtocolVersion value )

Sets the maximum protocol version to allow when in the DTLS server role.

Defaults to fm.liveswitch.DtlsProtocolVersion#Dtls12.

◆ setDtlsServerMinVersion()

void fm.liveswitch.ManagedConnection.setDtlsServerMinVersion ( fm.liveswitch.DtlsProtocolVersion value )

Sets the minimum protocol version to allow when in the DTLS server role.

Defaults to fm.liveswitch.DtlsProtocolVersion#Dtls10.

◆ setIceAddressTypes()

void fm.liveswitch.ManagedConnection.setIceAddressTypes ( fm.liveswitch.AddressType[] value )

Sets the ICE address types.

◆ setIceGatherPolicy()

void fm.liveswitch.ManagedConnection.setIceGatherPolicy ( fm.liveswitch.IceGatherPolicy value )

Sets the ICE gather policy.

◆ setIcePolicy()

void fm.liveswitch.ManagedConnection.setIcePolicy ( fm.liveswitch.IcePolicy value )

Sets policy indicating whether ICE is required (and enabled) or disabled (and not required for this connection).

◆ setIcePortRange()

void fm.liveswitch.ManagedConnection.setIcePortRange ( fm.liveswitch.IcePortRange value )

Sets the ICE port range.

◆ setIceServer()

void fm.liveswitch.ManagedConnection.setIceServer ( fm.liveswitch.IceServer value )

Sets the ICE server.

◆ setIceServers()

void fm.liveswitch.ManagedConnection.setIceServers ( fm.liveswitch.IceServer[] value )

Sets the ICE servers.

◆ setKeepAliveInterval()

void fm.liveswitch.ManagedConnection.setKeepAliveInterval ( int value )

Sets a value indicating how many milliseconds must elapse between STUN keep-alive binding requests.

Defaults to 1000.

◆ setLayoutPriority()

void fm.liveswitch.ManagedConnection.setLayoutPriority ( fm.liveswitch.NullableInteger value )

Sets the LayoutPriority.

◆ setLayoutZone()

void fm.liveswitch.ManagedConnection.setLayoutZone ( String value )

Sets the LayoutZone.

◆ setLocalAudioFormats()

void fm.liveswitch.ManagedConnection.setLocalAudioFormats ( fm.liveswitch.FormatInfo[] value )

protected

Sets the local audio formats.

◆ setLocalDtlsCertificate()

void fm.liveswitch.ManagedConnection.setLocalDtlsCertificate ( fm.liveswitch.DtlsCertificate value )

Sets the local DTLS certificate.

◆ setLocalDtlsCertificates()

void fm.liveswitch.ManagedConnection.setLocalDtlsCertificates ( fm.liveswitch.DtlsCertificate[] value )

Sets the local DTLS certificates.

◆ setLocalVideoFormats()

void fm.liveswitch.ManagedConnection.setLocalVideoFormats ( fm.liveswitch.FormatInfo[] value )

protected

Sets the local video formats.

◆ setMaxNoMediaServerRetryBackoff()

void fm.liveswitch.ManagedConnection.setMaxNoMediaServerRetryBackoff ( int value )

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.

◆ setMediaId()

void fm.liveswitch.ManagedConnection.setMediaId ( String value )

protected

Sets the media identifier.

◆ setMinNoMediaServerRetryBackoff()

void fm.liveswitch.ManagedConnection.setMinNoMediaServerRetryBackoff ( int value )

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.

◆ setMultiplexPolicy()

void fm.liveswitch.ManagedConnection.setMultiplexPolicy ( fm.liveswitch.MultiplexPolicy value )

Sets the multiplex policy.

◆ setNoMediaServerTimeout()

void fm.liveswitch.ManagedConnection.setNoMediaServerTimeout ( int value )

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

◆ setPrivateIPAddress()

void fm.liveswitch.ManagedConnection.setPrivateIPAddress ( String value )

Sets the private IP address of this device.

If set, this will bypass the local network discovery and use this as the sole host candidate.

◆ setPrivateIPAddresses()

void fm.liveswitch.ManagedConnection.setPrivateIPAddresses ( String[] value )

Sets the private IP address of this device.

If set, this will bypass the local network discovery and use this as the sole host candidate.

◆ setRemoteAudioEncoding()

void fm.liveswitch.ManagedConnection.setRemoteAudioEncoding ( fm.liveswitch.EncodingInfo value )

protected

Sets the remote audio encoding.

◆ setRemoteAudioFormats()

void fm.liveswitch.ManagedConnection.setRemoteAudioFormats ( fm.liveswitch.FormatInfo[] value )

protected

Sets the remote audio formats.

◆ setRemoteAudioMuted()

void fm.liveswitch.ManagedConnection.setRemoteAudioMuted ( boolean value )

Sets whether the remote audio is muted.

◆ setRemoteConnectionId()

void fm.liveswitch.ManagedConnection.setRemoteConnectionId ( String value )

protected

Sets the remote connection identifier, if available.

◆ setRemoteMediaId()

void fm.liveswitch.ManagedConnection.setRemoteMediaId ( String value )

protected

Sets the remote media identifier, if available.

◆ setRemoteTag()

void fm.liveswitch.ManagedConnection.setRemoteTag ( String value )

protected

Sets the remote tag, if applicable.

◆ setRemoteVideoEncoding()

void fm.liveswitch.ManagedConnection.setRemoteVideoEncoding ( fm.liveswitch.EncodingInfo value )

protected

Sets the remote video encoding.

◆ setRemoteVideoFormats()

void fm.liveswitch.ManagedConnection.setRemoteVideoFormats ( fm.liveswitch.FormatInfo[] value )

protected

Sets the remote video formats.

◆ setRemoteVideoMuted()

void fm.liveswitch.ManagedConnection.setRemoteVideoMuted ( boolean value )

Sets whether the remote video is muted.

◆ setStatsEventInterval()

void fm.liveswitch.ManagedConnection.setStatsEventInterval ( int value )

Sets the interval, in milliseconds, between stats events raised locally by fm.liveswitch.ManagedConnection#addOnStats.

The default value is 1000 (1 second).

◆ setStatsInterval()

void fm.liveswitch.ManagedConnection.setStatsInterval ( int value )

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.

◆ setStatsReportInterval()

void fm.liveswitch.ManagedConnection.setStatsReportInterval ( int value )

Sets the interval, in milliseconds, between stats reports sent to the Gateway.

The default value is 10,000 (10 seconds).

◆ setStunBindingRequestLimit()

void fm.liveswitch.ManagedConnection.setStunBindingRequestLimit ( int value )

Sets the limit on the the number of Turn Allocate request messages when trying to establish allocation on a Turn server.

◆ setStunRequestTimeout()

void fm.liveswitch.ManagedConnection.setStunRequestTimeout ( int value )

Sets the timeout for individual Stun (and Turn) request messages in ms.

◆ setTag()

void fm.liveswitch.ManagedConnection.setTag ( String value )

Sets the tag.

◆ setTcpConnectTimeout()

void fm.liveswitch.ManagedConnection.setTcpConnectTimeout ( int value )

Sets connection timeout for stream sockets in ms.

◆ setTestReceivedRtpBuffer()

void fm.liveswitch.ManagedConnection.setTestReceivedRtpBuffer ( fm.liveswitch.IFunction1< fm.liveswitch.DataBuffer, fm.liveswitch.DataBuffer > value )

Sets a method that can be used to test and optionally modify inbound RTP buffers.

FOR TESTING PURPOSES ONLY. Returning

null

will cause the buffer to be discarded.

◆ setTestRoundTripTime()

void fm.liveswitch.ManagedConnection.setTestRoundTripTime ( int value )

Sets a fixed round-trip time (in milliseconds) to use in the network transport.

FOR TESTING PURPOSES ONLY. Defaults to -1, which indicates that normal round-trip time calculations should be used.

◆ setTestSendingRtpBuffer()

void fm.liveswitch.ManagedConnection.setTestSendingRtpBuffer ( fm.liveswitch.IFunction1< fm.liveswitch.DataBuffer, fm.liveswitch.DataBuffer > value )

Sets a method that can be used to test and optionally modify outbound RTP buffers.

FOR TESTING PURPOSES ONLY. Returning

null

will cause the buffer to be discarded.

◆ setTrickleIcePolicy()

void fm.liveswitch.ManagedConnection.setTrickleIcePolicy ( fm.liveswitch.TrickleIcePolicy value )

Sets the trickle-ICE policy.

◆ setTurnAllocateRequestLimit()

void fm.liveswitch.ManagedConnection.setTurnAllocateRequestLimit ( int value )

Sets the limit on the the number of Turn Allocate request messages when trying to establish allocation on a Turn server.

◆ setUseWebSocketsForMedia()

void fm.liveswitch.ManagedConnection.setUseWebSocketsForMedia ( boolean value )

protected

Sets if we should use WebSockets for sending media.

◆ setVideoEnabledUpdateConnectionPolicy()

void fm.liveswitch.ManagedConnection.setVideoEnabledUpdateConnectionPolicy ( fm.liveswitch.IFunction1< Integer, Integer > value )

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.

◆ setVideoRetentionPolicy()

void fm.liveswitch.ManagedConnection.setVideoRetentionPolicy ( fm.liveswitch.VideoRetentionPolicy value )

Sets the Video Retention Policy.

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

◆ setWmsAddress()

void fm.liveswitch.ManagedConnection.setWmsAddress ( String value )

Sets the WMS endpoint address.

◆ setWmsConnectionToken()

void fm.liveswitch.ManagedConnection.setWmsConnectionToken ( String value )

Sets WMS connection token.

◆ trySendRtcpDataChannel()

boolean fm.liveswitch.ManagedConnection.trySendRtcpDataChannel ( fm.liveswitch.Message message )

protected

Sends bitrate messages.

Parameters

message The message to send.

Reimplemented in fm.liveswitch.ServerConnection.

◆ update()

fm.liveswitch.Future<Object> fm.liveswitch.ManagedConnection.update ( fm.liveswitch.ConnectionConfig config )

Updates this connection.

Parameters

config The connection configuration.

Returns: A future that resolves when the connection has been updated.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ManagedConnection() [1/2]

◆ ManagedConnection() [2/2]

Member Function Documentation

◆ 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()

◆ getApplicationId()

◆ getAudioDirection()

◆ getAudioStream()

◆ getAudioUnmuteDisabled()

◆ getBundlePolicy()

◆ getCanonicalName()

◆ getChannelId()

◆ getClientId()

◆ getConfig()

◆ getCreateDatagramSocket()

◆ getCreateStreamSocket()

◆ getDataDirection()

◆ getDataStream()

◆ getDeadStreamTimeout()

◆ getDefaultLocalDtlsCertificate()

◆ getDefaultLocalDtlsCertificates()

◆ getDefaultNoMediaServerTimeout()

◆ getDefaultStatsEventInterval()

◆ getDefaultStatsInterval()

◆ getDefaultStatsReportInterval()

◆ getDeviceId()

◆ getDisableAutomaticIceServers()

◆ getDtlsCipherSuites()

◆ getDtlsClientVersion()

◆ getDtlsServerMaxVersion()

◆ getDtlsServerMinVersion()

◆ getError()

◆ getExternalId()

◆ getGatheringState()

◆ getHasAudio()

◆ getHasData()

◆ getHasVideo()

◆ getIceAddressTypes()

◆ getIceConnectionState()

◆ getIceGatherPolicy()

◆ getIcePolicy()

◆ getIcePortRange()

◆ getIceRole()

◆ getIceServer()

◆ getIceServers()