RtcStats
Call-related statistics.
export class RtcStats {
duration?: number;
txBytes?: number;
rxBytes?: number;
txAudioBytes?: number;
txVideoBytes?: number;
rxAudioBytes?: number;
rxVideoBytes?: number;
txKBitRate?: number;
rxKBitRate?: number;
rxAudioKBitRate?: number;
txAudioKBitRate?: number;
rxVideoKBitRate?: number;
txVideoKBitRate?: number;
lastmileDelay?: number;
userCount?: number;
cpuAppUsage?: number;
cpuTotalUsage?: number;
gatewayRtt?: number;
memoryAppUsageRatio?: number;
memoryTotalUsageRatio?: number;
memoryAppUsageInKbytes?: number;
connectTimeMs?: number;
firstAudioPacketDuration?: number;
firstVideoPacketDuration?: number;
firstVideoKeyFramePacketDuration?: number;
packetsBeforeFirstKeyFramePacket?: number;
firstAudioPacketDurationAfterUnmute?: number;
firstVideoPacketDurationAfterUnmute?: number;
firstVideoKeyFramePacketDurationAfterUnmute?: number;
firstVideoKeyFrameDecodedDurationAfterUnmute?: number;
firstVideoKeyFrameRenderedDurationAfterUnmute?: number;
txPacketLossRate?: number;
rxPacketLossRate?: number;
}
Properties
- duration
- Call duration (seconds) of the local user, cumulative.
- txBytes
- Bytes sent.
- rxBytes
- Bytes received.
- txAudioBytes
- Audio bytes sent, cumulative.
- txVideoBytes
- Video bytes sent, cumulative.
- rxAudioBytes
- Audio bytes received, cumulative.
- rxVideoBytes
- Video bytes received, cumulative.
- txKBitRate
- Sending bitrate (Kbps).
- rxKBitRate
- Receiving bitrate (Kbps).
- rxAudioKBitRate
- Audio receiving bitrate (Kbps).
- txAudioKBitRate
- Audio sending bitrate (Kbps).
- rxVideoKBitRate
- Video receiving bitrate (Kbps).
- txVideoKBitRate
- Video sending bitrate (Kbps).
- lastmileDelay
- Client-to-access server delay (ms).
- txPacketLossRate
- Uplink packet loss rate (%) before applying anti-packet-loss technology.
- rxPacketLossRate
- Downlink packet loss rate (%) before applying anti-packet-loss technology.
- userCount
- Number of users in the current channel.
- cpuAppUsage
- CPU usage (%) of the current App.
Note:
- The
cpuAppUsagereported in the onLeaveChannel callback is always 0.
- The
- cpuTotalUsage
- CPU usage (%) of the current system.
On Windows platforms with multi-core CPUs, this represents the average usage across all cores. Calculated as (100 - CPU usage of the System Idle Process shown in Task Manager)/100.
Note:
- The
cpuTotalUsagereported in the onLeaveChannel callback is always 0.
- The
- connectTimeMs
- Time (ms) from starting to establish the connection to successful connection. A value of 0 indicates invalid.
- gatewayRtt
- Round-trip time (ms) from the client to the local router.
- memoryAppUsageRatio
- Memory usage ratio (%) of the current App.
Note: This value is for reference only. It may not be retrievable due to system limitations.
- memoryTotalUsageRatio
- Memory usage ratio (%) of the current system.
Note: This value is for reference only. It may not be retrievable due to system limitations.
- memoryAppUsageInKbytes
- Memory usage (KB) of the current App.
Note: This value is for reference only. It may not be retrievable due to system limitations.