Agora Server Gateway SDK C++ API Reference
Public Member Functions | Public Attributes | List of all members
agora::rtc::RtcStats Struct Reference

#include <AgoraBase.h>

Public Member Functions

 RtcStats ()
 

Public Attributes

unsigned int duration
 
unsigned int txBytes
 
unsigned int rxBytes
 
unsigned int txAudioBytes
 
unsigned int txVideoBytes
 
unsigned int rxAudioBytes
 
unsigned int rxVideoBytes
 
unsigned short txKBitRate
 
unsigned short rxKBitRate
 
unsigned short rxAudioKBitRate
 
unsigned short txAudioKBitRate
 
unsigned short rxVideoKBitRate
 
unsigned short txVideoKBitRate
 
unsigned short lastmileDelay
 
unsigned int userCount
 
double cpuAppUsage
 
double cpuTotalUsage
 
int gatewayRtt
 
double memoryAppUsageRatio
 
double memoryTotalUsageRatio
 
int memoryAppUsageInKbytes
 
int connectTimeMs
 
int firstAudioPacketDuration
 
int firstVideoPacketDuration
 
int firstVideoKeyFramePacketDuration
 
int packetsBeforeFirstKeyFramePacket
 
int firstAudioPacketDurationAfterUnmute
 
int firstVideoPacketDurationAfterUnmute
 
int firstVideoKeyFramePacketDurationAfterUnmute
 
int firstVideoKeyFrameDecodedDurationAfterUnmute
 
int firstVideoKeyFrameRenderedDurationAfterUnmute
 
int txPacketLossRate
 
int rxPacketLossRate
 

Detailed Description

The definition of the RtcStats struct.

Constructor & Destructor Documentation

◆ RtcStats()

agora::rtc::RtcStats::RtcStats ( )
inline

Member Data Documentation

◆ connectTimeMs

int agora::rtc::RtcStats::connectTimeMs

The time elapsed from the when the app starts connecting to an Agora channel to when the connection is established. 0 indicates that this member does not apply.

◆ cpuAppUsage

double agora::rtc::RtcStats::cpuAppUsage

The app CPU usage (%).

◆ cpuTotalUsage

double agora::rtc::RtcStats::cpuTotalUsage

The system CPU usage (%).

◆ duration

unsigned int agora::rtc::RtcStats::duration

The call duration (s), represented by an aggregate value.

◆ firstAudioPacketDuration

int agora::rtc::RtcStats::firstAudioPacketDuration

The duration (ms) between the app starting connecting to an Agora channel and the first audio packet is received. 0 indicates that this member does not apply.

◆ firstAudioPacketDurationAfterUnmute

int agora::rtc::RtcStats::firstAudioPacketDurationAfterUnmute

The duration (ms) between the last time audio is unmuted and the first audio packet is received. 0 indicates that this member does not apply.

◆ firstVideoKeyFrameDecodedDurationAfterUnmute

int agora::rtc::RtcStats::firstVideoKeyFrameDecodedDurationAfterUnmute

The duration (ms) between the last time unmute video and the first video key frame is decoded. 0 indicates that this member does not apply.

◆ firstVideoKeyFramePacketDuration

int agora::rtc::RtcStats::firstVideoKeyFramePacketDuration

The duration (ms) between the app starting connecting to an Agora channel and the first video key frame is received. 0 indicates that this member does not apply.

◆ firstVideoKeyFramePacketDurationAfterUnmute

int agora::rtc::RtcStats::firstVideoKeyFramePacketDurationAfterUnmute

The duration (ms) between the last time unmute video and the first video key frame is received. 0 indicates that this member does not apply.

◆ firstVideoKeyFrameRenderedDurationAfterUnmute

int agora::rtc::RtcStats::firstVideoKeyFrameRenderedDurationAfterUnmute

The duration (ms) between the last time unmute video and the first video key frame is rendered. 0 indicates that this member does not apply.

◆ firstVideoPacketDuration

int agora::rtc::RtcStats::firstVideoPacketDuration

The duration (ms) between the app starting connecting to an Agora channel and the first video packet is received. 0 indicates that this member does not apply.

◆ firstVideoPacketDurationAfterUnmute

int agora::rtc::RtcStats::firstVideoPacketDurationAfterUnmute

The duration (ms) between the last time video is unmuted and the first video packet is received. 0 indicates that this member does not apply.

◆ gatewayRtt

int agora::rtc::RtcStats::gatewayRtt

The round-trip time delay (ms) from the client to the local router.

◆ lastmileDelay

unsigned short agora::rtc::RtcStats::lastmileDelay

The VOS client-server latency (ms).

◆ memoryAppUsageInKbytes

int agora::rtc::RtcStats::memoryAppUsageInKbytes

The memory usage of the app (KB).

◆ memoryAppUsageRatio

double agora::rtc::RtcStats::memoryAppUsageRatio

The memory usage ratio of the app (%).

◆ memoryTotalUsageRatio

double agora::rtc::RtcStats::memoryTotalUsageRatio

The memory usage ratio of the system (%).

◆ packetsBeforeFirstKeyFramePacket

int agora::rtc::RtcStats::packetsBeforeFirstKeyFramePacket

The number of video packets before the first video key frame is received. 0 indicates that this member does not apply.

◆ rxAudioBytes

unsigned int agora::rtc::RtcStats::rxAudioBytes

The total number of audio bytes received (bytes), represented by an aggregate value.

◆ rxAudioKBitRate

unsigned short agora::rtc::RtcStats::rxAudioKBitRate

Audio receiving bitrate (Kbps), represented by an instantaneous value.

◆ rxBytes

unsigned int agora::rtc::RtcStats::rxBytes

The total number of bytes received, represented by an aggregate value.

◆ rxKBitRate

unsigned short agora::rtc::RtcStats::rxKBitRate

The receiving bitrate (Kbps), represented by an instantaneous value.

◆ rxPacketLossRate

int agora::rtc::RtcStats::rxPacketLossRate

The packet loss rate of receiver (audience).

◆ rxVideoBytes

unsigned int agora::rtc::RtcStats::rxVideoBytes

The total number of video bytes received (bytes), represented by an aggregate value.

◆ rxVideoKBitRate

unsigned short agora::rtc::RtcStats::rxVideoKBitRate

The video receive bitrate (Kbps), represented by an instantaneous value.

◆ txAudioBytes

unsigned int agora::rtc::RtcStats::txAudioBytes

The total number of audio bytes sent (bytes), represented by an aggregate value.

◆ txAudioKBitRate

unsigned short agora::rtc::RtcStats::txAudioKBitRate

The audio transmission bitrate (Kbps), represented by an instantaneous value.

◆ txBytes

unsigned int agora::rtc::RtcStats::txBytes

The total number of bytes transmitted, represented by an aggregate value.

◆ txKBitRate

unsigned short agora::rtc::RtcStats::txKBitRate

The transmission bitrate (Kbps), represented by an instantaneous value.

◆ txPacketLossRate

int agora::rtc::RtcStats::txPacketLossRate

The packet loss rate of sender (broadcaster).

◆ txVideoBytes

unsigned int agora::rtc::RtcStats::txVideoBytes

The total number of video bytes sent (bytes), represented by an aggregate value.

◆ txVideoKBitRate

unsigned short agora::rtc::RtcStats::txVideoKBitRate

The video transmission bitrate (Kbps), represented by an instantaneous value.

◆ userCount

unsigned int agora::rtc::RtcStats::userCount

The number of users in the channel.


The documentation for this struct was generated from the following file: