FMLiveSwitchMediaReceiverStats Class Reference

Media receiver stats. More...

Instance Methods

(long long) - bytesReceived
 Gets the number of bytes received. More...
 
(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(double) - getMediaQualityWithAudio:
 Gets the receiver's estimated media quality. More...
 
(instancetype) - init
 
(bool) - isEquivalentWithInstance:
 Checks if a media receiver is equivalent to this one. More...
 
(int) - jitter
 Gets the jitter in milliseconds. More...
 
(double) - networkQuality
 Gets the receiver's estimated network quality. More...
 
(long long) - packetsDiscarded
 Gets the number of packets discarded. More...
 
(long long) - packetsDuplicated
 Gets the number of packets duplicated. More...
 
(long long) - packetsLost
 Gets the number of packets lost. More...
 
(long long) - packetsReceived
 Gets the number of packets received. More...
 
(long long) - packetsRepaired
 Gets the number of packets repaired. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(FMLiveSwitchMediaSinkStats *) - sink
 Gets the sink 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...
 
(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 *) + fromJsonArrayWithMediaReceiversJson:
 Derializes media receiver stats array from JSON. More...
 
(FMLiveSwitchMediaReceiverStats *) + fromJsonWithMediaReceiverJson:
 Derializes media receiver stats from JSON. More...
 
(FMLiveSwitchMediaReceiverStats *) + mediaReceiverStats
 
(NSString *) + toJsonArrayWithMediaReceivers:
 Serializes media receiver stats array to JSON. More...
 
(NSString *) + toJsonWithMediaReceiver:
 Serializes media receiver stats to JSON. More...
 
- Class Methods inherited from FMLiveSwitchMediaComponentStats
(FMLiveSwitchMediaComponentStats *) + mediaComponentStats
 
- Class Methods inherited from FMLiveSwitchBaseStats
(FMLiveSwitchBaseStats *) + baseStats
 

Detailed Description

Media receiver stats.

Method Documentation

◆ bytesReceived

- (long long) bytesReceived

Gets the number of bytes received.

◆ deserializePropertiesWithKey:valueJson:

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchMediaComponentStats.

◆ fromJsonArrayWithMediaReceiversJson:

+ (NSMutableArray*) fromJsonArrayWithMediaReceiversJson: (NSString *)  mediaReceiversJson

Derializes media receiver stats array from JSON.

Parameters
mediaReceiversJsonThe media receivers' stats JSON.

◆ fromJsonWithMediaReceiverJson:

+ (FMLiveSwitchMediaReceiverStats*) fromJsonWithMediaReceiverJson: (NSString *)  mediaReceiverJson

Derializes media receiver stats from JSON.

Parameters
mediaReceiverJsonThe media receiver's stats JSON.

◆ getMediaQualityWithAudio:

- (double) getMediaQualityWithAudio: (bool)  audio

Gets the receiver's estimated media quality.


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

Parameters
audioWhether these are audio stats.

Implements FMLiveSwitchMediaComponentStats.

◆ init

- (instancetype) init

◆ isEquivalentWithInstance:

- (bool) isEquivalentWithInstance: (FMLiveSwitchMediaReceiverStats *)  instance

Checks if a media receiver is equivalent to this one.

Parameters
instanceThe media receiver.

◆ jitter

- (int) jitter

Gets the jitter in milliseconds.

◆ mediaReceiverStats

+ (FMLiveSwitchMediaReceiverStats*) mediaReceiverStats

◆ networkQuality

- (double) networkQuality

Gets the receiver'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.

◆ packetsDiscarded

- (long long) packetsDiscarded

Gets the number of packets discarded.

◆ packetsDuplicated

- (long long) packetsDuplicated

Gets the number of packets duplicated.

◆ packetsLost

- (long long) packetsLost

Gets the number of packets lost.

◆ packetsReceived

- (long long) packetsReceived

Gets the number of packets received.

◆ packetsRepaired

- (long long) packetsRepaired

Gets the number of packets repaired.

◆ serializePropertiesWithJsonObject:

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

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchMediaComponentStats.

◆ sink

Gets the sink stats.

◆ toJson

- (NSString*) toJson

Serializes this to JSON.

◆ toJsonArrayWithMediaReceivers:

+ (NSString*) toJsonArrayWithMediaReceivers: (NSMutableArray *)  mediaReceivers

Serializes media receiver stats array to JSON.

Parameters
mediaReceiversThe media receivers' stats.

◆ toJsonWithMediaReceiver:

+ (NSString*) toJsonWithMediaReceiver: (FMLiveSwitchMediaReceiverStats *)  mediaReceiver

Serializes media receiver stats to JSON.

Parameters
mediaReceiverThe media receiver's stats.