Connection interface. More...

Public Member Functions
abstract void	addIceServer (fm.liveswitch.IceServer iceServer)
	Adds an ICE server. More...

abstract void	addIceServers (fm.liveswitch.IceServer[] iceServers)
	Adds some ICE servers. More...

abstract void	addOnExternalIdChange (fm.liveswitch.IAction2< String, String > value)
	Adds a handler that is raised when external connection Id changes. More...

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

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

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

abstract void	addOnLocalDescription (fm.liveswitch.IAction2< TConnection, fm.liveswitch.SessionDescription > value)
	Adds a handler that is raised when a local description is set. More...

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

abstract void	addOnRemoteDescription (fm.liveswitch.IAction2< TConnection, fm.liveswitch.SessionDescription > value)
	Adds a handler that is raised when a remote description is set. More...

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

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

abstract fm.liveswitch.Future< fm.liveswitch.Candidate >	addRemoteCandidate (fm.liveswitch.Candidate remoteCandidate)
	Adds the remote candidate. More...

abstract boolean	close ()
	Closes this instance. More...

abstract fm.liveswitch.Future< fm.liveswitch.SessionDescription >	createAnswer ()
	Creates an answer. More...

abstract fm.liveswitch.Future< fm.liveswitch.SessionDescription >	createOffer ()
	Creates an offer. More...

abstract TAudioStream	getAudioStream ()
	Gets the first audio stream. More...

abstract TAudioStream[]	getAudioStreams ()
	Gets the audio streams. More...

abstract fm.liveswitch.BundlePolicy	getBundlePolicy ()
	Gets the bundle policy for this connection. More...

abstract String	getCanonicalName ()
	Gets the canonical name. More...

abstract TDataStream	getDataStream ()
	Gets the first data stream. More...

abstract TDataStream[]	getDataStreams ()
	Gets the data streams. More...

abstract int	getDeadStreamTimeout ()
	Gets the amount of time (in milliseconds) to wait for connectivity checks to re-establish after they start to fail on a live connection. More...

abstract fm.liveswitch.Error	getError ()
	Gets the error. More...

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

abstract fm.liveswitch.IceGatheringState	getGatheringState ()
	Gets the ICE gathering state. More...

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

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

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

abstract fm.liveswitch.IceConnectionState	getIceConnectionState ()
	Gets the ICE connection state. More...

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

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

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

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

abstract boolean	getLegacyTimeout ()
	Gets a value indicating whether legacy Connection.Timeout should be used. More...

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

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

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

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

abstract fm.liveswitch.ConnectionState	getState ()
	Gets the current state. More...

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

abstract TStream[]	getStreams ()
	Gets the streams. More...

abstract String	getTieBreaker ()
	Gets the tie breaker. More...

abstract int	getTimeout ()
	Gets the amount of time (in milliseconds) to wait for a connection to establish before giving up and closing it. More...

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

abstract TVideoStream	getVideoStream ()
	Gets the first video stream. More...

abstract TVideoStream[]	getVideoStreams ()
	Gets the video streams. More...

abstract void	removeIceServer (fm.liveswitch.IceServer iceServer)
	Removes an ICE server. More...

abstract void	removeIceServers (fm.liveswitch.IceServer[] iceServers)
	Removes some ICE servers. More...

abstract void	removeOnExternalIdChange (fm.liveswitch.IAction2< String, String > value)
	Removes a handler that is raised when external connection Id changes. More...

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

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

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

abstract void	removeOnLocalDescription (fm.liveswitch.IAction2< TConnection, fm.liveswitch.SessionDescription > value)
	Removes a handler that is raised when a local description is set. More...

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

abstract void	removeOnRemoteDescription (fm.liveswitch.IAction2< TConnection, fm.liveswitch.SessionDescription > value)
	Removes a handler that is raised when a remote description is set. More...

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

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

abstract void	setBundlePolicy (fm.liveswitch.BundlePolicy value)
	Sets the bundle policy for this connection. More...

abstract void	setDeadStreamTimeout (int value)
	Sets the amount of time (in milliseconds) to wait for connectivity checks to re-establish after they start to fail on a live connection. More...

abstract void	setError (fm.liveswitch.Error value)
	Sets the error. More...

abstract void	setExternalId (String value)
	Sets the external identifier. More...

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

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

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

abstract void	setLegacyTimeout (boolean value)
	Sets a value indicating whether legacy Connection.Timeout should be used. More...

abstract fm.liveswitch.Future< fm.liveswitch.SessionDescription >	setLocalDescription (fm.liveswitch.SessionDescription localDescription)
	Sets the local description. More...

abstract fm.liveswitch.Future< fm.liveswitch.SessionDescription >	setRemoteDescription (fm.liveswitch.SessionDescription remoteDescription)
	Sets the remote description. More...

abstract void	setTieBreaker (String value)
	Sets the tie breaker. More...

abstract void	setTimeout (int value)
	Sets the amount of time (in milliseconds) to wait for a connection to establish before giving up and closing it. More...

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

Detailed Description

Connection interface.

Member Function Documentation

◆ addIceServer()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.addIceServer ( fm.liveswitch.IceServer iceServer )

abstract

Adds an ICE server.

◆ addIceServers()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.addIceServers ( fm.liveswitch.IceServer[] iceServers )

abstract

Adds some ICE servers.

◆ addOnExternalIdChange()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.addOnExternalIdChange ( fm.liveswitch.IAction2< String, String > value )

abstract

Adds a handler that is raised when external connection Id changes.

◆ addOnGatheringStateChange()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.addOnGatheringStateChange ( fm.liveswitch.IAction1< TConnection > value )

abstract

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

◆ addOnIceConnectionStateChange()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.addOnIceConnectionStateChange ( fm.liveswitch.IAction1< TConnection > value )

abstract

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

◆ addOnLocalCandidate()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.addOnLocalCandidate ( fm.liveswitch.IAction2< TConnection, fm.liveswitch.Candidate > value )

abstract

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

◆ addOnLocalDescription()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.addOnLocalDescription ( fm.liveswitch.IAction2< TConnection, fm.liveswitch.SessionDescription > value )

abstract

Adds a handler that is raised when a local description is set.

◆ addOnRemoteCandidate()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.addOnRemoteCandidate ( fm.liveswitch.IAction2< TConnection, fm.liveswitch.Candidate > value )

abstract

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

◆ addOnRemoteDescription()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.addOnRemoteDescription ( fm.liveswitch.IAction2< TConnection, fm.liveswitch.SessionDescription > value )

abstract

Adds a handler that is raised when a remote description is set.

◆ addOnSignallingStateChange()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.addOnSignallingStateChange ( fm.liveswitch.IAction1< TConnection > value )

abstract

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

◆ addOnStateChange()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.addOnStateChange ( fm.liveswitch.IAction1< TConnection > value )

abstract

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

◆ addRemoteCandidate()

abstract fm.liveswitch.Future<fm.liveswitch.Candidate> fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.addRemoteCandidate ( fm.liveswitch.Candidate remoteCandidate )

abstract

Adds the remote candidate.

◆ close()

abstract boolean fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.close ( )

abstract

Closes this instance.

◆ createAnswer()

abstract fm.liveswitch.Future<fm.liveswitch.SessionDescription> fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.createAnswer ( )

abstract

Creates an answer.

◆ createOffer()

abstract fm.liveswitch.Future<fm.liveswitch.SessionDescription> fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.createOffer ( )

abstract

Creates an offer.

◆ getAudioStream()

abstract TAudioStream fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getAudioStream ( )

abstract

Gets the first audio stream.

◆ getAudioStreams()

abstract TAudioStream [] fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getAudioStreams ( )

abstract

Gets the audio streams.

◆ getBundlePolicy()

abstract fm.liveswitch.BundlePolicy fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getBundlePolicy ( )

abstract

Gets the bundle policy for this connection.

◆ getCanonicalName()

abstract String fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getCanonicalName ( )

abstract

Gets the canonical name.

◆ getDataStream()

abstract TDataStream fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getDataStream ( )

abstract

Gets the first data stream.

◆ getDataStreams()

abstract TDataStream [] fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getDataStreams ( )

abstract

Gets the data streams.

◆ getDeadStreamTimeout()

abstract int fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getDeadStreamTimeout ( )

abstract

Gets the amount of time (in milliseconds) to wait for connectivity checks to re-establish after they start to fail on a live connection.

Defaults to 10,000.

◆ getError()

abstract fm.liveswitch.Error fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getError ( )

abstract

Gets the error.

◆ getExternalId()

abstract String fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getExternalId ( )

abstract

Gets the external identifier.

◆ getGatheringState()

abstract fm.liveswitch.IceGatheringState fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getGatheringState ( )

abstract

Gets the ICE gathering state.

◆ getHasAudio()

abstract boolean fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getHasAudio ( )

abstract

Gets whether this connection has an audio stream.

◆ getHasData()

abstract boolean fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getHasData ( )

abstract

Gets whether this connection has a data stream.

◆ getHasVideo()

abstract boolean fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getHasVideo ( )

abstract

Gets whether this connection has a video stream.

◆ getIceConnectionState()

abstract fm.liveswitch.IceConnectionState fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getIceConnectionState ( )

abstract

Gets the ICE connection state.

◆ getIceGatherPolicy()

abstract fm.liveswitch.IceGatherPolicy fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getIceGatherPolicy ( )

abstract

Gets the ICE gather policy.

◆ getIceServer()

abstract fm.liveswitch.IceServer fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getIceServer ( )

abstract

Gets the ICE server.

◆ getIceServers()

abstract fm.liveswitch.IceServer [] fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getIceServers ( )

abstract

Gets the ICE servers.

◆ getId()

abstract String fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getId ( )

abstract

Gets the identifier.

◆ getLegacyTimeout()

abstract boolean fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getLegacyTimeout ( )

abstract

Gets a value indicating whether legacy Connection.Timeout should be used.

When disabled, Connection.Timeout only accounts for the time spent trying to establish connectivity (i.e. time it takes to transition from the Connecting to the Connected state; from the time point when both offer and answer had been set to the connection being fully established). When enabled, Connection.Timeout accounts for the time spent from receiving an offer (or creating an offer) to establishing connectivity (i.e. time it takes to transition from Initializing to Connected state). By default, LegacyTimeout is set to true, so that existing behavior is preserved. However, in the future default will be updated to false. This means that IL will not account for any signalling delays that may occur while establishing connectivity. This option will be later deprecated.

◆ getLocalDescription()

abstract fm.liveswitch.SessionDescription fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getLocalDescription ( )

abstract

Gets the local description.

◆ getMediaProtocol()

abstract fm.liveswitch.MediaProtocol fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getMediaProtocol ( )

abstract

Gets the media protocol in use on this connection.

◆ getRemoteDescription()

abstract fm.liveswitch.SessionDescription fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getRemoteDescription ( )

abstract

Gets the remote description.

◆ getSignallingState()

abstract fm.liveswitch.SignallingState fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getSignallingState ( )

abstract

Gets the current signalling state.

◆ getState()

abstract fm.liveswitch.ConnectionState fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getState ( )

abstract

Gets the current state.

◆ getStats()

abstract fm.liveswitch.Future<fm.liveswitch.ConnectionStats> fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getStats ( )

abstract

Gets connection stats.

◆ getStreams()

abstract TStream [] fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getStreams ( )

abstract

Gets the streams.

◆ getTieBreaker()

abstract String fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getTieBreaker ( )

abstract

Gets the tie breaker.

◆ getTimeout()

abstract int fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getTimeout ( )

abstract

Gets the amount of time (in milliseconds) to wait for a connection to establish before giving up and closing it.

Defaults to 30,000.

◆ getTrickleIcePolicy()

abstract fm.liveswitch.TrickleIcePolicy fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getTrickleIcePolicy ( )

abstract

Gets the trickle ICE policy.

◆ getVideoStream()

abstract TVideoStream fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getVideoStream ( )

abstract

Gets the first video stream.

◆ getVideoStreams()

abstract TVideoStream [] fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.getVideoStreams ( )

abstract

Gets the video streams.

◆ removeIceServer()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.removeIceServer ( fm.liveswitch.IceServer iceServer )

abstract

Removes an ICE server.

◆ removeIceServers()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.removeIceServers ( fm.liveswitch.IceServer[] iceServers )

abstract

Removes some ICE servers.

◆ removeOnExternalIdChange()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.removeOnExternalIdChange ( fm.liveswitch.IAction2< String, String > value )

abstract

Removes a handler that is raised when external connection Id changes.

◆ removeOnGatheringStateChange()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.removeOnGatheringStateChange ( fm.liveswitch.IAction1< TConnection > value )

abstract

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

◆ removeOnIceConnectionStateChange()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.removeOnIceConnectionStateChange ( fm.liveswitch.IAction1< TConnection > value )

abstract

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

◆ removeOnLocalCandidate()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.removeOnLocalCandidate ( fm.liveswitch.IAction2< TConnection, fm.liveswitch.Candidate > value )

abstract

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

◆ removeOnLocalDescription()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.removeOnLocalDescription ( fm.liveswitch.IAction2< TConnection, fm.liveswitch.SessionDescription > value )

abstract

Removes a handler that is raised when a local description is set.

◆ removeOnRemoteCandidate()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.removeOnRemoteCandidate ( fm.liveswitch.IAction2< TConnection, fm.liveswitch.Candidate > value )

abstract

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

◆ removeOnRemoteDescription()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.removeOnRemoteDescription ( fm.liveswitch.IAction2< TConnection, fm.liveswitch.SessionDescription > value )

abstract

Removes a handler that is raised when a remote description is set.

◆ removeOnSignallingStateChange()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.removeOnSignallingStateChange ( fm.liveswitch.IAction1< TConnection > value )

abstract

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

◆ removeOnStateChange()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.removeOnStateChange ( fm.liveswitch.IAction1< TConnection > value )

abstract

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

◆ setBundlePolicy()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setBundlePolicy ( fm.liveswitch.BundlePolicy value )

abstract

Sets the bundle policy for this connection.

◆ setDeadStreamTimeout()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setDeadStreamTimeout ( int value )

abstract

Sets the amount of time (in milliseconds) to wait for connectivity checks to re-establish after they start to fail on a live connection.

Defaults to 10,000.

◆ setError()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setError ( fm.liveswitch.Error value )

abstract

Sets the error.

◆ setExternalId()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setExternalId ( String value )

abstract

Sets the external identifier.

◆ setIceGatherPolicy()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setIceGatherPolicy ( fm.liveswitch.IceGatherPolicy value )

abstract

Sets the ICE gather policy.

◆ setIceServer()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setIceServer ( fm.liveswitch.IceServer value )

abstract

Sets the ICE server.

◆ setIceServers()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setIceServers ( fm.liveswitch.IceServer[] value )

abstract

Sets the ICE servers.

◆ setLegacyTimeout()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setLegacyTimeout ( boolean value )

abstract

Sets a value indicating whether legacy Connection.Timeout should be used.

When disabled, Connection.Timeout only accounts for the time spent trying to establish connectivity (i.e. time it takes to transition from the Connecting to the Connected state; from the time point when both offer and answer had been set to the connection being fully established). When enabled, Connection.Timeout accounts for the time spent from receiving an offer (or creating an offer) to establishing connectivity (i.e. time it takes to transition from Initializing to Connected state). By default, LegacyTimeout is set to true, so that existing behavior is preserved. However, in the future default will be updated to false. This means that IL will not account for any signalling delays that may occur while establishing connectivity. This option will be later deprecated.

◆ setLocalDescription()

abstract fm.liveswitch.Future<fm.liveswitch.SessionDescription> fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setLocalDescription ( fm.liveswitch.SessionDescription localDescription )

abstract

Sets the local description.

◆ setRemoteDescription()

abstract fm.liveswitch.Future<fm.liveswitch.SessionDescription> fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setRemoteDescription ( fm.liveswitch.SessionDescription remoteDescription )

abstract

Sets the remote description.

◆ setTieBreaker()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setTieBreaker ( String value )

abstract

Sets the tie breaker.

◆ setTimeout()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setTimeout ( int value )

abstract

Sets the amount of time (in milliseconds) to wait for a connection to establish before giving up and closing it.

Defaults to 30,000.

◆ setTrickleIcePolicy()

abstract void fm.liveswitch.IConnection< TConnection, TStream, TAudioStream, TVideoStream, TDataStream >.setTrickleIcePolicy ( fm.liveswitch.TrickleIcePolicy value )

abstract

Sets the trickle ICE policy.

Public Member Functions

Detailed Description

Member Function Documentation

◆ addIceServer()

◆ addIceServers()

◆ addOnExternalIdChange()

◆ addOnGatheringStateChange()

◆ addOnIceConnectionStateChange()

◆ addOnLocalCandidate()

◆ addOnLocalDescription()

◆ addOnRemoteCandidate()

◆ addOnRemoteDescription()

◆ addOnSignallingStateChange()

◆ addOnStateChange()

◆ addRemoteCandidate()

◆ close()

◆ createAnswer()

◆ createOffer()

◆ getAudioStream()

◆ getAudioStreams()

◆ getBundlePolicy()

◆ getCanonicalName()

◆ getDataStream()

◆ getDataStreams()

◆ getDeadStreamTimeout()

◆ getError()

◆ getExternalId()

◆ getGatheringState()

◆ getHasAudio()

◆ getHasData()

◆ getHasVideo()

◆ getIceConnectionState()

◆ getIceGatherPolicy()

◆ getIceServer()

◆ getIceServers()

◆ getId()

◆ getLegacyTimeout()

◆ getLocalDescription()

◆ getMediaProtocol()

◆ getRemoteDescription()

◆ getSignallingState()

◆ getState()

◆ getStats()

◆ getStreams()

◆ getTieBreaker()

◆ getTimeout()

◆ getTrickleIcePolicy()

◆ getVideoStream()

◆ getVideoStreams()

◆ removeIceServer()

◆ removeIceServers()

◆ removeOnExternalIdChange()

◆ removeOnGatheringStateChange()

◆ removeOnIceConnectionStateChange()

◆ removeOnLocalCandidate()

◆ removeOnLocalDescription()

◆ removeOnRemoteCandidate()

◆ removeOnRemoteDescription()

◆ removeOnSignallingStateChange()

◆ removeOnStateChange()

◆ setBundlePolicy()

◆ setDeadStreamTimeout()

◆ setError()

◆ setExternalId()

◆ setIceGatherPolicy()

◆ setIceServer()

◆ setIceServers()

◆ setLegacyTimeout()

◆ setLocalDescription()

◆ setRemoteDescription()

◆ setTieBreaker()

◆ setTimeout()

◆ setTrickleIcePolicy()