An SFU receiving connection. More...

Public Member Functions
fm.liveswitch.ConnectionInfo	getRemoteConnectionInfo ()
	Gets the remote connection information, if available. More...

Public Member Functions inherited from fm.liveswitch.ServerConnection
void	addOnInboundAudioBitrateChange (fm.liveswitch.IAction2< Integer, Integer > value)
	Adds a handler that is raised when the inbound audio bitrate changes. More...

void	addOnInboundVideoBitrateChange (fm.liveswitch.IAction2< Integer, Integer > value)
	Adds a handler that is raised when the inbound video bitrate changes. More...

int	getInboundAudioBitrate ()
	Gets the current inbound audio bitrate. More...

int	getInboundVideoBitrate ()
	Gets the current inbound video bitrate. More...

String	getMediaServerId ()
	Gets the identifier of the Media Server handling this connection. More...

String	getPreferredMediaServerId ()
	Gets the preferred identifier of the Media Server to handle this connection. More...

void	removeOnInboundAudioBitrateChange (fm.liveswitch.IAction2< Integer, Integer > value)
	Removes a handler that is raised when the inbound audio bitrate changes. More...

void	removeOnInboundVideoBitrateChange (fm.liveswitch.IAction2< Integer, Integer > value)
	Removes a handler that is raised when the inbound video bitrate changes. More...

void	setPreferredMediaServerId (String value)
	Sets the preferred identifier of the Media Server to handle this connection. More...

Public Member Functions inherited from fm.liveswitch.ManagedConnection
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...

Protected Member Functions
fm.liveswitch.Message	doCreateOfferMessage (fm.liveswitch.SessionDescription offer)
	Creates an offer message. More...

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

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

Protected Member Functions inherited from fm.liveswitch.ServerConnection
void	detachInternalEventHandlers ()
	Detaches internal event handlers. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Member Functions inherited from fm.liveswitch.ManagedConnection
fm.liveswitch.Message	doCreateUpdateMessage (fm.liveswitch.ConnectionConfig config)
	Creates an update 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...

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

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

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

void	processSimulcastNotification (fm.liveswitch.Message message)
	Processes a simulcast 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	raiseVideoBitrateRequest (fm.liveswitch.VideoStream videoStream, fm.liveswitch.BitrateRequest bitrateRequest)
	Raises a video bitrate request. 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...

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

Additional Inherited Members
Static Public Member Functions inherited from fm.liveswitch.ManagedConnection
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...

Detailed Description

An SFU receiving connection.

Member Function Documentation

◆ doCreateOfferMessage()

fm.liveswitch.Message fm.liveswitch.SfuDownstreamConnection.doCreateOfferMessage ( fm.liveswitch.SessionDescription offer )

protected

Creates an offer message.

Parameters

offer The offer.

Reimplemented from fm.liveswitch.ServerConnection.

◆ doCreateUseWebSocketServiceMessage()

fm.liveswitch.Message fm.liveswitch.SfuDownstreamConnection.doCreateUseWebSocketServiceMessage ( )

protected

Create the message to use WebSockets for media.

Reimplemented from fm.liveswitch.ManagedConnection.

◆ getRemoteConnectionInfo()

fm.liveswitch.ConnectionInfo fm.liveswitch.SfuDownstreamConnection.getRemoteConnectionInfo ( )

Gets the remote connection information, if available.

◆ isMediaDirectionAllowed()

boolean fm.liveswitch.SfuDownstreamConnection.isMediaDirectionAllowed ( String direction )

protected

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

Parameters

direction The direction.

Reimplemented from fm.liveswitch.ManagedConnection.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ doCreateOfferMessage()

◆ doCreateUseWebSocketServiceMessage()

◆ getRemoteConnectionInfo()

◆ isMediaDirectionAllowed()