FMLiveSwitchCandidateStats Class Reference

Candidate stats. More...

Instance Methods
(void)	- deserializePropertiesWithKey:valueJson:
	Deserializes the properties. More...
(instancetype)	- init
	Initializes a new instance of the FMLiveSwitchCandidateStats class. More...
(NSString *)	- ipAddress
	Gets the IP address. More...
(bool)	- isEquivalentWithInstance:
	Checks if a candidate is equivalent to this one. More...
(bool)	- isHost
	Gets whether the candidate is host/local. More...
(bool)	- isReflexive
	Gets whether the candidate is reflexive. More...
(bool)	- isRelayed
	Gets whether the candidate is relayed. More...
(int)	- port
	Gets the port. More...
(long long)	- priority
	Gets the priority. More...
(FMLiveSwitchProtocolType)	- protocol
	Gets the protocol. More...
(NSString *)	- relatedIPAddress
	Gets the related IP address. More...
(int)	- relatedPort
	Gets the related port. More...
(FMLiveSwitchProtocolType)	- relayProtocol
	Gets the relay protocol. More...
(void)	- serializePropertiesWithJsonObject:
	Serializes the properties. More...
(NSString *)	- toJson
	Serializes this to JSON. More...
(FMLiveSwitchProtocolType)	- turnProtocol
	Gets the relay protocol. More...
(FMLiveSwitchCandidateType)	- type
	Gets the type. More...
Instance Methods inherited from FMLiveSwitchBaseStats
(NSString *)	- id
	Gets the identifier of the object generating these stats. More...
(NSDate *)	- timestamp
	Gets the timestamp when these stats were generated. More...
Instance Methods inherited from <FMLiveSwitchIEquivalent>
(bool)	- isEquivalentWithInstance:
	Checks if an instance is equivalent to this one. More...

Class Methods
(FMLiveSwitchCandidateStats *)	+ candidateStats
	Initializes a new instance of the FMLiveSwitchCandidateStats class. More...
(NSMutableArray *)	+ fromJsonArrayWithCandidatesJson:
	Derializes an array of candidate stats from JSON. More...
(FMLiveSwitchCandidateStats *)	+ fromJsonWithCandidateJson:
	Derializes candidate stats from JSON. More...
(NSString *)	+ toJsonArrayWithCandidates:
	Serializes an array of candidate stats to JSON. More...
(NSString *)	+ toJsonWithCandidate:
	Serializes candidate stats to JSON. More...
Class Methods inherited from FMLiveSwitchBaseStats
(FMLiveSwitchBaseStats *)	+ baseStats

Detailed Description

Candidate stats.

Method Documentation

candidateStats

+ (FMLiveSwitchCandidateStats*) candidateStats

Initializes a new instance of the FMLiveSwitchCandidateStats class.

deserializePropertiesWithKey:valueJson:

- (void) deserializePropertiesWithKey:		(NSString *)	key
valueJson:		(NSString *)	valueJson

Deserializes the properties.

Parameters

key	The key.
valueJson	The value in JSON format.

Implements FMLiveSwitchBaseStats.

fromJsonArrayWithCandidatesJson:

+ (NSMutableArray*) fromJsonArrayWithCandidatesJson:

(NSString *)

candidatesJson

Derializes an array of candidate stats from JSON.

Parameters

candidatesJson

The candidates' stats JSON.

fromJsonWithCandidateJson:

+ (FMLiveSwitchCandidateStats*) fromJsonWithCandidateJson:

(NSString *)

candidateJson

Derializes candidate stats from JSON.

Parameters

candidateJson

The candidate's stats JSON.

init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchCandidateStats class.

Implements FMLiveSwitchBaseStats.

ipAddress

- (NSString*) ipAddress

Gets the IP address.

isEquivalentWithInstance:

- (bool) isEquivalentWithInstance:

(FMLiveSwitchCandidateStats *)

instance

Checks if a candidate is equivalent to this one.

Parameters

instance

The candidate.

isHost

- (bool) isHost

Gets whether the candidate is host/local.

isReflexive

- (bool) isReflexive

Gets whether the candidate is reflexive.

isRelayed

- (bool) isRelayed

Gets whether the candidate is relayed.

port

- (int) port

Gets the port.

priority

- (long long) priority

Gets the priority.

protocol

- (FMLiveSwitchProtocolType) protocol

Gets the protocol.

relatedIPAddress

- (NSString*) relatedIPAddress

Gets the related IP address.

relatedPort

- (int) relatedPort

Gets the related port.

relayProtocol

- (FMLiveSwitchProtocolType) relayProtocol

Gets the relay protocol.

serializePropertiesWithJsonObject:

- (void) serializePropertiesWithJsonObject:

(NSMutableDictionary< NSString *, NSString * > *)

jsonObject

Serializes the properties.

Parameters

jsonObject

The JSON object.

Implements FMLiveSwitchBaseStats.

toJson

- (NSString*) toJson

Serializes this to JSON.

toJsonArrayWithCandidates:

+ (NSString*) toJsonArrayWithCandidates:

(NSMutableArray *)

candidates

Serializes an array of candidate stats to JSON.

Parameters

candidates

The candidates' stats.

toJsonWithCandidate:

+ (NSString*) toJsonWithCandidate:

(FMLiveSwitchCandidateStats *)

candidate

Serializes candidate stats to JSON.

Parameters

candidate

The candidate's stats.

turnProtocol

- (FMLiveSwitchProtocolType) turnProtocol

Gets the relay protocol.

Deprecated:

Use RelayProtocol instead.

type

- (FMLiveSwitchCandidateType) type

Gets the type.