FMLiveSwitchTelemetryMediaStats Class Reference

Represents stats collected from the connection. More...

Instance Methods

(long long) - availableOutgoingBitrate
 Gets the available outgoing bitrate. More...
 
(bool) - detached
 Gets if the media track is detached. More...
 
(NSString *) - direction
 Gets the direction the media is being sent. More...
 
(int) - frameHeight
 Gets the height of the last encoded frame. More...
 
(double) - frameRate
 Gets the number of encoded frames sent in the last second. More...
 
(int) - frameWidth
 Gets the width of the last encoded frame. More...
 
(NSString *) - mediaType
 Gets the type of media. More...
 
(bool) - muted
 Gets if the media track is muted. More...
 
(long long) - nackCount
 Gets the NACK count. More...
 
(int) - packetsLost
 Gets the total packets lost. More...
 
(double) - percentLost
 Gets the percent of packets lost. More...
 
(long long) - pliCount
 Gets the PLI count. More...
 
(FMLiveSwitchQualityLimitationDurations *) - qualityLimitationDurations
 Gets the durations for which quality has been limited for bandwidth, cpu, none, other. More...
 
(NSString *) - qualityLimitationReason
 Gets the the reason for quality limitation. More...
 
(long long) - qualityLimitationResolutionChanges
 Gets the count of resolution changes due to quality limitation. More...
 
(void) - setNackCount:
 Sets the NACK count. More...
 
(void) - setPliCount:
 Sets the PLI count. More...
 
(bool) - stopped
 Gets if the media track is stopped. More...
 
(int) - targetBitrate
 Gets the target bitrate of the encoder. More...
 
(NSDate *) - timestamp
 Gets the timestamp when these stats were generated. More...
 
(NSString *) - toJson
 Serializes this to JSON. More...
 

Class Methods

(FMLiveSwitchTelemetryMediaStats *) + createOutboundAudioStreamStats:
 Create outbound audio stats. More...
 
(FMLiveSwitchTelemetryMediaStats *) + createOutboundVideoStatsWithVideoStreamStats:
 Create outbound video stats. More...
 
(FMLiveSwitchTelemetryMediaStats *) + fromJsonWithMediaStatsJson:
 Derializes media stats from JSON. More...
 
(NSString *) + toJsonWithOutboundVideoStats:
 Serializes outbound video stats to JSON. More...
 

Detailed Description

Represents stats collected from the connection.

Method Documentation

◆ availableOutgoingBitrate

- (long long) availableOutgoingBitrate

Gets the available outgoing bitrate.

◆ createOutboundAudioStreamStats:

+ (FMLiveSwitchTelemetryMediaStats*) createOutboundAudioStreamStats: (FMLiveSwitchMediaStreamStats *)  audioStreamStats

Create outbound audio stats.

Parameters
audioStreamStats

◆ createOutboundVideoStatsWithVideoStreamStats:

+ (FMLiveSwitchTelemetryMediaStats*) createOutboundVideoStatsWithVideoStreamStats: (FMLiveSwitchMediaStreamStats *)  videoStreamStats

Create outbound video stats.

Parameters
videoStreamStats

◆ detached

- (bool) detached

Gets if the media track is detached.

◆ direction

- (NSString*) direction

Gets the direction the media is being sent.

◆ frameHeight

- (int) frameHeight

Gets the height of the last encoded frame.

◆ frameRate

- (double) frameRate

Gets the number of encoded frames sent in the last second.

◆ frameWidth

- (int) frameWidth

Gets the width of the last encoded frame.

◆ fromJsonWithMediaStatsJson:

+ (FMLiveSwitchTelemetryMediaStats*) fromJsonWithMediaStatsJson: (NSString *)  mediaStatsJson

Derializes media stats from JSON.

Parameters
mediaStatsJsonThe media stats JSON.

◆ mediaType

- (NSString*) mediaType

Gets the type of media.

◆ muted

- (bool) muted

Gets if the media track is muted.

◆ nackCount

- (long long) nackCount

Gets the NACK count.

◆ packetsLost

- (int) packetsLost

Gets the total packets lost.

◆ percentLost

- (double) percentLost

Gets the percent of packets lost.

◆ pliCount

- (long long) pliCount

Gets the PLI count.

◆ qualityLimitationDurations

- (FMLiveSwitchQualityLimitationDurations*) qualityLimitationDurations

Gets the durations for which quality has been limited for bandwidth, cpu, none, other.

◆ qualityLimitationReason

- (NSString*) qualityLimitationReason

Gets the the reason for quality limitation.

◆ qualityLimitationResolutionChanges

- (long long) qualityLimitationResolutionChanges

Gets the count of resolution changes due to quality limitation.

◆ setNackCount:

- (void) setNackCount: (long long)  value

Sets the NACK count.

◆ setPliCount:

- (void) setPliCount: (long long)  value

Sets the PLI count.

◆ stopped

- (bool) stopped

Gets if the media track is stopped.

◆ targetBitrate

- (int) targetBitrate

Gets the target bitrate of the encoder.

◆ timestamp

- (NSDate*) timestamp

Gets the timestamp when these stats were generated.

◆ toJson

- (NSString*) toJson

Serializes this to JSON.

◆ toJsonWithOutboundVideoStats:

+ (NSString*) toJsonWithOutboundVideoStats: (FMLiveSwitchTelemetryMediaStats *)  outboundVideoStats

Serializes outbound video stats to JSON.

Parameters
outboundVideoStatsThe outbound video stats.