Agora Java API Reference for Android
Public Attributes | List of all members
io.agora.rtc.IRtcEngineEventHandler.RtcStats Class Reference

Public Attributes

int totalDuration
 
int txBytes
 
int rxBytes
 
int txAudioBytes
 
int txVideoBytes
 
int rxAudioBytes
 
int rxVideoBytes
 
int txKBitRate
 
int rxKBitRate
 
int txAudioKBitRate
 
int rxAudioKBitRate
 
int txVideoKBitRate
 
int rxVideoKBitRate
 
int users
 
int lastmileDelay
 
int txPacketLossRate
 
int rxPacketLossRate
 
double cpuTotalUsage
 
double cpuAppUsage
 
int gatewayRtt
 
double memoryAppUsageRatio
 
double memoryTotalUsageRatio
 
int memoryAppUsageInKbytes
 

Detailed Description

Statistics of RTCEngine.

Member Data Documentation

◆ totalDuration

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.totalDuration

Call duration of the local user in seconds, represented by an aggregate value.

◆ txBytes

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.txBytes

Total number of bytes transmitted, represented by an aggregate value.

◆ rxBytes

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.rxBytes

Total number of bytes received, represented by an aggregate value.

◆ txAudioBytes

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.txAudioBytes

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

Since
v2.9.0.

◆ txVideoBytes

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.txVideoBytes

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

Since
v2.9.0.

◆ rxAudioBytes

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.rxAudioBytes

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

Since
v2.9.0.

◆ rxVideoBytes

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.rxVideoBytes

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

Since
v2.9.0.

◆ txKBitRate

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.txKBitRate

Transmission bitrate in Kbps, represented by an instantaneous value.

◆ rxKBitRate

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.rxKBitRate

Receive bitrate (Kbps), represented by an instantaneous value.

◆ txAudioKBitRate

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.txAudioKBitRate

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

◆ rxAudioKBitRate

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.rxAudioKBitRate

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

◆ txVideoKBitRate

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.txVideoKBitRate

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

◆ rxVideoKBitRate

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.rxVideoKBitRate

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

◆ users

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.users

The number of users in the channel.

  • COMMUNICATION profile: The number of users in the channel.
  • LIVE_BROADCASTING profile:
    • If the local user is an audience: The number of users in the channel = The number of hosts in the channel + 1.
    • If the local user is a host: The number of users in the channel = The number of hosts in the channel.

◆ lastmileDelay

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.lastmileDelay

Client-server latency.

◆ txPacketLossRate

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.txPacketLossRate

The packet loss rate (%) from the local client to Agora edge server, before network countermeasures.

◆ rxPacketLossRate

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.rxPacketLossRate

The packet loss rate (%) from Agora edge server to the local client, before network countermeasures.

◆ cpuTotalUsage

double io.agora.rtc.IRtcEngineEventHandler.RtcStats.cpuTotalUsage

System CPU usage (%).

Note
  • The cpuTotalUsage reported in the onLeaveChannel callback is always 0.
  • As of Android 8.1, you cannot get the CPU usage from this attribute due to system limitations.

◆ cpuAppUsage

double io.agora.rtc.IRtcEngineEventHandler.RtcStats.cpuAppUsage

Application CPU usage (%).

Note
  • The cpuAppUsage reported in the onLeaveChannel callback is always 0.
  • As of Android 8.1, you might not be able to get the CPU usage from this attribute due to system limitations.

◆ gatewayRtt

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.gatewayRtt

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

To get gatewayRtt, ensure that you add the android.permission.ACCESS_WIFI_STATE permission after </application> in the AndroidManifest.xml file of your project.

◆ memoryAppUsageRatio

double io.agora.rtc.IRtcEngineEventHandler.RtcStats.memoryAppUsageRatio

The memory usage ratio of the app (%).

Note
This value is for reference only. Due to system limitations, you may not get the value of this member.

◆ memoryTotalUsageRatio

double io.agora.rtc.IRtcEngineEventHandler.RtcStats.memoryTotalUsageRatio

The memory usage ratio of the system (%).

Note
This value is for reference only. Due to system limitations, you may not get the value of this member.

◆ memoryAppUsageInKbytes

int io.agora.rtc.IRtcEngineEventHandler.RtcStats.memoryAppUsageInKbytes

The memory usage of the app (KB).

Note
This value is for reference only. Due to system limitations, you may not get the value of this member.