FMLiveSwitchConnectionBase Class Reference

Connection base properties/methods. More...

Instance Methods

(void) - addIceServers:
 Adds some ICE servers. More...
 
(void) - addOnExternalIdChange:
 Adds a handler that is raised when external Id of this connection changes. More...
 
(NSString *, NSString *) - addOnExternalIdChangeWithBlock
 Adds a handler that is raised when external Id of this connection changes. More...
 
(void) - addOnExternalIdChangeWithBlock:
 Adds a handler that is raised when external Id of this connection changes. More...
 
(void) - addOnGatheringStateChange:
 Adds a handler that is raised when the gathering state changes. More...
 
(TConnection) - addOnGatheringStateChangeWithBlock
 Adds a handler that is raised when the gathering state changes. More...
 
(void) - addOnGatheringStateChangeWithBlock:
 Adds a handler that is raised when the gathering state changes. More...
 
(void) - addOnIceConnectionStateChange:
 Adds a handler that is raised when the ice connection state changes. More...
 
(TConnection) - addOnIceConnectionStateChangeWithBlock
 Adds a handler that is raised when the ice connection state changes. More...
 
(void) - addOnIceConnectionStateChangeWithBlock:
 Adds a handler that is raised when the ice connection state changes. More...
 
(void) - addOnLocalCandidate:
 Adds a handler that is raised when a local candidate is added. More...
 
(TConnection, FMLiveSwitchCandidate *) - addOnLocalCandidateWithBlock
 Adds a handler that is raised when a local candidate is added. More...
 
(void) - addOnLocalCandidateWithBlock:
 Adds a handler that is raised when a local candidate is added. More...
 
(void) - addOnLocalDescription:
 Adds a handler that is raised when a local description is set. More...
 
(TConnection, FMLiveSwitchSessionDescription *) - addOnLocalDescriptionWithBlock
 Adds a handler that is raised when a local description is set. More...
 
(void) - addOnLocalDescriptionWithBlock:
 Adds a handler that is raised when a local description is set. More...
 
(void) - addOnRemoteCandidate:
 Adds a handler that is raised when a remote description is added. More...
 
(TConnection, FMLiveSwitchCandidate *) - addOnRemoteCandidateWithBlock
 Adds a handler that is raised when a remote description is added. More...
 
(void) - addOnRemoteCandidateWithBlock:
 Adds a handler that is raised when a remote description is added. More...
 
(void) - addOnRemoteDescription:
 Adds a handler that is raised when a remote description is set. More...
 
(TConnection, FMLiveSwitchSessionDescription *) - addOnRemoteDescriptionWithBlock
 Adds a handler that is raised when a remote description is set. More...
 
(void) - addOnRemoteDescriptionWithBlock:
 Adds a handler that is raised when a remote description is set. More...
 
(void) - addOnSignallingStateChange:
 Adds a handler that is raised when the signalling state changes. More...
 
(TConnection) - addOnSignallingStateChangeWithBlock
 Adds a handler that is raised when the signalling state changes. More...
 
(void) - addOnSignallingStateChangeWithBlock:
 Adds a handler that is raised when the signalling state changes. More...
 
(void) - addOnStateChange:
 Adds a handler that is raised when the connection state changes. More...
 
(TConnection) - addOnStateChangeWithBlock
 Adds a handler that is raised when the connection state changes. More...
 
(void) - addOnStateChangeWithBlock:
 Adds a handler that is raised when the connection state changes. More...
 
(FMLiveSwitchFuture< FMLiveSwitchCandidate * > *) - addRemoteCandidate:
 Adds the remote candidate. More...
 
(TAudioStream) - audioStream
 Gets the first audio stream. More...
 
(NSMutableArray *) - audioStreams
 Gets the audio streams. More...
 
(FMLiveSwitchBundlePolicy) - bundlePolicy
 Gets the bundle policy. More...
 
(NSString *) - canonicalName
 Gets the canonical name. More...
 
(bool) - close
 Closes this instance. More...
 
(FMLiveSwitchFuture< id > *) - closed
 Gets a future that resolves if the connection enters the Closed state or rejects if the connection enters the Failed state before that happens. More...
 
(FMLiveSwitchFuture< id > *) - connected
 Gets a future that resolves if the connection enters the Connected state or rejects if the connection enters the Failed state before that happens. More...
 
(FMLiveSwitchFuture< FMLiveSwitchSessionDescription * > *) - createAnswer
 Creates an answer. More...
 
(FMLiveSwitchFuture< FMLiveSwitchSessionDescription * > *) - createOffer
 Creates an offer. More...
 
(TDataStream) - dataStream
 Gets the first data stream. More...
 
(NSMutableArray *) - dataStreams
 Gets the data streams. More...
 
(int) - deadStreamTimeout
 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...
 
(void) - doAddRemoteCandidateWithPromise:remoteCandidate:
 Adds the remote candidate. More...
 
(void) - doCreateAnswerWithPromise:
 Creates an answer. More...
 
(bool) - doCreateOfferWithPromise:
 Creates an offer. More...
 
(FMLiveSwitchError *) - doProcessDescription:isLocalDescription:
 Processes a session description. More...
 
(void) - doSendCachedLocalCandidates
 Dispatches cached local candidates that were gathered while Connection generated session description. More...
 
(void) - doSetLocalDescriptionWithPromise:localDescription:
 Sets the local description. More...
 
(void) - doSetRemoteDescriptionWithPromise:remoteDescription:
 Sets the remote description. More...
 
(FMLiveSwitchError *) - error
 Gets the error. More...
 
(NSString *) - externalId
 Gets the external identifier. More...
 
(FMLiveSwitchFuture< id > *) - failed
 Gets a future that resolves if the connection enters the Failed state or rejects if the connection enters the Closed state before that happens. More...
 
(FMLiveSwitchIceGatheringState) - gatheringState
 Gets the ICE gathering state. More...
 
(FMLiveSwitchFuture< FMLiveSwitchConnectionStats * > *) - getStats
 Gets the current connection stats. More...
 
(bool) - hasAudio
 Gets whether this connection has an audio stream. More...
 
(bool) - hasData
 Gets whether this connection has a data stream. More...
 
(bool) - hasVideo
 Gets whether this connection has a video stream. More...
 
(FMLiveSwitchIceConnectionState) - iceConnectionState
 Gets the ICE connection state. More...
 
(FMLiveSwitchIceGatherPolicy) - iceGatherPolicy
 Gets the ICE gather policy. More...
 
(FMLiveSwitchIceServer *) - iceServer
 Gets the ICE server. More...
 
(NSMutableArray *) - iceServers
 Gets the ICE servers. More...
 
(NSString *) - id
 Gets the identifier. More...
 
(instancetype) - initWithSharedLock:
 Initializes a new instance of the FMLiveSwitchConnectionBase`6 class. More...
 
(TConnection) - instance
 Gets the current instance. More...
 
(bool) - isTerminated
 Gets a value indicating whether the connection is currently closed or failed. More...
 
(bool) - isTerminating
 Gets a value indicating whether the connection is currently closing or failing. More...
 
(bool) - isTerminatingOrTerminated
 Gets a value indicating whether the connection is currently closing, failing, closed, or failed. More...
 
(bool) - legacyTimeout
 Gets a value indicating whether legacy Connection.Timeout should be used. More...
 
(FMLiveSwitchSessionDescription *) - localDescription
 Gets the local description. More...
 
(FMLiveSwitchError *) - processDescription:isLocalDescription:
 Processes a session description. More...
 
(void) - processStateChange
 Processes a state change. More...
 
(void) - raiseGatheringStateChangeWithConnection:
 Raises gathering state change. More...
 
(void) - raiseIceConnectionStateChangeWithConnection:
 Raises ICE connection state change. More...
 
(void) - raiseLocalCandidate:
 Raises a local candidate but only if it has not been already raised. More...
 
(FMLiveSwitchSessionDescription *) - remoteDescription
 Gets the remote description. More...
 
(void) - removeIceServer:
 Removes an ICE server. More...
 
(void) - removeIceServers:
 Removes some ICE servers. More...
 
(void) - removeOnExternalIdChange:
 Removes a handler that is raised when external Id of this connection changes. More...
 
(void) - removeOnGatheringStateChange:
 Removes a handler that is raised when the gathering state changes. More...
 
(void) - removeOnIceConnectionStateChange:
 Removes a handler that is raised when the ice connection state changes. More...
 
(void) - removeOnLocalCandidate:
 Removes a handler that is raised when a local candidate is added. More...
 
(void) - removeOnLocalDescription:
 Removes a handler that is raised when a local description is set. More...
 
(void) - removeOnRemoteCandidate:
 Removes a handler that is raised when a remote description is added. More...
 
(void) - removeOnRemoteDescription:
 Removes a handler that is raised when a remote description is set. More...
 
(void) - removeOnSignallingStateChange:
 Removes a handler that is raised when the signalling state changes. More...
 
(void) - removeOnStateChange:
 Removes a handler that is raised when the connection state changes. More...
 
(void) - setBundlePolicy:
 Sets the bundle policy. More...
 
(void) - setDeadStreamTimeout:
 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...
 
(void) - setError:
 Sets the error. More...
 
(void) - setExternalId:
 Sets the external identifier. More...
 
(void) - setGatheringState:
 Sets the ICE gathering state. More...
 
(void) - setIceConnectionState:
 Sets the ICE connection state. More...
 
(void) - setIceGatherPolicy:
 Sets the ICE gather policy. More...
 
(void) - setIceServer:
 Sets the ICE server. More...
 
(void) - setIceServers:
 Sets the ICE servers. More...
 
(void) - setLegacyTimeout:
 Sets a value indicating whether legacy Connection.Timeout should be used. More...
 
(FMLiveSwitchFuture< FMLiveSwitchSessionDescription * > *) - setLocalDescription:
 Sets the local description. More...
 
(FMLiveSwitchFuture< FMLiveSwitchSessionDescription * > *) - setRemoteDescription:
 Sets the remote description. More...
 
(void) - setSignallingState:
 Sets the state of the signalling. More...
 
(void) - setTieBreaker:
 Sets the tie breaker. More...
 
(void) - setTimeout:
 Sets the amount of time (in milliseconds) to wait for a connection to establish before giving up and closing it. More...
 
(void) - setTrickleIcePolicy:
 Sets Trickle Ice Support Policy. More...
 
(FMLiveSwitchSignallingState) - signallingState
 Gets the state of the signalling. More...
 
(FMLiveSwitchConnectionState) - state
 Gets the state of the connection. More...
 
(TStream) - stream
 Gets the first stream. More...
 
(NSMutableArray *) - streams
 Gets the streams. More...
 
(NSString *) - tieBreaker
 Gets the tie breaker. More...
 
(int) - timeout
 Gets the amount of time (in milliseconds) to wait for a connection to establish before giving up and closing it. More...
 
(FMLiveSwitchTrickleIcePolicy) - trickleIcePolicy
 Gets Trickle Ice Support Policy. More...
 
(TVideoStream) - videoStream
 Gets the first video stream. More...
 
(NSMutableArray *) - videoStreams
 Gets the video streams. More...
 

Class Methods

(FMLiveSwitchConnectionBase *) + connectionBaseWithSharedLock:
 Initializes a new instance of the FMLiveSwitchConnectionBase`6 class. More...
 

Protected Attributes

 __pad0__: FMLiveSwitchDynamic<FMLiveSwitchIConnection>- (void) addIceServer:(FMLiveSwitchIceServer*)iceServer
 

Detailed Description

Connection base properties/methods.

Method Documentation

◆ addIceServers:

- (void) addIceServers: (NSMutableArray *)  iceServers

Adds some ICE servers.

Parameters
iceServersThe ICE servers.

◆ addOnExternalIdChange:

- (void) addOnExternalIdChange: (FMLiveSwitchAction2< NSString *, NSString * > *)  value

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

Old external Id as well as internal Id are raised.

◆ addOnExternalIdChangeWithBlock

- (NSString*, NSString*) addOnExternalIdChangeWithBlock

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

Old external Id as well as internal Id are raised.

◆ addOnExternalIdChangeWithBlock:

- (void) addOnExternalIdChangeWithBlock: (void(^)(NSString *, NSString *))  valueBlock

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

Old external Id as well as internal Id are raised.

◆ addOnGatheringStateChange:

- (void) addOnGatheringStateChange: (FMLiveSwitchAction1< TConnection > *)  value

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

◆ addOnGatheringStateChangeWithBlock

- (TConnection) addOnGatheringStateChangeWithBlock

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

◆ addOnGatheringStateChangeWithBlock:

- (void) addOnGatheringStateChangeWithBlock: (void(^)(TConnection))  valueBlock

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

◆ addOnIceConnectionStateChange:

- (void) addOnIceConnectionStateChange: (FMLiveSwitchAction1< TConnection > *)  value

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

◆ addOnIceConnectionStateChangeWithBlock

- (TConnection) addOnIceConnectionStateChangeWithBlock

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

◆ addOnIceConnectionStateChangeWithBlock:

- (void) addOnIceConnectionStateChangeWithBlock: (void(^)(TConnection))  valueBlock

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

◆ addOnLocalCandidate:

- (void) addOnLocalCandidate: (FMLiveSwitchAction2< TConnection, FMLiveSwitchCandidate * > *)  value

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

◆ addOnLocalCandidateWithBlock

- (TConnection, FMLiveSwitchCandidate*) addOnLocalCandidateWithBlock

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

◆ addOnLocalCandidateWithBlock:

- (void) addOnLocalCandidateWithBlock: (void(^)(TConnection, FMLiveSwitchCandidate *))  valueBlock

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

◆ addOnLocalDescription:

- (void) addOnLocalDescription: (FMLiveSwitchAction2< TConnection, FMLiveSwitchSessionDescription * > *)  value

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

◆ addOnLocalDescriptionWithBlock

- (TConnection, FMLiveSwitchSessionDescription*) addOnLocalDescriptionWithBlock

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

◆ addOnLocalDescriptionWithBlock:

- (void) addOnLocalDescriptionWithBlock: (void(^)(TConnection, FMLiveSwitchSessionDescription *))  valueBlock

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

◆ addOnRemoteCandidate:

- (void) addOnRemoteCandidate: (FMLiveSwitchAction2< TConnection, FMLiveSwitchCandidate * > *)  value

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

◆ addOnRemoteCandidateWithBlock

- (TConnection, FMLiveSwitchCandidate*) addOnRemoteCandidateWithBlock

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

◆ addOnRemoteCandidateWithBlock:

- (void) addOnRemoteCandidateWithBlock: (void(^)(TConnection, FMLiveSwitchCandidate *))  valueBlock

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

◆ addOnRemoteDescription:

- (void) addOnRemoteDescription: (FMLiveSwitchAction2< TConnection, FMLiveSwitchSessionDescription * > *)  value

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

◆ addOnRemoteDescriptionWithBlock

- (TConnection, FMLiveSwitchSessionDescription*) addOnRemoteDescriptionWithBlock

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

◆ addOnRemoteDescriptionWithBlock:

- (void) addOnRemoteDescriptionWithBlock: (void(^)(TConnection, FMLiveSwitchSessionDescription *))  valueBlock

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

◆ addOnSignallingStateChange:

- (void) addOnSignallingStateChange: (FMLiveSwitchAction1< TConnection > *)  value

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

◆ addOnSignallingStateChangeWithBlock

- (TConnection) addOnSignallingStateChangeWithBlock

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

◆ addOnSignallingStateChangeWithBlock:

- (void) addOnSignallingStateChangeWithBlock: (void(^)(TConnection))  valueBlock

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

◆ addOnStateChange:

- (void) addOnStateChange: (FMLiveSwitchAction1< TConnection > *)  value

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

◆ addOnStateChangeWithBlock

- (TConnection) addOnStateChangeWithBlock

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

◆ addOnStateChangeWithBlock:

- (void) addOnStateChangeWithBlock: (void(^)(TConnection))  valueBlock

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

◆ addRemoteCandidate:

- (FMLiveSwitchFuture<FMLiveSwitchCandidate*>*) addRemoteCandidate: (FMLiveSwitchCandidate *)  remoteCandidate

Adds the remote candidate.

Parameters
remoteCandidateThe remote candidate.

◆ audioStream

- (TAudioStream) audioStream

Gets the first audio stream.

◆ audioStreams

- (NSMutableArray*) audioStreams

Gets the audio streams.

Implemented in FMLiveSwitchConnection.

◆ bundlePolicy

- (FMLiveSwitchBundlePolicy) bundlePolicy

Gets the bundle policy.

◆ canonicalName

- (NSString*) canonicalName

Gets the canonical name.

Deprecated:
Use MediaStream.LocalCanonicalName instead.

◆ close

- (bool) close

Closes this instance.

Implemented in FMLiveSwitchConnection.

◆ closed

- (FMLiveSwitchFuture<id>*) closed

Gets a future that resolves if the connection enters the Closed state or rejects if the connection enters the Failed state before that happens.

◆ connected

- (FMLiveSwitchFuture<id>*) connected

Gets a future that resolves if the connection enters the Connected state or rejects if the connection enters the Failed state before that happens.

◆ connectionBaseWithSharedLock:

+ (FMLiveSwitchConnectionBase*) connectionBaseWithSharedLock: (id sharedLock

Initializes a new instance of the FMLiveSwitchConnectionBase`6 class.

◆ createAnswer

Creates an answer.

◆ createOffer

Creates an offer.

◆ dataStream

- (TDataStream) dataStream

Gets the first data stream.

◆ dataStreams

- (NSMutableArray*) dataStreams

Gets the data streams.

Implemented in FMLiveSwitchConnection.

◆ deadStreamTimeout

- (int) deadStreamTimeout

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 15,000.

◆ doAddRemoteCandidateWithPromise:remoteCandidate:

- (void) doAddRemoteCandidateWithPromise: (FMLiveSwitchPromise< FMLiveSwitchCandidate * > *)  promise
remoteCandidate: (FMLiveSwitchCandidate *)  remoteCandidate 

Adds the remote candidate.

Parameters
promiseThe promise.
remoteCandidateThe remote candidate.

Implemented in FMLiveSwitchConnection.

◆ doCreateAnswerWithPromise:

- (void) doCreateAnswerWithPromise: (FMLiveSwitchPromise< FMLiveSwitchSessionDescription * > *)  promise

Creates an answer.

Implemented in FMLiveSwitchConnection.

◆ doCreateOfferWithPromise:

- (bool) doCreateOfferWithPromise: (FMLiveSwitchPromise< FMLiveSwitchSessionDescription * > *)  promise

Creates an offer.

Implemented in FMLiveSwitchConnection.

◆ doProcessDescription:isLocalDescription:

- (FMLiveSwitchError*) doProcessDescription: (FMLiveSwitchSessionDescription *)  description
isLocalDescription: (bool)  isLocalDescription 

Processes a session description.

Parameters
descriptionThe session description.
isLocalDescriptionWhether this is a local session description.

Implemented in FMLiveSwitchConnection.

◆ doSendCachedLocalCandidates

- (void) doSendCachedLocalCandidates

Dispatches cached local candidates that were gathered while Connection generated session description.

Implemented in FMLiveSwitchConnection.

◆ doSetLocalDescriptionWithPromise:localDescription:

- (void) doSetLocalDescriptionWithPromise: (FMLiveSwitchPromise< FMLiveSwitchSessionDescription * > *)  promise
localDescription: (FMLiveSwitchSessionDescription *)  localDescription 

Sets the local description.

Parameters
promiseThe promise.
localDescriptionThe local description.

Implemented in FMLiveSwitchConnection.

◆ doSetRemoteDescriptionWithPromise:remoteDescription:

- (void) doSetRemoteDescriptionWithPromise: (FMLiveSwitchPromise< FMLiveSwitchSessionDescription * > *)  promise
remoteDescription: (FMLiveSwitchSessionDescription *)  remoteDescription 

Sets the remote description.

Parameters
promiseThe promise.
remoteDescriptionThe remote description.

Implemented in FMLiveSwitchConnection.

◆ error

- (FMLiveSwitchError*) error

Gets the error.

◆ externalId

- (NSString*) externalId

Gets the external identifier.

◆ failed

- (FMLiveSwitchFuture<id>*) failed

Gets a future that resolves if the connection enters the Failed state or rejects if the connection enters the Closed state before that happens.

◆ gatheringState

- (FMLiveSwitchIceGatheringState) gatheringState

Gets the ICE gathering state.

Implemented in FMLiveSwitchConnection.

◆ getStats

Gets the current connection stats.

Implemented in FMLiveSwitchConnection.

◆ hasAudio

- (bool) hasAudio

Gets whether this connection has an audio stream.

◆ hasData

- (bool) hasData

Gets whether this connection has a data stream.

◆ hasVideo

- (bool) hasVideo

Gets whether this connection has a video stream.

◆ iceConnectionState

- (FMLiveSwitchIceConnectionState) iceConnectionState

Gets the ICE connection state.

Implemented in FMLiveSwitchConnection.

◆ iceGatherPolicy

- (FMLiveSwitchIceGatherPolicy) iceGatherPolicy

Gets the ICE gather policy.

◆ iceServer

- (FMLiveSwitchIceServer*) iceServer

Gets the ICE server.

◆ iceServers

- (NSMutableArray*) iceServers

Gets the ICE servers.

◆ id

- (NSString*) id

Gets the identifier.

◆ initWithSharedLock:

- (instancetype) initWithSharedLock: (id sharedLock

Initializes a new instance of the FMLiveSwitchConnectionBase`6 class.

◆ instance

- (TConnection) instance

Gets the current instance.

Implemented in FMLiveSwitchConnection.

◆ isTerminated

- (bool) isTerminated

Gets a value indicating whether the connection is currently closed or failed.

◆ isTerminating

- (bool) isTerminating

Gets a value indicating whether the connection is currently closing or failing.

◆ isTerminatingOrTerminated

- (bool) isTerminatingOrTerminated

Gets a value indicating whether the connection is currently closing, failing, closed, or failed.

◆ legacyTimeout

- (bool) legacyTimeout

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.

◆ localDescription

- (FMLiveSwitchSessionDescription*) localDescription

Gets the local description.

Implemented in FMLiveSwitchConnection.

◆ processDescription:isLocalDescription:

- (FMLiveSwitchError*) processDescription: (FMLiveSwitchSessionDescription *)  description
isLocalDescription: (bool)  isLocalDescription 

Processes a session description.

Parameters
descriptionThe session description.
isLocalDescriptionWhether this is a local session description.

◆ processStateChange

- (void) processStateChange

Processes a state change.

Implemented in FMLiveSwitchConnection.

◆ raiseGatheringStateChangeWithConnection:

- (void) raiseGatheringStateChangeWithConnection: (TConnection)  connection

Raises gathering state change.

◆ raiseIceConnectionStateChangeWithConnection:

- (void) raiseIceConnectionStateChangeWithConnection: (TConnection)  connection

Raises ICE connection state change.

◆ raiseLocalCandidate:

- (void) raiseLocalCandidate: (FMLiveSwitchCandidate *)  localCandidate

Raises a local candidate but only if it has not been already raised.

Parameters
localCandidateThe local candidate.

Implemented in FMLiveSwitchConnection.

◆ remoteDescription

- (FMLiveSwitchSessionDescription*) remoteDescription

Gets the remote description.

Implemented in FMLiveSwitchConnection.

◆ removeIceServer:

- (void) removeIceServer: (FMLiveSwitchIceServer *)  iceServer

Removes an ICE server.

Parameters
iceServerThe ICE server.

◆ removeIceServers:

- (void) removeIceServers: (NSMutableArray *)  iceServers

Removes some ICE servers.

Parameters
iceServersThe ICE servers.

◆ removeOnExternalIdChange:

- (void) removeOnExternalIdChange: (FMLiveSwitchAction2< NSString *, NSString * > *)  value

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

Old external Id as well as internal Id are raised.

◆ removeOnGatheringStateChange:

- (void) removeOnGatheringStateChange: (FMLiveSwitchAction1< TConnection > *)  value

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

◆ removeOnIceConnectionStateChange:

- (void) removeOnIceConnectionStateChange: (FMLiveSwitchAction1< TConnection > *)  value

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

◆ removeOnLocalCandidate:

- (void) removeOnLocalCandidate: (FMLiveSwitchAction2< TConnection, FMLiveSwitchCandidate * > *)  value

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

◆ removeOnLocalDescription:

- (void) removeOnLocalDescription: (FMLiveSwitchAction2< TConnection, FMLiveSwitchSessionDescription * > *)  value

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

◆ removeOnRemoteCandidate:

- (void) removeOnRemoteCandidate: (FMLiveSwitchAction2< TConnection, FMLiveSwitchCandidate * > *)  value

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

◆ removeOnRemoteDescription:

- (void) removeOnRemoteDescription: (FMLiveSwitchAction2< TConnection, FMLiveSwitchSessionDescription * > *)  value

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

◆ removeOnSignallingStateChange:

- (void) removeOnSignallingStateChange: (FMLiveSwitchAction1< TConnection > *)  value

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

◆ removeOnStateChange:

- (void) removeOnStateChange: (FMLiveSwitchAction1< TConnection > *)  value

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

◆ setBundlePolicy:

- (void) setBundlePolicy: (FMLiveSwitchBundlePolicy)  value

Sets the bundle policy.

◆ setDeadStreamTimeout:

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

Defaults to 15,000.

◆ setError:

- (void) setError: (FMLiveSwitchError *)  value

Sets the error.

◆ setExternalId:

- (void) setExternalId: (NSString *)  value

Sets the external identifier.

◆ setGatheringState:

- (void) setGatheringState: (FMLiveSwitchIceGatheringState)  value

Sets the ICE gathering state.

Implemented in FMLiveSwitchConnection.

◆ setIceConnectionState:

- (void) setIceConnectionState: (FMLiveSwitchIceConnectionState)  value

Sets the ICE connection state.

Implemented in FMLiveSwitchConnection.

◆ setIceGatherPolicy:

- (void) setIceGatherPolicy: (FMLiveSwitchIceGatherPolicy)  value

Sets the ICE gather policy.

◆ setIceServer:

- (void) setIceServer: (FMLiveSwitchIceServer *)  value

Sets the ICE server.

◆ setIceServers:

- (void) setIceServers: (NSMutableArray *)  value

Sets the ICE servers.

◆ setLegacyTimeout:

- (void) setLegacyTimeout: (bool)  value

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:

- (FMLiveSwitchFuture<FMLiveSwitchSessionDescription*>*) setLocalDescription: (FMLiveSwitchSessionDescription *)  localDescription

Sets the local description.

Parameters
localDescriptionThe local description.

◆ setRemoteDescription:

- (FMLiveSwitchFuture<FMLiveSwitchSessionDescription*>*) setRemoteDescription: (FMLiveSwitchSessionDescription *)  remoteDescription

Sets the remote description.

Parameters
remoteDescriptionThe remote description.

◆ setSignallingState:

- (void) setSignallingState: (FMLiveSwitchSignallingState)  value

Sets the state of the signalling.

◆ setTieBreaker:

- (void) setTieBreaker: (NSString *)  value

Sets the tie breaker.

◆ setTimeout:

- (void) setTimeout: (int)  value

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:

- (void) setTrickleIcePolicy: (FMLiveSwitchTrickleIcePolicy)  value

Sets Trickle Ice Support Policy.

Cf. https://tools.ietf.org/html/draft-ietf-ice-trickle-05

◆ signallingState

- (FMLiveSwitchSignallingState) signallingState

Gets the state of the signalling.

◆ state

- (FMLiveSwitchConnectionState) state

Gets the state of the connection.

◆ stream

- (TStream) stream

Gets the first stream.

◆ streams

- (NSMutableArray*) streams

Gets the streams.

Implemented in FMLiveSwitchConnection.

◆ tieBreaker

- (NSString*) tieBreaker

Gets the tie breaker.

◆ timeout

- (int) timeout

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

Defaults to 30,000.

◆ trickleIcePolicy

- (FMLiveSwitchTrickleIcePolicy) trickleIcePolicy

Gets Trickle Ice Support Policy.

Cf. https://tools.ietf.org/html/draft-ietf-ice-trickle-05

◆ videoStream

- (TVideoStream) videoStream

Gets the first video stream.

◆ videoStreams

- (NSMutableArray*) videoStreams

Gets the video streams.

Implemented in FMLiveSwitchConnection.

Member Data Documentation

◆ __pad0__

- __pad0__
protected