FMIceLinkIConnection Protocol Reference

Declared in FMIceLinkIConnection.h

Overview

Connection interface.

– addIceServer: required method

Adds an ICE server.
- (void)addIceServer:(FMIceLinkIceServer *)iceServer

Discussion

Adds an ICE server.

Declared In

FMIceLinkIConnection.h

– addIceServers: required method

Adds some ICE servers.
- (void)addIceServers:(NSMutableArray *)iceServers

Discussion

Adds some ICE servers.

Declared In

FMIceLinkIConnection.h

– addOnGatheringStateChange: required method

Adds a handler that is raised when the gathering [state](#//api/name/state) changes.
- (void)addOnGatheringStateChange:(FMIceLinkAction1 *)value

Discussion

Adds a handler that is raised when the gathering [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– addOnGatheringStateChangeWithBlock required method

Adds a handler that is raised when the gathering [state](#//api/name/state) changes.
- (void ( ^ ) ( void ( ^ ) ( id ) ))addOnGatheringStateChangeWithBlock

Discussion

Adds a handler that is raised when the gathering [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– addOnGatheringStateChangeWithBlock: required method

Adds a handler that is raised when the gathering [state](#//api/name/state) changes.
- (void)addOnGatheringStateChangeWithBlock:(void ( ^ ) ( id ))valueBlock

Discussion

Adds a handler that is raised when the gathering [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– addOnIceConnectionStateChange: required method

Adds a handler that is raised when the Ice connection [state](#//api/name/state) changes.
- (void)addOnIceConnectionStateChange:(FMIceLinkAction1 *)value

Discussion

Adds a handler that is raised when the Ice connection [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– addOnIceConnectionStateChangeWithBlock required method

Adds a handler that is raised when the Ice connection [state](#//api/name/state) changes.
- (void ( ^ ) ( void ( ^ ) ( id ) ))addOnIceConnectionStateChangeWithBlock

Discussion

Adds a handler that is raised when the Ice connection [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– addOnIceConnectionStateChangeWithBlock: required method

Adds a handler that is raised when the Ice connection [state](#//api/name/state) changes.
- (void)addOnIceConnectionStateChangeWithBlock:(void ( ^ ) ( id ))valueBlock

Discussion

Adds a handler that is raised when the Ice connection [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– addOnLocalCandidate: required method

Adds a handler that is raised when a local candidate is added.
- (void)addOnLocalCandidate:(FMIceLinkAction2 *)value

Discussion

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

Declared In

FMIceLinkIConnection.h

– addOnLocalCandidateWithBlock required method

Adds a handler that is raised when a local candidate is added.
- (void ( ^ ) ( void ( ^ ) ( id , FMIceLinkCandidate *) ))addOnLocalCandidateWithBlock

Discussion

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

Declared In

FMIceLinkIConnection.h

– addOnLocalCandidateWithBlock: required method

Adds a handler that is raised when a local candidate is added.
- (void)addOnLocalCandidateWithBlock:(void ( ^ ) ( id , FMIceLinkCandidate *))valueBlock

Discussion

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

Declared In

FMIceLinkIConnection.h

– addOnLocalDescription: required method

Adds a handler that is raised when a local description is set.
- (void)addOnLocalDescription:(FMIceLinkAction2 *)value

Discussion

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

Declared In

FMIceLinkIConnection.h

– addOnLocalDescriptionWithBlock required method

Adds a handler that is raised when a local description is set.
- (void ( ^ ) ( void ( ^ ) ( id , FMIceLinkSessionDescription *) ))addOnLocalDescriptionWithBlock

Discussion

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

Declared In

FMIceLinkIConnection.h

– addOnLocalDescriptionWithBlock: required method

Adds a handler that is raised when a local description is set.
- (void)addOnLocalDescriptionWithBlock:(void ( ^ ) ( id , FMIceLinkSessionDescription *))valueBlock

Discussion

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

Declared In

FMIceLinkIConnection.h

– addOnRemoteCandidate: required method

Adds a handler that is raised when a remote candidate is added.
- (void)addOnRemoteCandidate:(FMIceLinkAction2 *)value

Discussion

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

Declared In

FMIceLinkIConnection.h

– addOnRemoteCandidateWithBlock required method

Adds a handler that is raised when a remote candidate is added.
- (void ( ^ ) ( void ( ^ ) ( id , FMIceLinkCandidate *) ))addOnRemoteCandidateWithBlock

Discussion

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

Declared In

FMIceLinkIConnection.h

– addOnRemoteCandidateWithBlock: required method

Adds a handler that is raised when a remote candidate is added.
- (void)addOnRemoteCandidateWithBlock:(void ( ^ ) ( id , FMIceLinkCandidate *))valueBlock

Discussion

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

Declared In

FMIceLinkIConnection.h

– addOnRemoteDescription: required method

Adds a handler that is raised when a remote description is set.
- (void)addOnRemoteDescription:(FMIceLinkAction2 *)value

Discussion

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

Declared In

FMIceLinkIConnection.h

– addOnRemoteDescriptionWithBlock required method

Adds a handler that is raised when a remote description is set.
- (void ( ^ ) ( void ( ^ ) ( id , FMIceLinkSessionDescription *) ))addOnRemoteDescriptionWithBlock

Discussion

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

Declared In

FMIceLinkIConnection.h

– addOnRemoteDescriptionWithBlock: required method

Adds a handler that is raised when a remote description is set.
- (void)addOnRemoteDescriptionWithBlock:(void ( ^ ) ( id , FMIceLinkSessionDescription *))valueBlock

Discussion

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

Declared In

FMIceLinkIConnection.h

– addOnSignallingStateChange: required method

Adds a handler that is raised when the signalling [state](#//api/name/state) changes.
- (void)addOnSignallingStateChange:(FMIceLinkAction1 *)value

Discussion

Adds a handler that is raised when the signalling [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– addOnSignallingStateChangeWithBlock required method

Adds a handler that is raised when the signalling [state](#//api/name/state) changes.
- (void ( ^ ) ( void ( ^ ) ( id ) ))addOnSignallingStateChangeWithBlock

Discussion

Adds a handler that is raised when the signalling [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– addOnSignallingStateChangeWithBlock: required method

Adds a handler that is raised when the signalling [state](#//api/name/state) changes.
- (void)addOnSignallingStateChangeWithBlock:(void ( ^ ) ( id ))valueBlock

Discussion

Adds a handler that is raised when the signalling [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– addOnStateChange: required method

Adds a handler that is raised when the connection [state](#//api/name/state) changes.
- (void)addOnStateChange:(FMIceLinkAction1 *)value

Discussion

Adds a handler that is raised when the connection [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– addOnStateChangeWithBlock required method

Adds a handler that is raised when the connection [state](#//api/name/state) changes.
- (void ( ^ ) ( void ( ^ ) ( id ) ))addOnStateChangeWithBlock

Discussion

Adds a handler that is raised when the connection [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– addOnStateChangeWithBlock: required method

Adds a handler that is raised when the connection [state](#//api/name/state) changes.
- (void)addOnStateChangeWithBlock:(void ( ^ ) ( id ))valueBlock

Discussion

Adds a handler that is raised when the connection [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– addRemoteCandidate: required method

Adds the remote candidate.
- (FMIceLinkFuture *)addRemoteCandidate:(FMIceLinkCandidate *)remoteCandidate

Discussion

Adds the remote candidate.

Declared In

FMIceLinkIConnection.h

– audioStream required method

Gets the first audio stream.
- (id)audioStream

Discussion

Gets the first audio stream.

Declared In

FMIceLinkIConnection.h

– audioStreams required method

Gets the audio [streams](#//api/name/streams).
- (NSMutableArray *)audioStreams

Discussion

Gets the audio [streams](#//api/name/streams).

Declared In

FMIceLinkIConnection.h

– close required method

Closes this instance.
- (void)close

Discussion

Closes this instance.

Declared In

FMIceLinkIConnection.h

– createAnswer required method

Creates an answer.
- (FMIceLinkFuture *)createAnswer

Discussion

Creates an answer.

Declared In

FMIceLinkIConnection.h

– createOffer required method

Creates an offer.
- (FMIceLinkFuture *)createOffer

Discussion

Creates an offer.

Declared In

FMIceLinkIConnection.h

– dataStream required method

Gets the first data stream.
- (id)dataStream

Discussion

Gets the first data stream.

Declared In

FMIceLinkIConnection.h

– dataStreams required method

Gets the data [streams](#//api/name/streams).
- (NSMutableArray *)dataStreams

Discussion

Gets the data [streams](#//api/name/streams).

Declared In

FMIceLinkIConnection.h

– deadStreamTimeout required method

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

Discussion

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.

Declared In

FMIceLinkIConnection.h

– error required method

Gets the error.
- (FMIceLinkError *)error

Discussion

Gets the error.

Declared In

FMIceLinkIConnection.h

– gatheringState required method

Gets the ICE gathering [state](#//api/name/state).

@return

- (FMIceLinkIceGatheringState)gatheringState

Discussion

Gets the ICE gathering [state](#//api/name/state).

@return

Declared In

FMIceLinkIConnection.h

– getStats required method

Gets connection stats.
- (FMIceLinkFuture *)getStats

Discussion

Gets connection stats.

Declared In

FMIceLinkIConnection.h

– hasAudio required method

Gets whether this connection has an audio stream.
- (bool)hasAudio

Discussion

Gets whether this connection has an audio stream.

Declared In

FMIceLinkIConnection.h

– hasData required method

Gets whether this connection has a data stream.
- (bool)hasData

Discussion

Gets whether this connection has a data stream.

Declared In

FMIceLinkIConnection.h

– hasVideo required method

Gets whether this connection has a video stream.
- (bool)hasVideo

Discussion

Gets whether this connection has a video stream.

Declared In

FMIceLinkIConnection.h

– iceConnectionState required method

Gets the ICE connection [state](#//api/name/state).

@return

- (FMIceLinkIceConnectionState)iceConnectionState

Discussion

Gets the ICE connection [state](#//api/name/state).

@return

Declared In

FMIceLinkIConnection.h

– iceGatherPolicy required method

Gets the ICE gather policy.
- (FMIceLinkIceGatherPolicy)iceGatherPolicy

Discussion

Gets the ICE gather policy.

Declared In

FMIceLinkIConnection.h

– iceServer required method

Gets the ICE server.
- (FMIceLinkIceServer *)iceServer

Discussion

Gets the ICE server.

Declared In

FMIceLinkIConnection.h

– iceServers required method

Gets the ICE servers.
- (NSMutableArray *)iceServers

Discussion

Gets the ICE servers.

Declared In

FMIceLinkIConnection.h

– id required method

Gets the identifier.
- (NSString *)id

Discussion

Gets the identifier.

Declared In

FMIceLinkIConnection.h

– localDescription required method

Gets the local description.
- (FMIceLinkSessionDescription *)localDescription

Discussion

Gets the local description.

Declared In

FMIceLinkIConnection.h

– remoteDescription required method

Gets the remote description.
- (FMIceLinkSessionDescription *)remoteDescription

Discussion

Gets the remote description.

Declared In

FMIceLinkIConnection.h

– removeIceServer: required method

Removes an ICE server.
- (void)removeIceServer:(FMIceLinkIceServer *)iceServer

Discussion

Removes an ICE server.

Declared In

FMIceLinkIConnection.h

– removeIceServers: required method

Removes some ICE servers.
- (void)removeIceServers:(NSMutableArray *)iceServers

Discussion

Removes some ICE servers.

Declared In

FMIceLinkIConnection.h

– removeOnGatheringStateChange: required method

Removes a handler that is raised when the gathering [state](#//api/name/state) changes.
- (void)removeOnGatheringStateChange:(FMIceLinkAction1 *)value

Discussion

Removes a handler that is raised when the gathering [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– removeOnIceConnectionStateChange: required method

Removes a handler that is raised when the Ice connection [state](#//api/name/state) changes.
- (void)removeOnIceConnectionStateChange:(FMIceLinkAction1 *)value

Discussion

Removes a handler that is raised when the Ice connection [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– removeOnLocalCandidate: required method

Removes a handler that is raised when a local candidate is added.
- (void)removeOnLocalCandidate:(FMIceLinkAction2 *)value

Discussion

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

Declared In

FMIceLinkIConnection.h

– removeOnLocalDescription: required method

Removes a handler that is raised when a local description is set.
- (void)removeOnLocalDescription:(FMIceLinkAction2 *)value

Discussion

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

Declared In

FMIceLinkIConnection.h

– removeOnRemoteCandidate: required method

Removes a handler that is raised when a remote candidate is added.
- (void)removeOnRemoteCandidate:(FMIceLinkAction2 *)value

Discussion

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

Declared In

FMIceLinkIConnection.h

– removeOnRemoteDescription: required method

Removes a handler that is raised when a remote description is set.
- (void)removeOnRemoteDescription:(FMIceLinkAction2 *)value

Discussion

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

Declared In

FMIceLinkIConnection.h

– removeOnSignallingStateChange: required method

Removes a handler that is raised when the signalling [state](#//api/name/state) changes.
- (void)removeOnSignallingStateChange:(FMIceLinkAction1 *)value

Discussion

Removes a handler that is raised when the signalling [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– removeOnStateChange: required method

Removes a handler that is raised when the connection [state](#//api/name/state) changes.
- (void)removeOnStateChange:(FMIceLinkAction1 *)value

Discussion

Removes a handler that is raised when the connection [state](#//api/name/state) changes.

Declared In

FMIceLinkIConnection.h

– setDeadStreamTimeout: required method

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.
- (void)setDeadStreamTimeout:(int)value

Discussion

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.

Declared In

FMIceLinkIConnection.h

– setIceGatherPolicy: required method

Sets the ICE gather policy.
- (void)setIceGatherPolicy:(FMIceLinkIceGatherPolicy)value

Discussion

Sets the ICE gather policy.

Declared In

FMIceLinkIConnection.h

– setIceServer: required method

Sets the ICE server.
- (void)setIceServer:(FMIceLinkIceServer *)value

Discussion

Sets the ICE server.

Declared In

FMIceLinkIConnection.h

– setIceServers: required method

Sets the ICE servers.
- (void)setIceServers:(NSMutableArray *)value

Discussion

Sets the ICE servers.

Declared In

FMIceLinkIConnection.h

– setId: required method

Sets the identifier.
- (void)setId:(NSString *)value

Discussion

Sets the identifier.

Declared In

FMIceLinkIConnection.h

– setLocalDescription: required method

Sets the local description.
- (FMIceLinkFuture *)setLocalDescription:(FMIceLinkSessionDescription *)localDescription

Discussion

Sets the local description.

Declared In

FMIceLinkIConnection.h

– setRemoteDescription: required method

Sets the remote description.
- (FMIceLinkFuture *)setRemoteDescription:(FMIceLinkSessionDescription *)remoteDescription

Discussion

Sets the remote description.

Declared In

FMIceLinkIConnection.h

– setTieBreaker: required method

Sets the tie breaker.
- (void)setTieBreaker:(NSString *)value

Discussion

Sets the tie breaker.

Declared In

FMIceLinkIConnection.h

– setTimeout: required method

Sets the amount of time (in milliseconds) to wait for a connection to establish before giving up and closing it. Defaults to 30,000.
- (void)setTimeout:(int)value

Discussion

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

Declared In

FMIceLinkIConnection.h

– setTrickleIcePolicy: required method

Sets the trickle ICE policy.
- (void)setTrickleIcePolicy:(FMIceLinkTrickleIcePolicy)value

Discussion

Sets the trickle ICE policy.

Declared In

FMIceLinkIConnection.h

– signallingState required method

Gets the current signalling [state](#//api/name/state).
- (FMIceLinkSignallingState)signallingState

Discussion

Gets the current signalling [state](#//api/name/state).

Declared In

FMIceLinkIConnection.h

– state required method

Gets the current state.
- (FMIceLinkConnectionState)state

Discussion

Gets the current state.

Declared In

FMIceLinkIConnection.h

– streams required method

Gets the streams.
- (NSMutableArray *)streams

Discussion

Gets the streams.

Declared In

FMIceLinkIConnection.h

– tieBreaker required method

Gets the tie breaker.
- (NSString *)tieBreaker

Discussion

Gets the tie breaker.

Declared In

FMIceLinkIConnection.h

– timeout required method

Gets the amount of time (in milliseconds) to wait for a connection to establish before giving up and closing it. Defaults to 30,000.
- (int)timeout

Discussion

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

Declared In

FMIceLinkIConnection.h

– trickleIcePolicy required method

Gets the trickle ICE policy.
- (FMIceLinkTrickleIcePolicy)trickleIcePolicy

Discussion

Gets the trickle ICE policy.

Declared In

FMIceLinkIConnection.h

– videoStream required method

Gets the first video stream.
- (id)videoStream

Discussion

Gets the first video stream.

Declared In

FMIceLinkIConnection.h

– videoStreams required method

Gets the video [streams](#//api/name/streams).
- (NSMutableArray *)videoStreams

Discussion

Gets the video [streams](#//api/name/streams).

Declared In

FMIceLinkIConnection.h