RemoteVideoStats

Statistics of the remote video stream.

export class RemoteVideoStats {

  uid?: number;

  delay?: number;

  e2eDelay?: number;

  width?: number;

  height?: number;

  receivedBitrate?: number;

  decoderOutputFrameRate?: number;

  rendererOutputFrameRate?: number;

  frameLossRate?: number;

  packetLossRate?: number;

  rxStreamType?: VideoStreamType;

  totalFrozenTime?: number;

  frozenRate?: number;

  avSyncTimeMs?: number;

  totalActiveTime?: number;

  publishDuration?: number;

  mosValue?: number;
}

Properties

uid
User ID identifying which user's video stream it is.
delay
Delay (ms).
Note: Deprecated: In audio-video scenarios with A/V sync, you can refer to the networkTransportDelay and jitterBufferDelay members in RemoteAudioStats for video delay data.
e2eDelay
End-to-end video delay (ms). That is, the total time from when the remote user captures the video to when the local user receives and renders it.
width
Width of the video stream (pixels).
height
Height of the video stream (pixels).
receivedBitrate
Bitrate (Kbps) received since the last report.
decoderOutputFrameRate
Output frame rate of the remote video decoder, in fps.
rendererOutputFrameRate
Output frame rate of the remote video renderer, in fps.
frameLossRate
Remote video frame loss rate (%).
packetLossRate
Remote video packet loss rate (%) after applying anti-packet-loss techniques.
rxStreamType
Video stream type: high or low stream. See VideoStreamType.
totalFrozenTime
Total duration (ms) of video freeze experienced by the remote user after joining the channel. During the call, if the video frame rate is set to no less than 5 fps and the interval between two consecutive rendered frames exceeds 500 ms, it is counted as a video freeze.
frozenRate
Percentage (%) of total frozen time over the total effective video duration after the remote user joins the channel. The effective duration refers to the time when the video is neither stopped nor disabled.
totalActiveTime
Effective video duration (ms). The total effective video duration is the time after the remote user or host joins the channel without stopping the video stream or disabling the video module.
publishDuration
Total duration (ms) the remote video stream was published.
avSyncTimeMs
Time (ms) by which audio leads video.
Note: If the value is negative, it indicates that audio lags behind video.
mosValue
Quality of the remote audio stream during the reporting interval. This quality is measured using Agora's real-time audio MOS (Mean Opinion Score) method. The return value ranges from [0, 500]; divide by 100 to get the MOS score, which ranges from 0 to 5. Higher scores indicate better audio quality. The subjective audio quality corresponding to Agora's real-time audio MOS score is as follows:
  • Greater than 4: Excellent audio quality, clear and smooth.
  • 3.5 - 4: Good audio quality, occasional artifacts, still clear.
  • 3 - 3.5: Average audio quality, occasional stutters, not very smooth, requires some effort 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.