FMIceLinkCandidateStats Class Reference

Inherits from FMIceLinkBaseStats : NSObject
Declared in FMIceLinkCandidateStats.h
FMIceLinkCandidateStats.m

Overview

Candidate stats.

– deserializePropertiesWithKey:valueJson:

Deserializes the properties.
- (void)deserializePropertiesWithKey:(NSString *)key valueJson:(NSString *)valueJson

Parameters

key

The key.
valueJson

The value in JSON format.

Discussion

Deserializes the properties.

Declared In

FMIceLinkCandidateStats.h

+ fromJsonArrayWithCandidatesJson:

Derializes an array of candidate stats from JSON.
+ (NSMutableArray *)fromJsonArrayWithCandidatesJson:(NSString *)candidatesJson

Parameters

candidatesJson

The candidates' stats JSON. @return

Discussion

Derializes an array of candidate stats from JSON.

Declared In

FMIceLinkCandidateStats.h

+ fromJsonWithCandidateJson:

Derializes candidate stats from JSON.
+ (FMIceLinkCandidateStats *)fromJsonWithCandidateJson:(NSString *)candidateJson

Parameters

candidateJson

The candidate’s stats JSON. @return

Discussion

Derializes candidate stats from JSON.

Declared In

FMIceLinkCandidateStats.h

– ipAddress

Gets the IP address.
- (NSString *)ipAddress

Discussion

Gets the IP address.

Declared In

FMIceLinkCandidateStats.h

– isHost

Gets whether the candidate is host/local.
- (bool)isHost

Discussion

Gets whether the candidate is host/local.

Declared In

FMIceLinkCandidateStats.h

– isReflexive

Gets whether the candidate is reflexive.
- (bool)isReflexive

Discussion

Gets whether the candidate is reflexive.

Declared In

FMIceLinkCandidateStats.h

– isRelayed

Gets whether the candidate is relayed.
- (bool)isRelayed

Discussion

Gets whether the candidate is relayed.

Declared In

FMIceLinkCandidateStats.h

– port

Gets the port.
- (int)port

Discussion

Gets the port.

Declared In

FMIceLinkCandidateStats.h

– priority

Gets the priority.
- (long long)priority

Discussion

Gets the priority.

Declared In

FMIceLinkCandidateStats.h

– protocol

Gets the protocol.
- (FMIceLinkProtocolType)protocol

Discussion

Gets the protocol.

Declared In

FMIceLinkCandidateStats.h

– relatedIPAddress

Gets the related IP address.
- (NSString *)relatedIPAddress

Discussion

Gets the related IP address.

Declared In

FMIceLinkCandidateStats.h

– relatedPort

Gets the related [port](#//api/name/port).
- (int)relatedPort

Discussion

Gets the related [port](#//api/name/port).

Declared In

FMIceLinkCandidateStats.h

– serializePropertiesWithJsonObject:

Serializes the properties.
- (void)serializePropertiesWithJsonObject:(NSMutableDictionary<NSString*,NSString*> *)jsonObject

Parameters

jsonObject

The JSON object.

Discussion

Serializes the properties.

Declared In

FMIceLinkCandidateStats.h

– toJson

Serializes this to JSON.

@return

- (NSString *)toJson

Discussion

Serializes this to JSON.

@return

Declared In

FMIceLinkCandidateStats.h

+ toJsonArrayWithCandidates:

Serializes an array of candidate stats to JSON.
+ (NSString *)toJsonArrayWithCandidates:(NSMutableArray *)candidates

Parameters

candidates

The candidates' stats. @return

Discussion

Serializes an array of candidate stats to JSON.

Declared In

FMIceLinkCandidateStats.h

+ toJsonWithCandidate:

Serializes candidate stats to JSON.
+ (NSString *)toJsonWithCandidate:(FMIceLinkCandidateStats *)candidate

Parameters

candidate

The candidate’s stats. @return

Discussion

Serializes candidate stats to JSON.

Declared In

FMIceLinkCandidateStats.h

– turnProtocol

Gets the [protocol](#//api/name/protocol) used by this candidate when communicating with a TURN (relay) server. If unknown or not a relayed candidate, defaults to ProtocolType.Unknown.
- (FMIceLinkProtocolType)turnProtocol

Discussion

Gets the [protocol](#//api/name/protocol) used by this candidate when communicating with a TURN (relay) server. If unknown or not a relayed candidate, defaults to ProtocolType.Unknown.

Declared In

FMIceLinkCandidateStats.h

– type

Gets the type.
- (FMIceLinkCandidateType)type

Discussion

Gets the type.

Declared In

FMIceLinkCandidateStats.h