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 specifying whose video stream it is.
delay
Delay (ms).
Note: Deprecated: In audio-video scenarios with audio-video sync, refer to networkTransportDelay and jitterBufferDelay in RemoteAudioStats to understand video delay data.
e2eDelay
End-to-end video delay (ms). That is, the total time from when the remote user starts video capture to when the local user receives and renders the video.
width
Width of the video stream (pixels).
height
Height of the video stream (pixels).
receivedBitrate
Bitrate (Kbps) received since the last report.
decoderOutputFrameRate
Frame rate output by the remote video decoder, in fps.
rendererOutputFrameRate
Frame rate output by the remote video renderer, in fps.
frameLossRate
Packet loss rate (%) of the remote video.
packetLossRate
Packet loss rate (%) of the remote video after applying anti-packet-loss techniques.
rxStreamType
Video stream type: high or low. See VideoStreamType.
totalFrozenTime
Total duration (ms) of video freezes after the remote user joined the channel. During the call, if the video frame rate is not lower 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 freeze duration over total effective video duration after the remote user joined the channel. Effective duration refers to the time after the remote user joins the channel and the video is neither stopped nor disabled.
totalActiveTime
Effective video duration (ms). Total effective video duration refers to the time after the remote user or host joins the channel and neither stops sending the video stream nor disables the video module.
publishDuration
Total duration (ms) of the remote video stream being published.
avSyncTimeMs
Time (ms) by which audio leads video.
Note: If negative, it indicates that audio lags behind video.
mosValue
Quality of the remote audio stream during the reporting interval. This quality is determined by Agora's real-time audio MOS (Mean Opinion Score) evaluation method. The return value ranges from [0, 500]; divide by 100 to get the MOS score, ranging from 0 to 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:
  • 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, not very smooth, 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.