Stats.h

Go to the documentation of this file.

/*
 * Profiler public include file
 */
#ifndef __KINESIS_VIDEO_WEBRTCCLIENT_STATS_INCLUDE__
#define __KINESIS_VIDEO_WEBRTCCLIENT_STATS_INCLUDE__
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#define MAX_CANDIDATE_ID_LENGTH 9U
 
#define MAX_RELAY_PROTOCOL_LENGTH 8U
 
#define MAX_TLS_VERSION_LENGTH 8U
 
#define MAX_DTLS_CIPHER_LENGTH 64U
 
#define MAX_SRTP_CIPHER_LENGTH 64U
 
#define MAX_TLS_GROUP_LENGHTH 32U
 
#define MAX_PROTOCOL_LENGTH 8U
 
#define IP_ADDR_STR_LENGTH 45U
 
#define MAX_STATS_STRING_LENGTH 255U
typedef CHAR DOMString[MAX_STATS_STRING_LENGTH + 1];
 
typedef UINT64 DOMHighResTimeStamp;
 
typedef enum {
    ICE_CANDIDATE_TYPE_HOST = 0,             
    ICE_CANDIDATE_TYPE_PEER_REFLEXIVE = 1,   
    ICE_CANDIDATE_TYPE_SERVER_REFLEXIVE = 2, 
    ICE_CANDIDATE_TYPE_RELAYED = 3,          
} ICE_CANDIDATE_TYPE;
 
typedef enum {
    RTC_STATS_TYPE_CANDIDATE_PAIR, 
    RTC_STATS_TYPE_CERTIFICATE,    
    RTC_STATS_TYPE_CODEC, 
    RTC_STATS_TYPE_ICE_SERVER,          
    RTC_STATS_TYPE_CSRC,                
    RTC_STATS_TYPE_DATA_CHANNEL,        
    RTC_STATS_TYPE_INBOUND_RTP,         
    RTC_STATS_TYPE_LOCAL_CANDIDATE,     
    RTC_STATS_TYPE_OUTBOUND_RTP,        
    RTC_STATS_TYPE_PEER_CONNECTION,     
    RTC_STATS_TYPE_RECEIVER,            
    RTC_STATS_TYPE_REMOTE_CANDIDATE,    
    RTC_STATS_TYPE_REMOTE_INBOUND_RTP,  
    RTC_STATS_TYPE_REMOTE_OUTBOUND_RTP, 
    RTC_STATS_TYPE_SENDER,              
    RTC_STATS_TYPE_TRACK,               
    RTC_STATS_TYPE_TRANSPORT,           
    RTC_STATS_TYPE_SCTP_TRANSPORT,      
    RTC_STATS_TYPE_TRANSCEIVER,         
    RTC_STATS_TYPE_RTC_ALL              
} RTC_STATS_TYPE;
 
typedef enum {
    ICE_CANDIDATE_PAIR_STATE_FROZEN = 0,
    ICE_CANDIDATE_PAIR_STATE_WAITING = 1,
    ICE_CANDIDATE_PAIR_STATE_IN_PROGRESS = 2,
    ICE_CANDIDATE_PAIR_STATE_SUCCEEDED = 3,
    ICE_CANDIDATE_PAIR_STATE_FAILED = 4,
} ICE_CANDIDATE_PAIR_STATE;
 
typedef enum {
    RTC_ICE_ROLE_UNKNOWN,     
    RTC_ICE_ROLE_CONTROLLING, 
    RTC_ICE_ROLE_CONTROLLED   
} RTC_ICE_ROLE;
 
typedef enum {
    RTC_DTLS_TRANSPORT_STATE_STATS_NEW,        
    RTC_DTLS_TRANSPORT_STATE_STATS_CONNECTING, 
    RTC_DTLS_TRANSPORT_STATE_STATS_CONNECTED,  
    RTC_DTLS_TRANSPORT_STATE_STATS_CLOSED,     
    RTC_DTLS_TRANSPORT_STATE_STATS_FAILED      
} RTC_DTLS_TRANSPORT_STATE_STATS;
 
typedef enum {
    RTC_QUALITY_LIMITATION_REASON_NONE,      
    RTC_QUALITY_LIMITATION_REASON_BANDWIDTH, 
    RTC_QUALITY_LIMITATION_REASON_CPU,       
    RTC_QUALITY_LIMITATION_REASON_OTHER,     
} RTC_QUALITY_LIMITATION_REASON;
 
typedef struct {
    UINT64 durationInSeconds;                              
    RTC_QUALITY_LIMITATION_REASON qualityLimitationReason; 
} QualityLimitationDurationsRecord, *PQualityLimitationDurationsRecord;
 
typedef struct {
    DOMString dscp;                  
    UINT64 totalNumberOfPacketsSent; 
} DscpPacketsSentRecord, *PDscpPacketsSentRecord;
 
typedef struct {
    CHAR localCandidateId[MAX_CANDIDATE_ID_LENGTH + 1];  
    CHAR remoteCandidateId[MAX_CANDIDATE_ID_LENGTH + 1]; 
    ICE_CANDIDATE_PAIR_STATE state;                      
    BOOL nominated; 
    NullableUint32 circuitBreakerTriggerCount; 
    UINT32 packetsDiscardedOnSend;             
    UINT64 packetsSent;                        
    UINT64 packetsReceived;                    
    UINT64 bytesSent;                          
    UINT64 bytesReceived;                      
    UINT64 lastPacketSentTimestamp;            
    UINT64 lastPacketReceivedTimestamp;        
    UINT64 firstRequestTimestamp;    
    UINT64 lastRequestTimestamp;     
    UINT64 lastResponseTimestamp;    
    DOUBLE totalRoundTripTime;       
    DOUBLE currentRoundTripTime;     
    DOUBLE availableOutgoingBitrate; 
    DOUBLE availableIncomingBitrate; 
    UINT64 requestsReceived;         
    UINT64 requestsSent;             
    UINT64 responsesReceived;        
    UINT64 responsesSent;            
    UINT64 bytesDiscardedOnSend;     
} RtcIceCandidatePairStats, *PRtcIceCandidatePairStats;
 
typedef struct {
    DOMString url;                 
    DOMString protocol;            
    UINT32 iceServerIndex;         
    INT32 port;                    
    UINT64 totalRequestsSent;      
    UINT64 totalResponsesReceived; 
    UINT64 totalRoundTripTime;     
} RtcIceServerStats, *PRtcIceServerStats;
 
typedef struct {
    UINT64 localCandidateGatheringTime;
    UINT64 hostCandidateSetUpTime;
    UINT64 srflxCandidateSetUpTime;
    UINT64 relayCandidateSetUpTime;
    UINT64 iceServerParsingTime;
    UINT64 iceCandidatePairNominationTime;
    UINT64 candidateGatheringTime;
    UINT64 iceAgentSetUpTime;
    UINT64 candidateGatheringStartTime;
    UINT64 candidateGatheringEndTime;
} KvsIceAgentStats, *PKvsIceAgentStats;
 
typedef struct {
    DOMString url;                        
    DOMString transportId;                
    CHAR address[IP_ADDR_STR_LENGTH + 1]; 
    DOMString protocol;                   
    DOMString relayProtocol;              
    INT32 priority;                       
    INT32 port;                           
    DOMString candidateType;              
} RtcIceCandidateStats, *PRtcIceCandidateStats;
 
typedef struct {
    DOMString rtcpTransportStatsId;              
    DOMString selectedCandidatePairId;           
    DOMString localCertificateId;                
    DOMString remoteCertificateId;               
    CHAR tlsVersion[MAX_TLS_VERSION_LENGTH + 1]; 
    CHAR dtlsCipher[MAX_DTLS_CIPHER_LENGTH +
                    1]; 
    CHAR srtpCipher[MAX_SRTP_CIPHER_LENGTH + 1]; 
    CHAR tlsGroup[MAX_TLS_GROUP_LENGHTH +
                  1];     
    RTC_ICE_ROLE iceRole; 
    RTC_DTLS_TRANSPORT_STATE_STATS dtlsState; 
    UINT64 packetsSent;                       
    UINT64 packetsReceived;                   
    UINT64 bytesSent;                         
    UINT64 bytesReceived;                     
    UINT32 selectedCandidatePairChanges;      
} RtcTransportStats, *PRtcTransportStats;
 
typedef struct {
    UINT32 ssrc; 
    DOMString kind; 
    // TODO: transportId not yet populated
    DOMString transportId; 
 
    // TODO: codecId not yet populated
    DOMString codecId; 
} RTCRtpStreamStats, *PRTCRtpStreamStats;
 
typedef struct {
    RTCRtpStreamStats rtpStream;
    UINT64 packetsSent;
    UINT64 bytesSent; 
} RTCSentRtpStreamStats, *PRTCSentRtpStreamStats;
 
typedef struct {
    RTCSentRtpStreamStats sent;      
    BOOL voiceActivityFlag;          
    DOMString trackId;               
    DOMString mediaSourceId;         
    DOMString senderId;              
    DOMString remoteId;              
    DOMString rid;                   
    DOMString encoderImplementation; 
    UINT32 packetsDiscardedOnSend;   
    UINT32 framesSent;               
    UINT32 hugeFramesSent;           
    UINT32 framesEncoded;         
    UINT32 keyFramesEncoded;      
    UINT32 framesDiscardedOnSend; 
    UINT32 frameWidth;            
    UINT32 frameHeight;           
    UINT32 frameBitDepth;         
    UINT32 nackCount;             
    UINT32 firCount;              
    UINT32 pliCount;              
    UINT32 sliCount;              
    UINT32 qualityLimitationResolutionChanges; 
    INT32 fecPacketsSent; 
    UINT64 lastPacketSentTimestamp;  
    UINT64 headerBytesSent;          
    UINT64 bytesDiscardedOnSend;     
    UINT64 retransmittedPacketsSent; 
    UINT64 retransmittedBytesSent;   
    UINT64 targetBitrate;            
    UINT64 totalEncodedBytesTarget;  
    DOUBLE framesPerSecond;          
    UINT64 qpSum;            
    UINT64 totalSamplesSent; 
    UINT64 samplesEncodedWithSilk; 
    UINT64 samplesEncodedWithCelt; 
    UINT64 totalEncodeTime;        
    UINT64 totalPacketSendDelay;   
    UINT64 averageRtcpInterval;    
    QualityLimitationDurationsRecord qualityLimitationDurations; 
    DscpPacketsSentRecord perDscpPacketsSent;                    
    RTC_QUALITY_LIMITATION_REASON qualityLimitationReason;       
} RtcOutboundRtpStreamStats, *PRtcOutboundRtpStreamStats;
 
typedef struct {
    DOMString localId;                
    UINT64 roundTripTime;             
    UINT64 totalRoundTripTime;        
    DOUBLE fractionLost;              
    UINT64 reportsReceived;           
    UINT64 roundTripTimeMeasurements; 
} RtcRemoteInboundRtpStreamStats, *PRtcRemoteInboundRtpStreamStats;
 
typedef struct {
    RTCRtpStreamStats rtpStream;
    UINT64 packetsReceived; 
    INT64 packetsLost; 
    DOUBLE jitter;     
    UINT64 packetsDiscarded; 
    UINT64 packetsRepaired; 
    UINT64 burstPacketsLost;      
    UINT64 burstPacketsDiscarded; 
    UINT32 burstLossCount; 
    UINT32 burstDiscardCount; 
    DOUBLE burstLossRate;     
    DOUBLE burstDiscardRate;  
    DOUBLE gapLossRate; 
    DOUBLE gapDiscardRate;    
    UINT32 framesDropped;     
    UINT32 partialFramesLost; 
    UINT32 fullFramesLost; 
} RtcReceivedRtpStreamStats, *PRtcReceivedRtpStreamStats;
 
typedef struct {
    RtcReceivedRtpStreamStats received; // dictionary RTCInboundRtpStreamStats : RTCReceivedRtpStreamStats
    DOMString trackId;    
    DOMString receiverId; 
    DOMString remoteId;   
    UINT32 framesDecoded; 
    UINT32 keyFramesDecoded; 
    UINT16 frameWidth;       
    UINT16 frameHeight;      
    UINT8 frameBitDepth; 
    DOUBLE framesPerSecond; 
    UINT64 qpSum;           
    DOUBLE totalDecodeTime; 
    DOUBLE totalInterFrameDelay; 
    DOUBLE totalSquaredInterFrameDelay; 
 
    BOOL voiceActivityFlag; 
    DOMHighResTimeStamp
        lastPacketReceivedTimestamp; 
    DOUBLE averageRtcpInterval; 
    UINT64 headerBytesReceived; 
    UINT64 fecPacketsReceived;  
    UINT64
    fecPacketsDiscarded;  
    UINT64 bytesReceived; 
    UINT64 packetsFailedDecryption; 
    UINT64 packetsDuplicated; 
 
    UINT32 nackCount; 
    UINT32 firCount;  
    UINT32 pliCount;  
    UINT32 sliCount;  
    DOMHighResTimeStamp estimatedPlayoutTimestamp; 
    DOUBLE jitterBufferDelay; 
    UINT64 jitterBufferEmittedCount; 
    UINT64 totalSamplesReceived; 
    UINT64 samplesDecodedWithSilk; 
    UINT64 samplesDecodedWithCelt; 
    UINT64 concealedSamples; 
    UINT64 silentConcealedSamples; 
    UINT64 concealmentEvents; 
    UINT64 insertedSamplesForDeceleration; 
    UINT64 removedSamplesForAcceleration; 
    DOUBLE audioLevel; 
    DOUBLE totalAudioEnergy; 
    DOUBLE totalSamplesDuration; 
    UINT32 framesReceived;       
    DOMString decoderImplementation; 
} RtcInboundRtpStreamStats, *PRtcInboundRtpStreamStats;
 
typedef enum {
    RTC_DATA_CHANNEL_STATE_CONNECTING, 
    RTC_DATA_CHANNEL_STATE_OPEN,       
    RTC_DATA_CHANNEL_STATE_CLOSING,    
    RTC_DATA_CHANNEL_STATE_CLOSED      
} RTC_DATA_CHANNEL_STATE;
 
typedef struct {
    DOMString label;              
    DOMString protocol;           
    INT32 dataChannelIdentifier;  
    DOMString transportId;        
    RTC_DATA_CHANNEL_STATE state; 
    UINT32 messagesSent;          
    UINT64 bytesSent;        
    UINT32 messagesReceived; 
    UINT64 bytesReceived;    
} RtcDataChannelStats, *PRtcDataChannelStats;
 
typedef struct {
    UINT64 describeChannelStartTime;
    UINT64 describeChannelEndTime;
    UINT64 getSignalingChannelEndpointStartTime;
    UINT64 getSignalingChannelEndpointEndTime;
    UINT64 getIceServerConfigStartTime;
    UINT64 getIceServerConfigEndTime;
    UINT64 getTokenStartTime;
    UINT64 getTokenEndTime;
    UINT64 createChannelStartTime;
    UINT64 createChannelEndTime;
    UINT64 connectStartTime;
    UINT64 connectEndTime;
    UINT64 cpApiCallLatency;         
    UINT64 dpApiCallLatency;         
    UINT64 signalingClientUptime;    
    UINT64 connectionDuration;       
    UINT32 numberOfMessagesSent;     
    UINT32 numberOfMessagesReceived; 
    UINT32 iceRefreshCount;          
    UINT32 numberOfErrors;           
    UINT32 numberOfRuntimeErrors;    
    UINT32 numberOfReconnects;       
    UINT32 apiCallRetryCount;        
    UINT64 getTokenCallTime;         
    UINT64 describeCallTime;         
    UINT64 describeMediaCallTime;    
    UINT64 createCallTime;           
    UINT64 getEndpointCallTime;      
    UINT64 getIceConfigCallTime;     
    UINT64 connectCallTime;          
    UINT64 joinSessionCallTime;      
    UINT64 createClientTime;         
    UINT64
    fetchClientTime; 
    UINT64 connectClientTime; 
    UINT64 offerToAnswerTime;
    UINT64 offerReceivedTime;
    UINT64 answerTime;
    UINT64 joinSessionToOfferRecvTime; 
} SignalingClientStats, *PSignalingClientStats;
 
typedef struct {
    UINT64 peerConnectionStartTime;
    UINT64 peerConnectionConnectedTime;
    UINT64 peerConnectionCreationTime; 
    UINT64 dtlsSessionSetupTime;       
    UINT64 iceHolePunchingTime;        
    UINT64 closePeerConnectionTime;    
    UINT64 freePeerConnectionTime;     
    UINT64 stunDnsResolutionTime;      
} PeerConnectionStats, *PPeerConnectionStats;
 
typedef struct {
    RtcIceCandidatePairStats iceCandidatePairStats;             
    RtcIceCandidateStats localIceCandidateStats;                
    RtcIceCandidateStats remoteIceCandidateStats;               
    RtcIceServerStats iceServerStats;                           
    RtcTransportStats transportStats;                           
    RtcOutboundRtpStreamStats outboundRtpStreamStats;           
    RtcRemoteInboundRtpStreamStats remoteInboundRtpStreamStats; 
    RtcInboundRtpStreamStats inboundRtpStreamStats;             
    RtcDataChannelStats rtcDataChannelStats;
} RtcStatsObject, *PRtcStatsObject;
#ifdef __cplusplus
}
#endif
#endif /* __KINESIS_VIDEO_WEBRTCCLIENT_STATS_INCLUDE__ */