In-call quality monitoring

Try out the online demo for displaying In-call Statistics.

Understand the tech

After a user joins a channel, RTC SDK triggers a series of callbacks every 2 seconds, reporting information such as uplink and downlink network quality, real-time interaction statistics, and statistics of local and remote audio and video streams.

When there is a change in the audio or video state of a user, RTC SDK triggers a callback to report the latest state and the reason for the change. The following figure shows the audio transmission process between app clients:

Audio transmission process

To monitor the call quality, Agora provides the following call quality notifications:

Network quality

The network quality callback provides insight into the uplink and downlink last mile network quality for each participant in the channel. Last mile refers to the network from your device to Agora server. The Network quality scores are calculated based on factors such as sending or receiving bitrate, network packet loss rate, round-trip delay, and network jitter.

Statistics

The statistics callback, triggered every 2 seconds, reports key metrics such as call duration and the number of participants.

Audio quality

Callbacks related to audio quality cover both local and remote audio streams. You monitor statistics and status changes, to gain insights into the quality of audio streams and any related reasons for status changes.

Video quality

Video quality callbacks provide information on both local and remote video streams. You receive statistics and status change notifications, that enable you to understand the quality of video streams and any related reasons for status changes.

Prerequisites

Ensure that you have implemented the SDK quickstart in your project.

Implement in-call quality monitoring

Implement the following real-time interaction quality statistics methods and audio or video state monitoring methods to understand user interaction experience:

• network-quality: Reports uplink and downlink last mile network quality.
• getRTCStats: Reports real-time interaction statistics.
• getLocalAudioStats: Reports statistics for the sent audio stream.
• getRemoteAudioStats: Reports statistics for the received remote audio stream.
• getLocalVideoStats: Reports statistics for the sent video stream.
• getRemoteVideoStats: Reports statistics for the received remote video stream.

In your app, add the following code:

// Subscribe to the "network-quality" event to receive uplink network conditions
agoraEngine.on("network-quality", (quality) => {
 console.log("Network quality:", quality);
});

// Get remote network quality
const remoteNetworkQuality = client.getRemoteNetworkQuality();

// Get local audio and video statistics
const localStats = {
 video: client.getLocalVideoStats(),
 audio: client.getLocalAudioStats()
};

// Get overall channel statistics
const rtcStats = agoraEngine.getRTCStats();
console.log("Channel statistics:", rtcStats);

// Get remote user's audio statistics using the remote UID
const remoteAudioStats = agoraEngine.getRemoteAudioStats(remoteUID);
console.log("Remote user audio statistics:", remoteAudioStats);

// Get remote user's video statistics using the remote UID
const remoteVideoStats = agoraEngine.getRemoteVideoStats(remoteUID);
console.log("Remote user video statistics:", remoteVideoStats);

The SDK reports abnormal events in the channel through the AgoraRTCClient.on("exception") callback. Unusual events are not errors, but often cause call quality issues. After an abnormal event occurs, if the situation returns to normal, you receive this callback again.

client.on("exception", function(evt) {
 console.log(evt.code, evt.msg, evt.uid);
})

This callback returns:

• code: event code.
• msg: Prompt message.
• uid: UID of the user where exception or recovery has occurred.

Each abnormal event has a corresponding recovery event, as described in the following table:

Reference

Network quality score

API reference

• network-quality

• getRTCStats

• getLocalAudioStats

• getRemoteAudioStats

• getLocalVideoStats

• getRemoteVideoStats