Report In-call Statistics

Introduction

After joining the channel, the SDK triggers the following callbacks related to the call quality once every two seconds. You can see the last mile network quality, local statistics, audio quality, and video quality of the current call.

We provide an open-source OpenLive-Windows demo project.

Sample project

Agora provides an open-source sample project on GitHub that implements the in-call statistics monitoring function. You can download the sample project to try it out or view the source code.

Network quality report

The onNetworkQuality callback reports the uplink and downlink last mile network quality of each user/host in the current call, see Quality Rating for details. Last mile refers to the network from your device to Agora’s edge server. The uplink last mile quality rating is based on the actual transmission bitrate, the uplink network packet loss rate, the average round-trip delay, and the uplink network jitter; while the downlink last mile quality rating is based on the downlink network packet loss rate, the average round-trip delay, and the downlink network jitter.

Note:

• In the COMMUNICATION profile, you receive network quality reports of all the users (including yours) in the channel once every two seconds.
• In the LIVE_BROADCASTING profile, if you are the host, you receive network quality reports of all hosts (including yours) in the channel once every two seconds; if you are the audience, you receive the report of all hosts and yourself once every two seconds.
• The higher the ratio of the actual transmission bitrate to the target transmission bitrate, the better the call quality and the higher the network quality.
• The average round-trip delay refers to the average value of multiple round-trip delays in the reported interval.

Sample code

virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)override {
        ;
    }

Statistics report

The onRtcStats callback reports call statistics. You can see the duration, the number of users in the channel, the system CPU usage, the application CPU usage, and the following parameters of the current call.

Sample code

virtual void onRtcStats(const RtcStats& stats) {
        if (m_hMsgHanlder)
            ::PostMessage(m_hMsgHanlder, WM_MSGID(EID_RTC_STATS),(WPARAM)new RtcStats(stats), 0);
    }

LRESULT CAgoraReportInCallDlg::OnEIDRtcStats(WPARAM wParam, LPARAM lParam)
{
    RtcStats *p = reinterpret_cast<RtcStats *>(wParam);
    if (p)
    {
        CString tmp;
        tmp.Format(_T("%dKbps/%dKbps"), p->txKBitRate, p->rxKBitRate);
        m_staTotalBitrateVal.SetWindowText(tmp);
        tmp.Format(_T("%.2fMB/%.2fMB"), p->txBytes ? p->txBytes / 1024.0 / 1024 : 0, p->rxBytes ? p->rxBytes / 1024.0 / 1024 : 0);
        m_staTotalBytesVal.SetWindowText(tmp);
        delete p;
    }
    return TRUE;
}

Audio Quality Report

Statistics of local audio streams

The onLocalAudioStats callback reports the statistics of the audio streams sent. You can see the number of channels (mono or dual), the sample rate, and the average sending bitrate in the reported interval.

Note:

The SDK triggers this callback once every two seconds. The sample rate refers to the actual sample rate of the audio streams sent in the reported interval.

Sample code

virtual void onLocalAudioStats(const LocalAudioStats& stats) {
        (void)stats;
    }

State changes of local audio streams

When the state of the local audio stream changes (including the state of the audio recording and encoding), the SDK triggers the onLocalAudioStateChanged callback to report the current state. You can troubleshoot with the error code when exceptions occur.

Sample code

virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) {
        (void)state;
        (void)error;
    }

Statistics of remote audio streams

The onRemoteAudioStats callback reports the audio statistics of each remote user/host in the current call. You can see the quality of the audio stream sent by each remote user/host (see Quality Rating), the number of channels (mono or dual), and the following parameters.

The onRemoteAudioStats callback reports statistics more closely linked to the real-user experience of the audio transmission quality. Even if network packet loss occurs, users may find the overall audio quality acceptable because the audio frame loss rate of the received audio streams may not be high due to the anti-packet-loss and congestion control methods, such as forward error correction (FEC), retransmissions and bandwidth estimation.

Note:

• In the COMMUNICATION profile, you receive the audio stream statistics of all the remote users (excluding yours) in the channel once every two seconds.
• In the LIVE_BROADCASTING profile, if you are the host, you receive the audio stream statistics of all remote hosts (excluding yours) in the channel once every two seconds; if you are the audience, you receive the statistics of all hosts in the channel once every two seconds.
• Agora's audio module refers to the audio processing process, and not the actual module in the SDK. When sending audio streams, the audio module refers to the processes of audio sampling, pre-processing, and encoding; when receiving audio streams, the audio module refers to the processes of audio decoding, post-processing, and playback.
• Users can only turn on/off their own audio modules.
• By default, the audio freezes at most once in each reported interval.

Sample code

virtual void onRemoteAudioStats(const RemoteAudioStats& stats) {
        if (m_hMsgHanlder)
            ::PostMessage(m_hMsgHanlder, WM_MSGID(EID_REMOTE_AUDIO_STATS), (WPARAM)new RemoteAudioStats(stats), 0);
    }

LRESULT CAgoraReportInCallDlg::OnEIDRemoteAudioStats(WPARAM wParam, LPARAM lParam)
{
    RemoteAudioStats *p = reinterpret_cast<RemoteAudioStats *>(wParam);
    if (p)
    {
        CString tmp;
        tmp.Format(_T("%dms"), p->networkTransportDelay);
        m_staAudioNetWorkDelayVal.SetWindowText(tmp);


        tmp.Format(_T("%dKbps"), p->receivedBitrate);
        m_staAudioRecvBitrateVal.SetWindowText(tmp);

        delete p;
    }
    return TRUE;
}

State changes of remote audio streams

When the state of remote audio stream changes, the SDK triggers the onRemoteAudioStateChanged callback to report the current state and the reason for the state change.

Note:

• In the COMMUNICATION profile, this callback reports to you the audio stream state information of all the remote users (excluding yours) in the channel once every two seconds.
• In the LIVE_BROADCASTING profile, if you are the host, this callback reports to you the audio stream state information of all the remote hosts(excluding yours) in the channel once every two seconds; if you are the audience, this callback reports to you the audio stream state information of all the remote hosts in the channel once every two seconds.

Sample code

virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) {
        (void)uid;
        (void)state;
        (void)reason;
        (void)elapsed;
    }

Video Quality Report

Statistics of local video streams

The onLocalVideoStats callback reports the statistics of the video streams sent. You can see the dimensions of the encoding frame and the following parameters.

Note:
If you have called the enableDualStreamMode method to enable dual-stream mode, this callback reports the statistics of the high-video streams sent.

Sample code

virtual void onLocalVideoStats(const LocalVideoStats& stats) {
        if (m_hMsgHanlder)
            ::PostMessage(m_hMsgHanlder, WM_MSGID(EID_LOCAL_VIDEO_STATS), (WPARAM)new LocalVideoStats(stats), 0);
    }

LRESULT CAgoraReportInCallDlg::OnEIDLocalVideoStats(WPARAM wParam, LPARAM lParam)
{
    LocalVideoStats *p = reinterpret_cast<LocalVideoStats *>(wParam);
    if (p)
    {
        CString tmp;
        tmp.Format(_T("%d fps"), p->sentFrameRate);
        m_staLocalVideoFPSVal.SetWindowText(tmp);
        tmp.Format(_T("%d X %d"), p->encodedFrameWidth, p->encodedFrameHeight);
        m_staLocalVideoResoultionVal.SetWindowText(tmp);
        delete p;
    }
    return TRUE;
}

State changes of local video streams

When the state of the local video changes, the SDK triggers the onLocalVideoStateChanged callback to report the current state. You can troubleshoot with the error code when exceptions occur.

Sample code

virtual void onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE localVideoState, LOCAL_VIDEO_STREAM_ERROR error) {
        (void)localVideoState;
        (void)error;
    }

Statistics of remote video streams

The onRemoteVideoStats callback reports the video statistics of each remote user/host in the current call. You can see their video dimensions and the following parameters.

Note:

• In the COMMUNICATION profile, you receive video stream statistics of all the remote users (excluding yours) in the channel once every two seconds.
• In the LIVE_BROADCASTING profile, if you are the host, you receive video stream statistics of all the remote hosts (excluding yours) in the channel once every two seconds; if you are the audience, you receive the statistics for all the hosts in the channel once every two seconds.
• Agora’s video module refers to the video processing process, and not the actual module in the SDK. When sending video streams, the video module refers to the processes of video capturing, pre-processing, and encoding; when receiving video streams, the video module refers to the processes of video decoding, post-processing, and rendering/playing.
• Users can only turn on/off their own video modules.

Sample code

virtual void onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE localVideoState, LOCAL_VIDEO_STREAM_ERROR error) {
        (void)localVideoState;
        (void)error;
    }

State changes of remote video streams

When the state of remote video streams changes, the SDK triggers the onRemoteVideoStateChanged callback to report the current state and the reason for the state change.

Note:

• In the COMMUNICATION profile, this callback reports to you the video stream state information of all the remote users (excluding yours) in the channel once every two seconds.
• In the LIVE_BROADCASTING profile, if you are the host, this callback reports to you the video stream state information of all the remote hosts (excluding yours) in the channel once every two seconds; if you are the audience, this callback reports to you the video stream state information of all the remote hosts in the channel once every two seconds.

Sample code

virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) override
    {
        if (m_hMsgHanlder) {
            PVideoStateStateChanged stateChanged = new VideoStateStateChanged;
            stateChanged->uid = uid;
            stateChanged->reason = reason;
            stateChanged->state = state;
            ::PostMessage(m_hMsgHanlder, WM_MSGID(EID_REMOTE_VIDEO_STATE_CHANED), (WPARAM)stateChanged, 0);
        }
    }

API reference

• onNetworkQuality
• onRtcStats
• onLocalAudioStats
• onLocalAudioStateChanged
• onRemoteAudioStats
• onRemoteAudioStateChanged
• onLocalVideoStats
• onLocalVideoStateChanged
• onRemoteVideoStats
• onRemoteVideoStateChanged

Considerations

The SDK does not trigger the onLocalAudioStateChanged, onRemoteAudioStateChanged, onLocalVideoStateChanged, and onRemoteVideoStateChanged callbacks once every two seconds. See their respective trigger conditions on this page.