FMLiveSwitchCandidatePairStats Class Reference

Candidate pair stats. More...

Instance Methods

(long long) - bytesReceived
 Gets the number of bytes received. More...
 
(long long) - bytesSent
 Gets the number of bytes sent. More...
 
(long long) - consentRequestsReceived
 Gets the number of consent requests received. More...
 
(long long) - consentRequestsSent
 Gets the number of consent requests sent. More...
 
(long long) - consentResponsesReceived
 Gets the number of consent responses received. More...
 
(long long) - consentResponsesSent
 Gets the number of consent responses sent. More...
 
(int) - currentRoundTripTime
 Gets the current round trip time in milliseconds. More...
 
(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchCandidatePairStats class. More...
 
(bool) - isEquivalentWithInstance:
 Checks if a candidate pair is equivalent to this one. More...
 
(NSString *) - localCandidateId
 Gets the local candidate identifier. More...
 
(bool) - nominated
 Gets whether the candidate pair is nominated. More...
 
(long long) - priority
 Gets the priority. More...
 
(NSString *) - remoteCandidateId
 Gets the remote candidate identifier. More...
 
(long long) - requestsReceived
 Gets the number of requests received. More...
 
(long long) - requestsSent
 Gets the number of requests sent. More...
 
(long long) - responsesReceived
 Gets the number of responses received. More...
 
(long long) - responsesSent
 Gets the number of responses sent. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(FMLiveSwitchCandidatePairState) - state
 Gets the state. More...
 
(NSString *) - toJson
 Serializes this to JSON. More...
 
(int) - totalRoundTripTime
 Gets the total round trip time in milliseconds. More...
 
(NSString *) - transportId
 Gets the transport identifier. 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

(FMLiveSwitchCandidatePairStats *) + candidatePairStats
 Initializes a new instance of the FMLiveSwitchCandidatePairStats class. More...
 
(NSMutableArray *) + fromJsonArrayWithCandidatePairsJson:
 Derializes an array of candidate pair stats from JSON. More...
 
(FMLiveSwitchCandidatePairStats *) + fromJsonWithCandidatePairJson:
 Derializes candidate pair stats from JSON. More...
 
(NSString *) + toJsonArrayWithCandidatePairs:
 Serializes an array of candidate pair stats to JSON. More...
 
(NSString *) + toJsonWithCandidatePair:
 Serializes candidate pair stats to JSON. More...
 
- Class Methods inherited from FMLiveSwitchBaseStats
(FMLiveSwitchBaseStats *) + baseStats
 

Detailed Description

Candidate pair stats.

Method Documentation

◆ bytesReceived

- (long long) bytesReceived

Gets the number of bytes received.

◆ bytesSent

- (long long) bytesSent

Gets the number of bytes sent.

◆ candidatePairStats

+ (FMLiveSwitchCandidatePairStats*) candidatePairStats

Initializes a new instance of the FMLiveSwitchCandidatePairStats class.

◆ consentRequestsReceived

- (long long) consentRequestsReceived

Gets the number of consent requests received.

◆ consentRequestsSent

- (long long) consentRequestsSent

Gets the number of consent requests sent.

◆ consentResponsesReceived

- (long long) consentResponsesReceived

Gets the number of consent responses received.

◆ consentResponsesSent

- (long long) consentResponsesSent

Gets the number of consent responses sent.

◆ currentRoundTripTime

- (int) currentRoundTripTime

Gets the current round trip time in milliseconds.

◆ deserializePropertiesWithKey:valueJson:

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchBaseStats.

◆ fromJsonArrayWithCandidatePairsJson:

+ (NSMutableArray*) fromJsonArrayWithCandidatePairsJson: (NSString *)  candidatePairsJson

Derializes an array of candidate pair stats from JSON.

Parameters
candidatePairsJsonThe candidate pairs' stats JSON.

◆ fromJsonWithCandidatePairJson:

+ (FMLiveSwitchCandidatePairStats*) fromJsonWithCandidatePairJson: (NSString *)  candidatePairJson

Derializes candidate pair stats from JSON.

Parameters
candidatePairJsonThe candidate pair's stats JSON.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchCandidatePairStats class.

Implements FMLiveSwitchBaseStats.

◆ isEquivalentWithInstance:

- (bool) isEquivalentWithInstance: (FMLiveSwitchCandidatePairStats *)  instance

Checks if a candidate pair is equivalent to this one.

Parameters
instanceThe candidate pair.

◆ localCandidateId

- (NSString*) localCandidateId

Gets the local candidate identifier.

◆ nominated

- (bool) nominated

Gets whether the candidate pair is nominated.

◆ priority

- (long long) priority

Gets the priority.

◆ remoteCandidateId

- (NSString*) remoteCandidateId

Gets the remote candidate identifier.

◆ requestsReceived

- (long long) requestsReceived

Gets the number of requests received.

◆ requestsSent

- (long long) requestsSent

Gets the number of requests sent.

◆ responsesReceived

- (long long) responsesReceived

Gets the number of responses received.

◆ responsesSent

- (long long) responsesSent

Gets the number of responses sent.

◆ serializePropertiesWithJsonObject:

- (void) serializePropertiesWithJsonObject: (NSMutableDictionary< NSString *, NSString * > *)  jsonObject

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchBaseStats.

◆ state

- (FMLiveSwitchCandidatePairState) state

Gets the state.

◆ toJson

- (NSString*) toJson

Serializes this to JSON.

◆ toJsonArrayWithCandidatePairs:

+ (NSString*) toJsonArrayWithCandidatePairs: (NSMutableArray *)  candidatePairs

Serializes an array of candidate pair stats to JSON.

Parameters
candidatePairsThe candidate pairs' stats.

◆ toJsonWithCandidatePair:

+ (NSString*) toJsonWithCandidatePair: (FMLiveSwitchCandidatePairStats *)  candidatePair

Serializes candidate pair stats to JSON.

Parameters
candidatePairThe candidate pair's stats.

◆ totalRoundTripTime

- (int) totalRoundTripTime

Gets the total round trip time in milliseconds.

◆ transportId

- (NSString*) transportId

Gets the transport identifier.