Agora C++ API Reference for All Platforms

Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
agora::rtc::RemoteAudioStats Struct Reference

`#include <IAgoraRtcEngine.h>`

## Public Member Functions
| RemoteAudioStats ()

## Public Attributes
uid_t | uid
int | quality
int | networkTransportDelay
int | jitterBufferDelay
int | audioLossRate
int | numChannels
int | receivedSampleRate
int | receivedBitrate
int | totalFrozenTime
int | frozenRate
int | mosValue
uint32_t | frozenRateByCustomPlcCount
uint32_t | plcCount
uint32_t | frozenCntByCustom
uint32_t | frozenTimeByCustom
int | totalActiveTime
int | publishDuration
int | qoeQuality
int | qualityChangedReason
unsigned int | rxAudioBytes
int | e2eDelay

## Constructor & Destructor Documentation

## ◆ RemoteAudioStats()

agora::rtc::RemoteAudioStats::RemoteAudioStats | ( |  | ) |
| inline

## Member Data Documentation

## ◆ uid

uid_t agora::rtc::RemoteAudioStats::uid

The user ID of the remote user.

## ◆ quality

int agora::rtc::RemoteAudioStats::quality

The quality of the audio stream sent by the user. See `QUALITY_TYPE`.

## ◆ networkTransportDelay

int agora::rtc::RemoteAudioStats::networkTransportDelay

The network delay (ms) from the sender to the receiver.

## ◆ jitterBufferDelay

int agora::rtc::RemoteAudioStats::jitterBufferDelay

The network delay (ms) from the audio receiver to the jitter buffer.

Note
  When the receiving end is an audience member and `audienceLatencyLevel` of `ClientRoleOptions` is 1, this parameter does not take effect.

## ◆ audioLossRate

int agora::rtc::RemoteAudioStats::audioLossRate

The frame loss rate (%) of the remote audio stream in the reported interval.

## ◆ numChannels

int agora::rtc::RemoteAudioStats::numChannels

The number of audio channels.

## ◆ receivedSampleRate

int agora::rtc::RemoteAudioStats::receivedSampleRate

The sampling rate of the received audio stream in the reported interval.

## ◆ receivedBitrate

int agora::rtc::RemoteAudioStats::receivedBitrate

The average bitrate (Kbps) of the received audio stream in the reported interval.

## ◆ totalFrozenTime

int agora::rtc::RemoteAudioStats::totalFrozenTime

The total freeze time (ms) of the remote audio stream after the remote user joins the channel. In a session, audio freeze occurs when the audio frame loss rate reaches 4%.

## ◆ frozenRate

int agora::rtc::RemoteAudioStats::frozenRate

The total audio freeze time as a percentage (%) of the total time when the audio is available. The audio is considered available when the remote user neither stops sending the audio stream nor disables the audio module after joining the channel.

## ◆ mosValue

int agora::rtc::RemoteAudioStats::mosValue

The quality of the remote audio stream in the reported interval. The quality is determined by the Agora real-time audio MOS (Mean Opinion Score) measurement method. The return value range is [0, 500]. Dividing the return value by 100 gets the MOS score, which ranges from 0 to 5. The higher the score, the better the audio quality. The subjective perception of audio quality corresponding to the Agora real-time audio MOS scores is as follows:

MOS score | Perception of audio quality
--- | ---
Greater than 4 | Excellent. The audio sounds clear and smooth.
From 3.5 to 4 | Good. The audio has some perceptible impairment but still sounds clear.
From 3 to 3.5 | Fair. The audio freezes occasionally and requires attentive listening.
From 2.5 to 3 | Poor. The audio sounds choppy and requires considerable effort to understand.
From 2 to 2.5 | Bad. The audio has occasional noise. Consecutive audio dropouts occur, resulting in some information loss. The users can communicate only with difficulty.
Less than 2 | Very bad. The audio has persistent noise. Consecutive audio dropouts are frequent, resulting in severe information loss. Communication is nearly impossible.

## ◆ frozenRateByCustomPlcCount

uint32_t agora::rtc::RemoteAudioStats::frozenRateByCustomPlcCount

If the packet loss concealment (PLC) occurs for N consecutive times, freeze is considered as PLC occurring for M consecutive times. freeze cnt = (n_plc - n) / m

## ◆ plcCount

uint32_t agora::rtc::RemoteAudioStats::plcCount

The number of audio packet loss concealment

## ◆ frozenCntByCustom

uint32_t agora::rtc::RemoteAudioStats::frozenCntByCustom

@technical preview The number of times the remote audio stream has experienced freezing.

## ◆ frozenTimeByCustom

uint32_t agora::rtc::RemoteAudioStats::frozenTimeByCustom

@technical preview The total duration (ms) that the remote audio stream has been in a frozen state.

## ◆ totalActiveTime

int agora::rtc::RemoteAudioStats::totalActiveTime

The total active time (ms) between the start of the audio call and the callback of the remote user. The active time refers to the total duration of the remote user without the mute state.

## ◆ publishDuration

int agora::rtc::RemoteAudioStats::publishDuration

The total duration (ms) of the remote audio stream.

## ◆ qoeQuality

int agora::rtc::RemoteAudioStats::qoeQuality

The Quality of Experience (QoE) of the local user when receiving a remote audio stream. See `EXPERIENCE_QUALITY_TYPE`.

## ◆ qualityChangedReason

int agora::rtc::RemoteAudioStats::qualityChangedReason

Reasons why the QoE of the local user when receiving a remote audio stream is poor. See `EXPERIENCE_POOR_REASON`.

## ◆ rxAudioBytes

unsigned int agora::rtc::RemoteAudioStats::rxAudioBytes

The total number of audio bytes received (bytes), inluding the FEC bytes, represented by an aggregate value.

## ◆ e2eDelay

int agora::rtc::RemoteAudioStats::e2eDelay

End-to-end audio delay (in milliseconds), which refers to the time from when the audio is captured by the remote user to when it is played by the local user.