Interface RemoteVideoTrackStats

Statistics of the remote video track, such as connection and transmission statistics, which can be retrieved by calling [AgoraRTCClient.getRemoteVideoStats]IAgoraRTCClient.getRemoteVideoStats.

interface RemoteVideoTrackStats {
    codecType?: "H264" | "H265" | "VP8" | "VP9" | "AV1X" | "AV1";
    currentPacketLossRate: number;
    decodeFrameRate?: number;
    end2EndDelay: number;
    freezeRate: number;
    packetLossRate: number;
    publishDuration: number;
    receiveBitrate: number;
    receiveBytes: number;
    receiveDelay: number;
    receiveFrameRate?: number;
    receivePackets: number;
    receivePacketsLost: number;
    receiveResolutionHeight: number;
    receiveResolutionWidth: number;
    renderFrameRate?: number;
    totalDuration: number;
    totalFreezeTime: number;
    transportDelay: number;
}

Properties

codecType?: "H264" | "H265" | "VP8" | "VP9" | "AV1X" | "AV1"

The video codec.

  • "H264": The video codec is H.264.
  • "VP8": The video codec is VP8.
  • "VP9": The video codec is VP9.
  • "AV1X": Reserved for future use.
  • "AV1": The video codec is AV1.

You can not get this property on Firefox.

currentPacketLossRate: number

The packet loss rate of the received video.

decodeFrameRate?: number

The frame rate (fps) of the decoded video.

end2EndDelay: number

End-to-end delay (ms).

The delay (ms) a remote client capturing the video and the local client playing the video. This delay does not include the time spent in encoding at the remote client and the time spent in decoding at the local client.

freezeRate: number

The freeze rate of the received video.

packetLossRate: number

The packet loss rate of the received video.

publishDuration: number
receiveBitrate: number

The bitrate (bps) of the received video.

receiveBytes: number

The total byes of the received video.

receiveDelay: number

The delay (ms) between a remote client sending the video and the local client playing the video.

This property is inaccurate on Safari and Firefox.

receiveFrameRate?: number

The frame rate (fps) of the received video.

receivePackets: number

The total bytes of the received video.

receivePacketsLost: number

The total number of lost video packets that should be received.

receiveResolutionHeight: number

The resolution height (pixel) of the received video.

receiveResolutionWidth: number

The resolution width (pixel) of the received video.

renderFrameRate?: number

The rendering frame rate (fps) of the decoded video.

totalDuration: number

The total duration of the received video in seconds.

totalFreezeTime: number

The total freeze time of the received video in seconds.

transportDelay: number

Transmission delay (ms).

The delay (ms) between a remote client sending the video and the local client receiving the video.