stats.h

Go to the documentation of this file.

#import <Foundation/Foundation.h>
#import <MillicastSDK/diagnostics.h>
#import <MillicastSDK/exports.h>
 
typedef NS_CLOSED_ENUM(NSInteger, MCStatsType)
{
    MCStatsTypeCodec,
    MCStatsTypeOutboundRTP,
    MCStatsTypeInboundRTP,
    MCStatsTypeRemoteInboundRTP,
    MCStatsTypeRemoteOutboundRTP,
    MCStatsTypeMediaTrack,
    MCStatsTypeAudioTrack,
    MCStatsTypeVideoTrack,
    MCStatsTypeMediaSource,
    MCStatsTypeIceCandidatePair
};
 
typedef NS_CLOSED_ENUM(NSInteger, MCCodecStatsType) {
    MCCodecStatsTypeEncode,
    MCCodecStatsTypeDecode
};
 
MILLICAST_API @interface MCStats : NSObject
 
@property long long         timestamp;
 
@property (nonatomic, strong, nullable) NSString*  sid; // stats id, id is a reserved keywork in objc
 
@property MCStatsType type;
 
@end
 
MILLICAST_API @interface MCCodecsStats : MCStats
 
+ (MCStatsType) get_type;
 
@property unsigned long payload_type;
 
@property (nonatomic, strong, nullable)  NSString * transport_id;
 
@property (nonatomic, strong, nullable)  NSString * mime_type;
 
@property MCCodecStatsType codec_type;
 
@property unsigned long    clock_rate;
 
@property unsigned long    channels;
 
@property (nonatomic, strong, nullable)  NSString * sdp_fmtp_line;
@end
 
MILLICAST_API @interface MCRtpStreamStats :  MCStats
 
@property  unsigned long ssrc;
 
@property (nonatomic, strong, nullable)  NSString * kind;
 
@property (nonatomic, strong, nullable)  NSString * transport_id;
 
@property (nonatomic, strong, nullable)  NSString * codec_id;
@end
 
MILLICAST_API @interface MCReceivedRtpStreamStats : MCRtpStreamStats
 
+ (MCStatsType) get_type;
 
@property unsigned long long packets_received;
 
@property double             jitter;
 
@property long long          packets_lost;
 
@property unsigned long long frames_dropped;
 
@end
 
MILLICAST_API @interface MCInboundRtpStreamStats : MCReceivedRtpStreamStats
 
+ (MCStatsType) get_type;
 
@property (nonatomic, strong, nullable) NSString * remote_id;
 
@property (nonatomic, strong, nullable) NSString * track_identifier;
 
@property (nonatomic, strong, nullable) NSString * mid;
 
@property unsigned long bytes_received;
 
@property unsigned long header_bytes_received;
 
@property double        last_packet_received_timestamp;
 
@property double        jitter_buffer_delay;
 
@property double        jitter_buffer_target_delay;
 
@property double        jitter_buffer_minimum_delay;
 
@property unsigned long jitter_buffer_emitted_count;
 
@property double        estimated_playout_timestamp;
 
@property unsigned long fec_packets_received;
 
@property unsigned long fec_packets_discarded;
 
@property unsigned long total_samples_received;
 
@property unsigned long concealed_samples;
 
@property unsigned long silent_concealed_samples;
 
@property unsigned long concealment_events;
 
@property unsigned long inserted_samples_for_deceleration;
 
@property unsigned long removed_samples_for_acceleration;
 
@property double        audio_level;
 
@property double        total_audio_energy;
 
@property double        total_samples_duration;
 
@property unsigned long frames_received;
 
@property unsigned long frame_width;
 
@property unsigned long frame_height;
 
@property double        frames_per_second;
 
@property unsigned long frames_decoded;
 
@property unsigned long key_frames_decoded;
 
@property double total_decode_time;
 
@property double total_processing_delay;
 
@property double total_assembly_time;
 
@property unsigned long frames_assembled_from_multiple_packets;
 
@property double total_inter_frame_delay;
 
@property double total_squared_inter_frame_delay;
 
@property (nonatomic, strong, nullable) NSString * decoder_implementation;
 
@property unsigned long fir_count;
 
@property unsigned long pli_count;
 
@property unsigned long nack_count;
 
@property unsigned long freeze_count;
 
@property unsigned long pause_count; 
 
@property double total_freezes_duration;
 
@property double total_pauses_duration;
 
@property double min_playout_delay;
 
@property unsigned long retransmitted_packets_received;
 
@property unsigned long retransmitted_bytes_received;
 
@end
 
MILLICAST_API @interface MCSentRtpStreamStats : MCRtpStreamStats
 
+ (MCStatsType) get_type;
 
@property unsigned long      packets_sent;
 
@property unsigned long long bytes_sent;
@end
 
MILLICAST_API @interface MCOutboundRtpStreamStats : MCSentRtpStreamStats
 
+ (MCStatsType) get_type;
 
@property (nonatomic, strong, nullable) NSString * sender_id;
 
@property (nonatomic, strong, nullable) NSString *   remote_id;
 
@property unsigned long long retransmitted_packets_sent;
 
@property unsigned long long header_bytes_sent;
 
@property unsigned long long retransmitted_bytes_sent;
 
@property double        target_bitrate;
 
@property double        total_packet_send_delay;
 
@property unsigned long frames_encoded;
 
@property unsigned long key_frames_encoded;
 
@property unsigned long long total_encoded_bytes_target;
 
@property unsigned long frame_width;
 
@property unsigned long frame_height;
 
@property double        frames_per_second;
 
@property unsigned long frames_sent;
 
@property unsigned long huge_frames_sent;
 
@property (nonatomic, strong, nullable) NSString *   quality_limitation_reason;
 
@property (nonatomic, strong, nullable) NSString *   quality_limitation_durations;
 
@property unsigned long quality_limitation_resolution_changes;
 
@property (nonatomic, strong, nullable) NSString *   encoder_implementation;
 
@property unsigned long fir_count;
 
@property unsigned long pli_count;
 
@property unsigned long nack_count;
 
@property unsigned long long qp_sum;
 
 
@end
 
MILLICAST_API @interface MCRemoteOutboundRtpStreamStats : MCSentRtpStreamStats
 
+ (MCStatsType) get_type;
 
@property (nonatomic, strong, nullable) NSString * media_source_id;
 
@property (nonatomic, strong, nullable) NSString * remote_id;
 
@property (nonatomic, strong, nullable) NSString * local_id;
 
@property long long remote_timestamp;
 
@property unsigned long long reports_sent;
 
@property unsigned long long round_trip_time_measurements;
 
@property double round_trip_time;
 
@property double total_round_trip_time;
 
@end
 
MILLICAST_API @interface MCRemoteInboundRtpStreamStats : MCReceivedRtpStreamStats
 
+ (MCStatsType) get_type;
 
@property (nonatomic, strong, nullable) NSString * local_id;
 
@property double round_trip_time;
 
@property double total_round_trip_time;
 
@property long long round_trip_time_measurements;
 
@property double fraction_lost; // fraction packet loss
@end
 
MILLICAST_API @interface MCMediaSourceStats : MCStats
 
+ (MCStatsType) get_type;
 
@property (nonatomic, strong, nullable) NSString * track_identifier;
 
@property (nonatomic, strong, nullable) NSString * kind;
@end
 
MILLICAST_API @interface MCVideoSourceStats : MCMediaSourceStats
 
+ (MCStatsType) get_type;
 
@property unsigned long width;
 
@property unsigned long height;
 
@property unsigned long frames;
 
@property double        frames_per_second;
@end
 
MILLICAST_API @interface MCAudioSourceStats : MCMediaSourceStats
 
+ (MCStatsType) get_type;
 
@property double audio_level;
 
@property double total_audio_energy;
 
@property double total_samples_duration;
 
@property double echo_return_loss;
 
@property double echo_return_loss_enhancement;
@end
 
MILLICAST_API @interface MCIceCandidatePairStats : MCStats
 
+ (MCStatsType) get_type;
 
@property double total_round_trip_time;
 
@property double current_round_trip_time;
 
@property double available_outgoing_bitrate;
 
@property double available_incoming_bitrate;
 
@end
 
MILLICAST_API @interface MCStatsReport : NSObject
 
- (nullable MCStats*) get:(nonnull NSString*)statsId;
 
- (nullable NSArray<MCStats*>*) getStatsOfType:(MCStatsType)type;
 
- (int) size;
 
- (nonnull MCStreamDetails*) getStreamDetails;
 
@end