Statistics of a call session.

Hierarchy

  • RtcStats

Constructors

Properties

connectTimeMs?: number

The duration (ms) between the SDK starts connecting and the connection is established. If the value reported is 0, it means invalid.

cpuAppUsage?: number

Application CPU usage (%). The value of cpuAppUsage is always reported as 0 in the onLeaveChannel callback.

cpuTotalUsage?: number

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

duration?: number

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

gatewayRtt?: number

The round-trip time delay (ms) from the client to the local router. This property is disabled on devices running iOS 14 or later, and enabled on devices running versions earlier than iOS 14 by default. To enable this property on devices running iOS 14 or later,. On Android, to get gatewayRtt, ensure that you add the android.permission.ACCESS_WIFI_STATE permission after in the AndroidManifest.xml file in your project.

lastmileDelay?: number

The client-to-server delay (milliseconds).

memoryAppUsageInKbytes?: number

The memory size occupied by the app (KB). This value is for reference only. Due to system limitations, you may not get this value.

memoryAppUsageRatio?: number

The memory ratio occupied by the app (%). This value is for reference only. Due to system limitations, you may not get this value.

memoryTotalUsageRatio?: number

The memory occupied by the system (%). This value is for reference only. Due to system limitations, you may not get this value.

rxAudioBytes?: number

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

rxAudioKBitRate?: number

The bitrate (Kbps) of receiving the audio.

rxBytes?: number

The number of bytes received.

rxKBitRate?: number

The receiving bitrate (Kbps).

rxPacketLossRate?: number

The packet loss rate (%) from the Agora server to the client before using the anti-packet-loss method.

rxVideoBytes?: number

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

rxVideoKBitRate?: number

The bitrate (Kbps) of receiving the video.

txAudioBytes?: number

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

txAudioKBitRate?: number

The bitrate (Kbps) of sending the audio packet.

txBytes?: number

The number of bytes sent.

txKBitRate?: number

The actual bitrate (Kbps) while sending the local video stream.

txPacketLossRate?: number

The packet loss rate (%) from the client to the Agora server before applying the anti-packet-loss algorithm.

txVideoBytes?: number

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

txVideoKBitRate?: number

The bitrate (Kbps) of sending the video.

userCount?: number

The number of users in the channel.

Generated using TypeDoc