Class RemoteAudioStats

Audio statistics of the remote user.

Hierarchy

  • RemoteAudioStats

Constructors

Properties

audioLossRate?: number

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

e2eDelay?: number

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.

frozenRate?: number

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.

jitterBufferDelay?: number

The network delay (ms) from the audio receiver to the jitter buffer. When the receiving end is an audience member and audienceLatencyLevel of ClientRoleOptions is 1, this parameter does not take effect.

mosValue?: number

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.

networkTransportDelay?: number

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

numChannels?: number

The number of audio channels.

publishDuration?: number

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

qoeQuality?: number

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

quality?: number

The quality of the audio stream sent by the user. See QualityType.

qualityChangedReason?: number

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

receivedBitrate?: number

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

receivedSampleRate?: number

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

totalActiveTime?: number

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.

totalFrozenTime?: number

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%.

uid?: number

The user ID of the remote user.

Generated using TypeDoc