<FMLiveSwitchIConnection> Protocol Reference

Connection interface. More...

Instance Methods

(void) - addIceServer:
 Adds an ICE server. More...
 
(void) - addIceServers:
 Adds some ICE servers. More...
 
(void) - addOnExternalIdChange:
 Adds a handler that is raised when external connection Id changes. More...
 
(NSString *, NSString *) - addOnExternalIdChangeWithBlock
 Adds a handler that is raised when external connection Id changes. More...
 
(void) - addOnExternalIdChangeWithBlock:
 Adds a handler that is raised when external connection Id changes. More...
 
(void) - addOnGatheringStateChange:
 Adds a handler that is raised when the gathering state changes. More...
 
(id- 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...
 
(id- 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...
 
(id, 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...
 
(id, 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 candidate is added. More...
 
(id, FMLiveSwitchCandidate *) - addOnRemoteCandidateWithBlock
 Adds a handler that is raised when a remote candidate is added. More...
 
(void) - addOnRemoteCandidateWithBlock:
 Adds a handler that is raised when a remote candidate is added. More...
 
(void) - addOnRemoteDescription:
 Adds a handler that is raised when a remote description is set. More...
 
(id, 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...
 
(id- 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...
 
(id- 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 *) - addRemoteCandidate:
 Adds the remote candidate. More...
 
(id- audioStream
 Gets the first audio stream. More...
 
(NSMutableArray *) - audioStreams
 Gets the audio streams. More...
 
(FMLiveSwitchBundlePolicy) - bundlePolicy
 Gets the bundle policy for this connection. More...
 
(NSString *) - canonicalName
 Gets the canonical name. More...
 
(bool) - close
 Closes this instance. More...
 
(FMLiveSwitchFuture *) - createAnswer
 Creates an answer. More...
 
(FMLiveSwitchFuture *) - createOffer
 Creates an offer. More...
 
(id- 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...
 
(FMLiveSwitchError *) - error
 Gets the error. More...
 
(NSString *) - externalId
 Gets the external identifier. More...
 
(FMLiveSwitchIceGatheringState) - gatheringState
 Gets the ICE gathering state. More...
 
(FMLiveSwitchFuture *) - getStats
 Gets 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...
 
(bool) - legacyTimeout
 Gets a value indicating whether legacy Connection.Timeout should be used. More...
 
(FMLiveSwitchSessionDescription *) - localDescription
 Gets the local description. 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 connection Id 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 candidate 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 for this connection. 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) - 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 *) - setLocalDescription:
 Sets the local description. More...
 
(FMLiveSwitchFuture *) - setRemoteDescription:
 Sets the remote description. 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 the trickle ICE policy. More...
 
(FMLiveSwitchSignallingState) - signallingState
 Gets the current signalling state. More...
 
(FMLiveSwitchConnectionState) - state
 Gets the current state. 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 the trickle ICE policy. More...
 
(id- videoStream
 Gets the first video stream. More...
 
(NSMutableArray *) - videoStreams
 Gets the video streams. More...
 

Detailed Description

Connection interface.

Method Documentation

◆ addIceServer:

- (void) addIceServer: (FMLiveSwitchIceServer *)  iceServer

Adds an ICE server.

◆ addIceServers:

- (void) addIceServers: (NSMutableArray *)  iceServers

Adds some ICE servers.

◆ addOnExternalIdChange:

- (void) addOnExternalIdChange: (FMLiveSwitchAction2 *)  value

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

◆ addOnExternalIdChangeWithBlock

- (NSString*, NSString*) addOnExternalIdChangeWithBlock

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

◆ addOnExternalIdChangeWithBlock:

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

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

◆ addOnGatheringStateChange:

- (void) addOnGatheringStateChange: (FMLiveSwitchAction1 *)  value

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

◆ addOnGatheringStateChangeWithBlock

- (id) addOnGatheringStateChangeWithBlock

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

◆ addOnGatheringStateChangeWithBlock:

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

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

◆ addOnIceConnectionStateChange:

- (void) addOnIceConnectionStateChange: (FMLiveSwitchAction1 *)  value

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

◆ addOnIceConnectionStateChangeWithBlock

- (id) addOnIceConnectionStateChangeWithBlock

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

◆ addOnIceConnectionStateChangeWithBlock:

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

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

◆ addOnLocalCandidate:

- (void) addOnLocalCandidate: (FMLiveSwitchAction2 *)  value

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

◆ addOnLocalCandidateWithBlock

- (id, FMLiveSwitchCandidate*) addOnLocalCandidateWithBlock

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

◆ addOnLocalCandidateWithBlock:

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

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

◆ addOnLocalDescription:

- (void) addOnLocalDescription: (FMLiveSwitchAction2 *)  value

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

◆ addOnLocalDescriptionWithBlock

- (id, FMLiveSwitchSessionDescription*) addOnLocalDescriptionWithBlock

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

◆ addOnLocalDescriptionWithBlock:

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

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

◆ addOnRemoteCandidate:

- (void) addOnRemoteCandidate: (FMLiveSwitchAction2 *)  value

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

◆ addOnRemoteCandidateWithBlock

- (id, FMLiveSwitchCandidate*) addOnRemoteCandidateWithBlock

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

◆ addOnRemoteCandidateWithBlock:

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

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

◆ addOnRemoteDescription:

- (void) addOnRemoteDescription: (FMLiveSwitchAction2 *)  value

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

◆ addOnRemoteDescriptionWithBlock

- (id, FMLiveSwitchSessionDescription*) addOnRemoteDescriptionWithBlock

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

◆ addOnRemoteDescriptionWithBlock:

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

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

◆ addOnSignallingStateChange:

- (void) addOnSignallingStateChange: (FMLiveSwitchAction1 *)  value

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

◆ addOnSignallingStateChangeWithBlock

- (id) addOnSignallingStateChangeWithBlock

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

◆ addOnSignallingStateChangeWithBlock:

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

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

◆ addOnStateChange:

- (void) addOnStateChange: (FMLiveSwitchAction1 *)  value

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

◆ addOnStateChangeWithBlock

- (id) addOnStateChangeWithBlock

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

◆ addOnStateChangeWithBlock:

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

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

◆ addRemoteCandidate:

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

Adds the remote candidate.

◆ audioStream

- (id) audioStream

Gets the first audio stream.

◆ audioStreams

- (NSMutableArray*) audioStreams

Gets the audio streams.

◆ bundlePolicy

- (FMLiveSwitchBundlePolicy) bundlePolicy

Gets the bundle policy for this connection.

◆ canonicalName

- (NSString*) canonicalName

Gets the canonical name.

◆ close

- (bool) close

Closes this instance.

◆ createAnswer

- (FMLiveSwitchFuture*) createAnswer

Creates an answer.

◆ createOffer

- (FMLiveSwitchFuture*) createOffer

Creates an offer.

◆ dataStream

- (id) dataStream

Gets the first data stream.

◆ dataStreams

- (NSMutableArray*) dataStreams

Gets the data streams.

◆ 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 10,000.

◆ error

- (FMLiveSwitchError*) error

Gets the error.

◆ externalId

- (NSString*) externalId

Gets the external identifier.

◆ gatheringState

- (FMLiveSwitchIceGatheringState) gatheringState

Gets the ICE gathering state.

◆ getStats

- (FMLiveSwitchFuture*) getStats

Gets connection stats.

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

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

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

◆ remoteDescription

- (FMLiveSwitchSessionDescription*) remoteDescription

Gets the remote description.

◆ removeIceServer:

- (void) removeIceServer: (FMLiveSwitchIceServer *)  iceServer

Removes an ICE server.

◆ removeIceServers:

- (void) removeIceServers: (NSMutableArray *)  iceServers

Removes some ICE servers.

◆ removeOnExternalIdChange:

- (void) removeOnExternalIdChange: (FMLiveSwitchAction2 *)  value

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

◆ removeOnGatheringStateChange:

- (void) removeOnGatheringStateChange: (FMLiveSwitchAction1 *)  value

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

◆ removeOnIceConnectionStateChange:

- (void) removeOnIceConnectionStateChange: (FMLiveSwitchAction1 *)  value

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

◆ removeOnLocalCandidate:

- (void) removeOnLocalCandidate: (FMLiveSwitchAction2 *)  value

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

◆ removeOnLocalDescription:

- (void) removeOnLocalDescription: (FMLiveSwitchAction2 *)  value

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

◆ removeOnRemoteCandidate:

- (void) removeOnRemoteCandidate: (FMLiveSwitchAction2 *)  value

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

◆ removeOnRemoteDescription:

- (void) removeOnRemoteDescription: (FMLiveSwitchAction2 *)  value

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

◆ removeOnSignallingStateChange:

- (void) removeOnSignallingStateChange: (FMLiveSwitchAction1 *)  value

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

◆ removeOnStateChange:

- (void) removeOnStateChange: (FMLiveSwitchAction1 *)  value

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

◆ setBundlePolicy:

- (void) setBundlePolicy: (FMLiveSwitchBundlePolicy)  value

Sets the bundle policy for this connection.

◆ 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 10,000.

◆ setError:

- (void) setError: (FMLiveSwitchError *)  value

Sets the error.

◆ setExternalId:

- (void) setExternalId: (NSString *)  value

Sets the external identifier.

◆ 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*) setLocalDescription: (FMLiveSwitchSessionDescription *)  localDescription

Sets the local description.

◆ setRemoteDescription:

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

Sets the remote description.

◆ 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 the trickle ICE policy.

◆ signallingState

- (FMLiveSwitchSignallingState) signallingState

Gets the current signalling state.

◆ state

- (FMLiveSwitchConnectionState) state

Gets the current state.

◆ streams

- (NSMutableArray*) streams

Gets the streams.

◆ 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 the trickle ICE policy.

◆ videoStream

- (id) videoStream

Gets the first video stream.

◆ videoStreams

- (NSMutableArray*) videoStreams

Gets the video streams.