FMLiveSwitchTransportStats Class Reference

Transport stats. More...

Instance Methods

(FMLiveSwitchCandidatePairStats *) - activeCandidatePair
 Gets the active candidate pair's stats. More...
 
(long long) - bytesReceived
 Gets the number of bytes received. More...
 
(long long) - bytesSent
 Gets the number of bytes sent. More...
 
(NSMutableArray *) - candidatePairs
 Gets the candidate pairs' stats. More...
 
(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(FMLiveSwitchCandidatePairStats *) - getCandidatePairWithCandidatePairId:
 Gets a candidate pair by its identifier. More...
 
(FMLiveSwitchCandidateStats *) - getLocalCandidateWithCandidateId:
 Gets a local candidate by its identifier. More...
 
(FMLiveSwitchCandidateStats *) - getRemoteCandidateWithCandidateId:
 Gets a remote candidate by its identifier. More...
 
(instancetype) - init
 
(bool) - isHost
 Gets whether the active candidate pair has a host candidate. More...
 
(bool) - isReflexive
 Gets whether the active candidate pair has a reflexive candidate. More...
 
(bool) - isRelayed
 Gets whether the active candidate pair has a relayed candidate. More...
 
(NSMutableArray *) - localCandidates
 Gets the local candidates' stats. More...
 
(FMLiveSwitchCertificateStats *) - localCertificate
 Gets the local certificate's stats. More...
 
(NSMutableArray *) - remoteCandidates
 Gets the remote candidates' stats. More...
 
(FMLiveSwitchCertificateStats *) - remoteCertificate
 Gets the remote certificate's stats. More...
 
(FMLiveSwitchTransportStats *) - rtcpTransport
 Gets the RTCP transport's stats. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(void) - setActiveCandidatePair:
 Sets the active candidate pair's stats. More...
 
(void) - setBytesReceived:
 Sets the number of bytes received. More...
 
(void) - setBytesSent:
 Sets the number of bytes sent. More...
 
(void) - setCandidatePairs:
 Sets the candidate pairs' stats. More...
 
(void) - setLocalCandidates:
 Sets the local candidates' stats. More...
 
(void) - setLocalCertificate:
 Sets the local certificate's stats. More...
 
(void) - setRemoteCandidates:
 Sets the remote candidates' stats. More...
 
(void) - setRemoteCertificate:
 Sets the remote certificate's stats. More...
 
(void) - setRtcpTransport:
 Sets the RTCP transport's stats. More...
 
(NSString *) - toJson
 Serializes this to JSON. 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...
 

Class Methods

(FMLiveSwitchTransportStats *) + fromJsonWithTransportJson:
 Derializes transport stats from JSON. More...
 
(NSString *) + toJsonWithTransport:
 Serializes transport stats to JSON. More...
 
(FMLiveSwitchTransportStats *) + transportStats
 
- Class Methods inherited from FMLiveSwitchBaseStats
(FMLiveSwitchBaseStats *) + baseStats
 

Detailed Description

Transport stats.

Method Documentation

◆ activeCandidatePair

- (FMLiveSwitchCandidatePairStats*) activeCandidatePair

Gets the active candidate pair's stats.

◆ bytesReceived

- (long long) bytesReceived

Gets the number of bytes received.

◆ bytesSent

- (long long) bytesSent

Gets the number of bytes sent.

◆ candidatePairs

- (NSMutableArray*) candidatePairs

Gets the candidate pairs' stats.

◆ deserializePropertiesWithKey:valueJson:

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchBaseStats.

◆ fromJsonWithTransportJson:

+ (FMLiveSwitchTransportStats*) fromJsonWithTransportJson: (NSString *)  transportJson

Derializes transport stats from JSON.

Parameters
transportJsonThe transport's stats JSON.

◆ getCandidatePairWithCandidatePairId:

- (FMLiveSwitchCandidatePairStats*) getCandidatePairWithCandidatePairId: (NSString *)  candidatePairId

Gets a candidate pair by its identifier.

Parameters
candidatePairIdThe candidate pair identifier.

◆ getLocalCandidateWithCandidateId:

- (FMLiveSwitchCandidateStats*) getLocalCandidateWithCandidateId: (NSString *)  candidateId

Gets a local candidate by its identifier.

Parameters
candidateIdThe candidate identifier.

◆ getRemoteCandidateWithCandidateId:

- (FMLiveSwitchCandidateStats*) getRemoteCandidateWithCandidateId: (NSString *)  candidateId

Gets a remote candidate by its identifier.

Parameters
candidateIdThe candidate identifier.

◆ init

- (instancetype) init

Implements FMLiveSwitchBaseStats.

◆ isHost

- (bool) isHost

Gets whether the active candidate pair has a host candidate.

◆ isReflexive

- (bool) isReflexive

Gets whether the active candidate pair has a reflexive candidate.

◆ isRelayed

- (bool) isRelayed

Gets whether the active candidate pair has a relayed candidate.

◆ localCandidates

- (NSMutableArray*) localCandidates

Gets the local candidates' stats.

◆ localCertificate

- (FMLiveSwitchCertificateStats*) localCertificate

Gets the local certificate's stats.

◆ remoteCandidates

- (NSMutableArray*) remoteCandidates

Gets the remote candidates' stats.

◆ remoteCertificate

- (FMLiveSwitchCertificateStats*) remoteCertificate

Gets the remote certificate's stats.

◆ rtcpTransport

- (FMLiveSwitchTransportStats*) rtcpTransport

Gets the RTCP transport's stats.

◆ serializePropertiesWithJsonObject:

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

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchBaseStats.

◆ setActiveCandidatePair:

- (void) setActiveCandidatePair: (FMLiveSwitchCandidatePairStats *)  value

Sets the active candidate pair's stats.

◆ setBytesReceived:

- (void) setBytesReceived: (long long)  value

Sets the number of bytes received.

◆ setBytesSent:

- (void) setBytesSent: (long long)  value

Sets the number of bytes sent.

◆ setCandidatePairs:

- (void) setCandidatePairs: (NSMutableArray *)  value

Sets the candidate pairs' stats.

◆ setLocalCandidates:

- (void) setLocalCandidates: (NSMutableArray *)  value

Sets the local candidates' stats.

◆ setLocalCertificate:

- (void) setLocalCertificate: (FMLiveSwitchCertificateStats *)  value

Sets the local certificate's stats.

◆ setRemoteCandidates:

- (void) setRemoteCandidates: (NSMutableArray *)  value

Sets the remote candidates' stats.

◆ setRemoteCertificate:

- (void) setRemoteCertificate: (FMLiveSwitchCertificateStats *)  value

Sets the remote certificate's stats.

◆ setRtcpTransport:

- (void) setRtcpTransport: (FMLiveSwitchTransportStats *)  value

Sets the RTCP transport's stats.

◆ toJson

- (NSString*) toJson

Serializes this to JSON.

◆ toJsonWithTransport:

+ (NSString*) toJsonWithTransport: (FMLiveSwitchTransportStats *)  transport

Serializes transport stats to JSON.

Parameters
transportThe transport's stats.

◆ transportStats

+ (FMLiveSwitchTransportStats*) transportStats