FMLiveSwitchMediaSenderStats Class Reference

Media sender stats. More...

Instance Methods

(long long) - bytesSent
 Gets the number of bytes sent. More...
 
(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(instancetype) - init
 
(bool) - isEquivalentWithInstance:
 Checks if a media sender is equivalent to this one. More...
 
(double) - networkQuality
 Gets the sender's estimated network quality. More...
 
(long long) - packetsSent
 Gets the number of packets sent. More...
 
(int) - roundTripTime
 Gets the round trip time in milliseconds. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(FMLiveSwitchMediaSourceStats *) - source
 Gets the source stats. More...
 
(NSString *) - toJson
 Serializes this to JSON. More...
 
- Instance Methods inherited from FMLiveSwitchMediaComponentStats
(FMLiveSwitchCodecStats *) - codec
 Gets the codec stats. More...
 
(long long) - firCount
 Gets the FIR count. More...
 
(double) - getMediaQualityWithAudio:
 Gets the component's estimated media quality. More...
 
(long long) - lrrCount
 Gets the LRR count. More...
 
(long long) - nackCount
 Gets the NACK count. More...
 
(long long) - pliCount
 Gets the PLI count. More...
 
(NSString *) - repairedRtpStreamId
 Gets the repaired RTP stream identifier. More...
 
(NSString *) - rtpStreamId
 Gets the RTP stream identifier. More...
 
(void) - setCodec:
 Sets the codec stats. More...
 
(void) - setFirCount:
 Sets the FIR count. More...
 
(void) - setLrrCount:
 Sets the LRR count. More...
 
(void) - setNackCount:
 Sets the NACK count. More...
 
(void) - setPliCount:
 Sets the PLI count. More...
 
(void) - setRepairedRtpStreamId:
 Sets the repaired RTP stream identifier. More...
 
(void) - setRtpStreamId:
 Sets the RTP stream identifier. More...
 
(void) - setSliCount:
 Sets the SLI count. More...
 
(void) - setSynchronizationSource:
 Sets the synchronization source. More...
 
(void) - setTrack:
 Sets the track's stats. More...
 
(long long) - sliCount
 Gets the SLI count. More...
 
(long long) - synchronizationSource
 Gets the synchronization source. More...
 
(FMLiveSwitchMediaTrackStats *) - track
 Gets the track's stats. 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

(NSMutableArray *) + fromJsonArrayWithMediaSendersJson:
 Derializes a media sender stats array from JSON. More...
 
(FMLiveSwitchMediaSenderStats *) + fromJsonWithMediaSenderJson:
 Derializes media sender stats from JSON. More...
 
(FMLiveSwitchMediaSenderStats *) + mediaSenderStats
 
(NSString *) + toJsonArrayWithMediaSenders:
 Serializes a media sender stats array to JSON. More...
 
(NSString *) + toJsonWithMediaSender:
 Serializes media sender stats to JSON. More...
 
- Class Methods inherited from FMLiveSwitchMediaComponentStats
(FMLiveSwitchMediaComponentStats *) + mediaComponentStats
 
- Class Methods inherited from FMLiveSwitchBaseStats
(FMLiveSwitchBaseStats *) + baseStats
 

Detailed Description

Media sender stats.

Method Documentation

◆ bytesSent

- (long long) bytesSent

Gets the number of bytes sent.

◆ deserializePropertiesWithKey:valueJson:

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchMediaComponentStats.

◆ fromJsonArrayWithMediaSendersJson:

+ (NSMutableArray*) fromJsonArrayWithMediaSendersJson: (NSString *)  mediaSendersJson

Derializes a media sender stats array from JSON.

Parameters
mediaSendersJsonThe media senders' stats JSON.

◆ fromJsonWithMediaSenderJson:

+ (FMLiveSwitchMediaSenderStats*) fromJsonWithMediaSenderJson: (NSString *)  mediaSenderJson

Derializes media sender stats from JSON.

Parameters
mediaSenderJsonThe media sender's stats JSON.

◆ init

- (instancetype) init

◆ isEquivalentWithInstance:

- (bool) isEquivalentWithInstance: (FMLiveSwitchMediaSenderStats *)  instance

Checks if a media sender is equivalent to this one.

Parameters
instanceThe media sender.

◆ mediaSenderStats

+ (FMLiveSwitchMediaSenderStats*) mediaSenderStats

◆ networkQuality

- (double) networkQuality

Gets the sender's estimated network quality.


The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.

◆ packetsSent

- (long long) packetsSent

Gets the number of packets sent.

◆ roundTripTime

- (int) roundTripTime

Gets the round trip time in milliseconds.

◆ serializePropertiesWithJsonObject:

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

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchMediaComponentStats.

◆ source

Gets the source stats.

◆ toJson

- (NSString*) toJson

Serializes this to JSON.

◆ toJsonArrayWithMediaSenders:

+ (NSString*) toJsonArrayWithMediaSenders: (NSMutableArray *)  mediaSenders

Serializes a media sender stats array to JSON.

Parameters
mediaSendersThe media senders' stats.

◆ toJsonWithMediaSender:

+ (NSString*) toJsonWithMediaSender: (FMLiveSwitchMediaSenderStats *)  mediaSender

Serializes media sender stats to JSON.

Parameters
mediaSenderThe media sender's stats.