io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats Class Reference

Public Attributes
int	uid
int	quality
int	networkTransportDelay
int	jitterBufferDelay
int	audioLossRate
int	numChannels
int	receivedSampleRate
int	receivedBitrate
int	totalFrozenTime
int	frozenRate
int	totalActiveTime
int	publishDuration
int	qoeQuality
int	qualityChangedReason
int	mosValue

Detailed Description

Statistics of the remote audio.

Member Data Documentation

uid

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.uid

User ID of the user sending the audio streams.

quality

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.quality

Audio quality received by the user:

• QUALITY_UNKNOWN(0): The quality is unknown.
• QUALITY_EXCELLENT(1): The quality is excellent.
• QUALITY_GOOD(2): The quality is quite good, but the bitrate may be slightly lower than excellent.
• QUALITY_POOR(3): Users can feel the communication slightly impaired.
• QUALITY_BAD(4): Users can communicate not very smoothly.
• QUALITY_VBAD(5): The quality is so bad that users can barely communicate.
• QUALITY_DOWN(6): The network is disconnected and users cannot communicate at all.
• QUALITY_DETECTING(8): The SDK is detecting the network quality.

networkTransportDelay

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.networkTransportDelay

Network delay (ms) from the sender to the receiver.

jitterBufferDelay

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.jitterBufferDelay

Network delay (ms) from the receiver to the jitter buffer.

Note

When the receiver is an audience member and audienceLatencyLevel is 1, this parameter does not take effect.

audioLossRate

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.audioLossRate

Packet loss rate in the reported interval.

numChannels

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.numChannels

The number of channels.

Since

v2.8.0.

receivedSampleRate

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.receivedSampleRate

The sample rate (Hz) of the received audio stream in the reported interval.

Since

v2.8.0.

receivedBitrate

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.receivedBitrate

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

Since

v2.8.0.

totalFrozenTime

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.totalFrozenTime

The total freeze time (ms) of the remote audio stream after the remote user joins the channel.

In the reported interval, audio freeze occurs when the audio frame loss rate reaches 4%.

Since

v2.8.0.

frozenRate

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.frozenRate

The total audio freeze time as a percentage (%) of the total time when the audio is available.

Since

v2.8.0.

totalActiveTime

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.totalActiveTime

The total active time (ms) of the remote audio stream after the remote user joins the channel.

Since

v3.0.0.

publishDuration

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.publishDuration

The total active time (ms) of the remote audio stream after the remote user publish the audio stream.

Since

v3.1.0.

qoeQuality

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.qoeQuality

Quality of experience (QoE) of the local user when receiving a remote audio stream.

Since

v3.3.0.

• EXPERIENCE_QUALITY_GOOD(0)
• EXPERIENCE_QUALITY_BAD(1)

qualityChangedReason

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.qualityChangedReason

The reason for poor QoE of the local user when receiving a remote audio stream.

Since

v3.3.0.

• EXPERIENCE_REASON_NONE(0)
• REMOTE_NETWORK_QUALITY_POOR(1)
• LOCAL_NETWORK_QUALITY_POOR(2)
• WIRELESS_SIGNAL_POOR(4)
• WIFI_BLUETOOTH_COEXIST(8)

mosValue

int io.agora.rtc.IRtcEngineEventHandler.RemoteAudioStats.mosValue

The quality of the remote audio stream as determined by the Agora real-time audio MOS (Mean Opinion Score) measurement method in the reported interval. The return value ranges from 0 to 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.

Since

v3.3.1.

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.