Agora C++ API Reference for All Platforms
agora::rtc::RemoteVideoStats Struct Reference

#include <IAgoraRtcEngine.h>

Public Attributes

uid_t uid
int delay
int width
int height
int receivedBitrate
int decoderOutputFrameRate
int rendererOutputFrameRate
int packetLossRate
int totalFrozenTime
int frozenRate
int totalActiveTime
int publishDuration

Detailed Description

Statistics of the remote video stream.

Member Data Documentation

◆ uid

uid_t agora::rtc::RemoteVideoStats::uid

User ID of the remote user sending the video streams.

◆ delay

int agora::rtc::RemoteVideoStats::delay
Time delay (ms).

In scenarios where audio and video is synchronized, you can use the value of networkTransportDelay and jitterBufferDelay in RemoteAudioStats to know the delay statistics of the remote video.

◆ width

int agora::rtc::RemoteVideoStats::width

Width (pixels) of the video stream.

◆ height

int agora::rtc::RemoteVideoStats::height

Height (pixels) of the video stream.

◆ receivedBitrate

int agora::rtc::RemoteVideoStats::receivedBitrate

Bitrate (Kbps) received since the last count.

◆ decoderOutputFrameRate

int agora::rtc::RemoteVideoStats::decoderOutputFrameRate

The decoder output frame rate (fps) of the remote video.

◆ rendererOutputFrameRate

int agora::rtc::RemoteVideoStats::rendererOutputFrameRate

The render output frame rate (fps) of the remote video.

◆ packetLossRate

int agora::rtc::RemoteVideoStats::packetLossRate

Packet loss rate (%) of the remote video stream after using the anti-packet-loss method.

◆ rxStreamType

REMOTE_VIDEO_STREAM_TYPE agora::rtc::RemoteVideoStats::rxStreamType

The type of the remote video stream: REMOTE_VIDEO_STREAM_TYPE

◆ totalFrozenTime

int agora::rtc::RemoteVideoStats::totalFrozenTime

The total freeze time (ms) of the remote video stream after the remote user joins the channel. In a video session where the frame rate is set to no less than 5 fps, video freeze occurs when the time interval between two adjacent renderable video frames is more than 500 ms.

◆ frozenRate

int agora::rtc::RemoteVideoStats::frozenRate

The total video freeze time as a percentage (%) of the total time when the video is available.

◆ totalActiveTime

int agora::rtc::RemoteVideoStats::totalActiveTime

The total time (ms) when the remote user in the Communication profile or the remote broadcaster in the Live-broadcast profile neither stops sending the video stream nor disables the video module after joining the channel.


◆ publishDuration

int agora::rtc::RemoteVideoStats::publishDuration

The total publish duration (ms) of the remote video stream.