FMLiveSwitchMediaStreamStats Class Reference

Media stream stats. More...

Instance Methods

(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(FMLiveSwitchStreamDirection) - direction
 Gets the direction. More...
 
(instancetype) - init
 
(int) - maxReceiveBitrate
 Gets the max receive bitrate. More...
 
(int) - maxSendBitrate
 Gets the max send bitrate. More...
 
(double) - mediaQuality
 Gets the stream's estimated media quality as the minimum of the sender media quality and the receiver media quality. More...
 
(double) - networkQuality
 Gets the stream's estimated network quality as the minimum of the senderNetworkQuality and the receiverNetworkQuality. More...
 
(FMLiveSwitchMediaReceiverStats *) - receiver
 Gets the first receiver's stats. More...
 
(double) - receiverMediaQuality
 Gets the receivers' minimum estimated media quality. More...
 
(double) - receiverNetworkQuality
 Gets the receivers' minimum estimated network quality. More...
 
(double) - receiverNetworkScore
 Gets the receivers' estimated network score. More...
 
(NSMutableArray *) - receivers
 Gets the receivers' stats. More...
 
(FMLiveSwitchMediaSenderStats *) - sender
 Gets the first sender's stats. More...
 
(double) - senderMediaQuality
 Gets the senders' minimum estimated media quality. More...
 
(double) - senderNetworkQuality
 Gets the senders' minimum estimated network quality. More...
 
(NSMutableArray *) - senders
 Gets the senders' stats. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(NSString *) - toJson
 Serializes this to JSON. More...
 
- Instance Methods inherited from FMLiveSwitchStreamStats
(bool) - isHost
 Gets whether the transport's active candidate pair has a host candidate. More...
 
(bool) - isReflexive
 Gets whether the transport's active candidate pair has a reflexive candidate. More...
 
(bool) - isRelayed
 Gets whether the transport's active candidate pair has a relayed candidate. More...
 
(FMLiveSwitchTransportStats *) - transport
 Gets the transport's stats. More...
 
(FMLiveSwitchStreamType) - type
 Gets the type. 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

(NSMutableArray *) + fromJsonArrayWithMediaStreamsJson:
 Derializes an array of media stream stats from JSON. More...
 
(FMLiveSwitchMediaStreamStats *) + fromJsonWithMediaStreamJson:
 Derializes media stream stats from JSON. More...
 
(FMLiveSwitchMediaStreamStats *) + mediaStreamStats
 
(NSString *) + toJsonArrayWithMediaStreams:
 Serializes an array of media stream stats to JSON. More...
 
(NSString *) + toJsonWithMediaStream:
 Serializes media stream stats to JSON. More...
 
- Class Methods inherited from FMLiveSwitchStreamStats
(FMLiveSwitchStreamStats *) + streamStats
 
- Class Methods inherited from FMLiveSwitchBaseStats
(FMLiveSwitchBaseStats *) + baseStats
 

Detailed Description

Media stream stats.

Method Documentation

◆ deserializePropertiesWithKey:valueJson:

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchStreamStats.

◆ direction

- (FMLiveSwitchStreamDirection) direction

Gets the direction.

◆ fromJsonArrayWithMediaStreamsJson:

+ (NSMutableArray*) fromJsonArrayWithMediaStreamsJson: (NSString *)  mediaStreamsJson

Derializes an array of media stream stats from JSON.

Parameters
mediaStreamsJsonThe media streams' stats JSON.

◆ fromJsonWithMediaStreamJson:

+ (FMLiveSwitchMediaStreamStats*) fromJsonWithMediaStreamJson: (NSString *)  mediaStreamJson

Derializes media stream stats from JSON.

Parameters
mediaStreamJsonThe media stream's stats JSON.

◆ init

- (instancetype) init

◆ maxReceiveBitrate

- (int) maxReceiveBitrate

Gets the max receive bitrate.

◆ maxSendBitrate

- (int) maxSendBitrate

Gets the max send bitrate.

◆ mediaQuality

- (double) mediaQuality

Gets the stream's estimated media quality as the minimum of the sender media quality and the receiver 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.

◆ mediaStreamStats

+ (FMLiveSwitchMediaStreamStats*) mediaStreamStats

◆ networkQuality

- (double) networkQuality

Gets the stream's estimated network quality as the minimum of the senderNetworkQuality and the receiverNetworkQuality.


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

◆ receiver

Gets the first receiver's stats.

◆ receiverMediaQuality

- (double) receiverMediaQuality

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

◆ receiverNetworkQuality

- (double) receiverNetworkQuality

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

◆ receiverNetworkScore

- (double) receiverNetworkScore

Gets the receivers' estimated network score.


The value ranges from 1.0 to 5.0, where 1.0 is the lowest score and 5.0 is the highest score.

◆ receivers

- (NSMutableArray*) receivers

Gets the receivers' stats.

◆ sender

Gets the first sender's stats.

◆ senderMediaQuality

- (double) senderMediaQuality

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

◆ senderNetworkQuality

- (double) senderNetworkQuality

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

◆ senders

- (NSMutableArray*) senders

Gets the senders' stats.

◆ serializePropertiesWithJsonObject:

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

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchStreamStats.

◆ toJson

- (NSString*) toJson

Serializes this to JSON.

◆ toJsonArrayWithMediaStreams:

+ (NSString*) toJsonArrayWithMediaStreams: (NSMutableArray *)  mediaStreams

Serializes an array of media stream stats to JSON.

Parameters
mediaStreamsThe media streams' stats.

◆ toJsonWithMediaStream:

+ (NSString*) toJsonWithMediaStream: (FMLiveSwitchMediaStreamStats *)  mediaStream

Serializes media stream stats to JSON.

Parameters
mediaStreamThe media stream's stats.