FMIceLinkCandidate Class Reference

Inherits from NSObject
Declared in FMIceLinkCandidate.h
FMIceLinkCandidate.m

Overview

A candidate.

– dispatched

Gets a value indicating whether this candidate has been already been dispatched as a part of a session description.
- (bool)dispatched

Discussion

Gets a value indicating whether this candidate has been already been dispatched as a part of a session description.

Declared In

FMIceLinkCandidate.h

+ fromJsonWithCandidateJson:

Deserializes an instance from JSON.
+ (FMIceLinkCandidate *)fromJsonWithCandidateJson:(NSString *)candidateJson

Parameters

candidateJson

The JSON to deserialize. @return The deserialized candidate.

Discussion

Deserializes an instance from JSON.

Declared In

FMIceLinkCandidate.h

– sdpCandidateAttribute

Gets the SDP candidate attribute.
- (FMIceLinkSdpIceCandidateAttribute *)sdpCandidateAttribute

Discussion

Gets the SDP candidate attribute.

Declared In

FMIceLinkCandidate.h

– sdpMediaIndex

Gets the media index.
- (int)sdpMediaIndex

Discussion

Gets the media index.

Declared In

FMIceLinkCandidate.h

– setDispatched:

Sets a value indicating whether this candidate has been already been [dispatched](#//api/name/dispatched) as a part of a session description.
- (void)setDispatched:(bool)value

Discussion

Sets a value indicating whether this candidate has been already been [dispatched](#//api/name/dispatched) as a part of a session description.

Declared In

FMIceLinkCandidate.h

– setSdpCandidateAttribute:

Sets the SDP candidate attribute.
- (void)setSdpCandidateAttribute:(FMIceLinkSdpIceCandidateAttribute *)value

Discussion

Sets the SDP candidate attribute.

Declared In

FMIceLinkCandidate.h

– setSdpMediaIndex:

Sets the media index.
- (void)setSdpMediaIndex:(int)value

Discussion

Sets the media index.

Declared In

FMIceLinkCandidate.h

– setTurnTransportProtocol:

Sets the protocol used by this candidate when communicating with the TURN (relay) server.
- (void)setTurnTransportProtocol:(FMIceLinkProtocolType)value

Discussion

Sets the protocol used by this candidate when communicating with the TURN (relay) server.

Declared In

FMIceLinkCandidate.h

– toJson

Serializes this instance to JSON.
- (NSString *)toJson

Discussion

Serializes this instance to JSON.

Declared In

FMIceLinkCandidate.h

+ toJsonWithCandidate:

Serializes an instance to JSON.
+ (NSString *)toJsonWithCandidate:(FMIceLinkCandidate *)candidate

Parameters

candidate

The candidate to serialize. @return The serialized JSON.

Discussion

Serializes an instance to JSON.

Declared In

FMIceLinkCandidate.h

– turnTransportProtocol

Gets the protocol used by this candidate when communicating with the TURN (relay) server.
- (FMIceLinkProtocolType)turnTransportProtocol

Discussion

Gets the protocol used by this candidate when communicating with the TURN (relay) server.

Declared In

FMIceLinkCandidate.h