FMLiveSwitchMediaComponentStats Class Reference

Media component stats. More...

Instance Methods

(FMLiveSwitchCodecStats *) - codec
 Gets the codec stats. More...
 
(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(long long) - firCount
 Gets the FIR count. More...
 
(double) - getMediaQualityWithAudio:
 Gets the component's estimated media quality. More...
 
(instancetype) - init
 
(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) - serializePropertiesWithJsonObject:
 Serializes the properties. 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...
 

Class Methods

(FMLiveSwitchMediaComponentStats *) + mediaComponentStats
 
- Class Methods inherited from FMLiveSwitchBaseStats
(FMLiveSwitchBaseStats *) + baseStats
 

Detailed Description

Media component stats.

Method Documentation

◆ codec

Gets the codec stats.

◆ deserializePropertiesWithKey:valueJson:

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchBaseStats.

Implemented in FMLiveSwitchMediaSenderStats, and FMLiveSwitchMediaReceiverStats.

◆ firCount

- (long long) firCount

Gets the FIR count.

◆ getMediaQualityWithAudio:

- (double) getMediaQualityWithAudio: (bool)  audio

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

Implemented in FMLiveSwitchMediaReceiverStats.

◆ init

- (instancetype) init

◆ lrrCount

- (long long) lrrCount

Gets the LRR count.

◆ mediaComponentStats

+ (FMLiveSwitchMediaComponentStats*) mediaComponentStats

◆ nackCount

- (long long) nackCount

Gets the NACK count.

◆ pliCount

- (long long) pliCount

Gets the PLI count.

◆ repairedRtpStreamId

- (NSString*) repairedRtpStreamId

Gets the repaired RTP stream identifier.

◆ rtpStreamId

- (NSString*) rtpStreamId

Gets the RTP stream identifier.

◆ serializePropertiesWithJsonObject:

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

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchBaseStats.

Implemented in FMLiveSwitchMediaSenderStats, and FMLiveSwitchMediaReceiverStats.

◆ setCodec:

- (void) setCodec: (FMLiveSwitchCodecStats *)  value

Sets the codec stats.

◆ setFirCount:

- (void) setFirCount: (long long)  value

Sets the FIR count.

◆ setLrrCount:

- (void) setLrrCount: (long long)  value

Sets the LRR count.

◆ setNackCount:

- (void) setNackCount: (long long)  value

Sets the NACK count.

◆ setPliCount:

- (void) setPliCount: (long long)  value

Sets the PLI count.

◆ setRepairedRtpStreamId:

- (void) setRepairedRtpStreamId: (NSString *)  value

Sets the repaired RTP stream identifier.

◆ setRtpStreamId:

- (void) setRtpStreamId: (NSString *)  value

Sets the RTP stream identifier.

◆ setSliCount:

- (void) setSliCount: (long long)  value

Sets the SLI count.

◆ setSynchronizationSource:

- (void) setSynchronizationSource: (long long)  value

Sets the synchronization source.

◆ setTrack:

- (void) setTrack: (FMLiveSwitchMediaTrackStats *)  value

Sets the track's stats.

◆ sliCount

- (long long) sliCount

Gets the SLI count.

◆ synchronizationSource

- (long long) synchronizationSource

Gets the synchronization source.

◆ track

Gets the track's stats.