RemoteAudioStats

Audio statistics of the remote user.

export class RemoteAudioStats {

  uid?: number;

  quality?: number;

  networkTransportDelay?: number;

  jitterBufferDelay?: number;

  audioLossRate?: number;

  numChannels?: number;

  receivedSampleRate?: number;

  receivedBitrate?: number;

  totalFrozenTime?: number;

  frozenRate?: number;

  mosValue?: number;

  totalActiveTime?: number;

  publishDuration?: number;

  qoeQuality?: number;

  qualityChangedReason?: number;

  e2eDelay?: number;
}

Properties

uid
User ID of the remote user.
quality
Audio stream quality sent by the remote user. See QualityType.
networkTransportDelay
Network delay from the sender to the receiver (ms).
jitterBufferDelay
Network delay from the receiver to the jitter buffer (ms).
Note: This parameter is not effective when the receiver is an audience member and audienceLatencyLevel in ClientRoleOptions is 1.
audioLossRate
Audio frame loss rate (%) of the remote stream during the reporting interval.
numChannels
Number of audio channels.
receivedSampleRate
Sampling rate of the received remote audio stream during the reporting interval.
receivedBitrate
Average bitrate (Kbps) of the received remote audio stream during the reporting interval.
totalFrozenTime
Total duration (ms) of audio freezes after the remote user joined the channel. An audio freeze is counted when the audio frame loss rate exceeds 4% during a call.
frozenRate
Percentage (%) of total freeze duration over total effective audio duration. Effective duration refers to the time after the remote user joins the channel and the audio is neither stopped nor disabled.
totalActiveTime
Effective duration (ms) from the start of the audio call to this callback. Effective duration excludes the total time the remote user was muted.
publishDuration
Total duration (ms) of the remote audio stream being published.
qoeQuality
Subjective experience quality of the local user when receiving remote audio. See ExperienceQualityType.
qualityChangedReason
Reason for poor subjective experience quality of the local user when receiving remote audio. See ExperiencePoorReason.
mosValue
Quality score of the received remote audio stream during the reporting interval, based on Agora's real-time audio MOS (Mean Opinion Score) evaluation method. The return value ranges from [0,500]. Divide the value by 100 to get the MOS score, which ranges from [0,5]. The higher the score, the better the audio quality. The subjective audio quality corresponding to Agora's real-time MOS score is as follows:
MOS Score Audio Quality
Greater than 4 Excellent audio quality, clear and smooth.
3.5 - 4 Good audio quality, occasional artifacts but still clear.
3 - 3.5 Fair audio quality, occasional stutters, requires some attention to understand.
2.5 - 3 Poor audio quality, frequent stutters, requires concentration to understand.
2 - 2.5 Very poor audio quality, occasional noise, partial loss of meaning, difficult to communicate.
Less than 2 Extremely poor audio quality, frequent noise, significant loss of meaning, communication impossible.
e2eDelay
End-to-end audio delay (ms), i.e., the total time from when the remote user starts audio capture to when the local user starts playback.