ZoomVideoSDKQOSStatistics Struct Reference

Base QOS statistics for media streams (Audio, Video, Share). More...

#include <zoom_video_sdk_user_helper_interface.h>

Inherited by ZoomVideoSDKQOSRecvStatistics, ZoomVideoSDKQOSSendStatistics, ZoomVideoSDKShareStatisticInfo, and ZoomVideoSDKVideoStatisticInfo.

Public Member Functions
	ZoomVideoSDKQOSStatistics ()
void	reset ()

Public Attributes
ZoomVideoSDKStatisticsDirection	direction
	Direction of statistics (send or receive).
unsigned int	timestamp
	Timestamp of the statistics.
const zchar_t *	codecName
	Name of the codec. Valid only during callback. For video/share: "h264", "av1". For audio: "silk", "opus", "pcm", "G722", "G729".
unsigned int	rtt
	Round-trip time in milliseconds.
unsigned int	jitter
	Jitter in milliseconds.
unsigned int	width
	Frame width (sent or received per direction).
unsigned int	height
	Frame height (sent or received per direction).
unsigned int	fps
	Frame rate in FPS (sent or received per direction).
unsigned int	bps
	Bits per second.
int	bpf
	Bits per frame. Same as bps for backward compatibility.
unsigned int	bytesTransferred
	Total bytes transferred (sent or received per direction).
unsigned int	packetsLost
	Number of packets lost during transmission.
unsigned int	packetsTransferred
	Total number of packets transferred (sent or received per direction).
ZoomVideoSDKNetworkStatus	networkLevel
	Network quality level.
ZoomVideoSDKDataType	statisticsType
	Statistics type (Audio, Video, or Share).
unsigned int	avg_loss
	Average packet loss ratio in per thousand (e.g. 100 means 10%).
unsigned int	max_loss
	Maximum packet loss ratio in per thousand (e.g. 100 means 10%).
unsigned int	bandwidth
	Estimated bandwidth in bps.

Detailed Description

Base QOS statistics for media streams (Audio, Video, Share).

Note

Unifies common fields; Send/Receive-specific data are in ZoomVideoSDKQOSSendStatistics and ZoomVideoSDKQOSRecvStatistics.

codecName is valid only during the callback that provides this struct; do not store or use it after the callback returns.

Definition at line 77 of file zoom_video_sdk_user_helper_interface.h.

Constructor & Destructor Documentation

ZoomVideoSDKQOSStatistics()

ZoomVideoSDKQOSStatistics::ZoomVideoSDKQOSStatistics ( )

inline

Definition at line 153 of file zoom_video_sdk_user_helper_interface.h.

    {
        reset();
    }

References reset().

Member Function Documentation

reset()

void ZoomVideoSDKQOSStatistics::reset ( )

inline

Definition at line 158 of file zoom_video_sdk_user_helper_interface.h.

    {
        direction = ZoomVideoSDKStatisticsDirection_Send;
        timestamp = 0;
        codecName = nullptr;
        rtt = 0;
        jitter = 0;
        width = 0;
        height = 0;
        fps = 0;
        bps = 0;
        bpf = 0;
        bytesTransferred = 0;
        packetsLost = 0;
        packetsTransferred = 0;
        networkLevel = ZoomVideoSDKNetwork_None;
        statisticsType = ZoomVideoSDKDataType_Unknown;
        avg_loss = 0;
        max_loss = 0;
        bandwidth = 0;
    }

References avg_loss, bandwidth, bpf, bps, bytesTransferred, codecName, direction, fps, height, jitter, max_loss, networkLevel, packetsLost, packetsTransferred, rtt, statisticsType, timestamp, width, ZoomVideoSDKDataType_Unknown, ZoomVideoSDKNetwork_None, and ZoomVideoSDKStatisticsDirection_Send.

Referenced by ZoomVideoSDKQOSRecvStatistics::reset(), ZoomVideoSDKQOSSendStatistics::reset(), ZoomVideoSDKShareStatisticInfo::reset(), ZoomVideoSDKVideoStatisticInfo::reset(), and ZoomVideoSDKQOSStatistics().

Member Data Documentation

avg_loss

unsigned int ZoomVideoSDKQOSStatistics::avg_loss

Average packet loss ratio in per thousand (e.g. 100 means 10%).

Definition at line 143 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

bandwidth

unsigned int ZoomVideoSDKQOSStatistics::bandwidth

Estimated bandwidth in bps.

Definition at line 151 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

bpf

int ZoomVideoSDKQOSStatistics::bpf

Bits per frame. Same as bps for backward compatibility.

Deprecated

Use ZoomVideoSDKQOSStatistics::bps instead.

Definition at line 119 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

bps

unsigned int ZoomVideoSDKQOSStatistics::bps

Bits per second.

Definition at line 114 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

bytesTransferred

unsigned int ZoomVideoSDKQOSStatistics::bytesTransferred

Total bytes transferred (sent or received per direction).

Definition at line 123 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

codecName

const zchar_t* ZoomVideoSDKQOSStatistics::codecName

Name of the codec. Valid only during callback. For video/share: "h264", "av1". For audio: "silk", "opus", "pcm", "G722", "G729".

Definition at line 90 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

direction

ZoomVideoSDKStatisticsDirection ZoomVideoSDKQOSStatistics::direction

Direction of statistics (send or receive).

Definition at line 82 of file zoom_video_sdk_user_helper_interface.h.

Referenced by ZoomVideoSDKQOSRecvStatistics::reset(), ZoomVideoSDKQOSSendStatistics::reset(), reset(), ZoomVideoSDKQOSRecvStatistics::ZoomVideoSDKQOSRecvStatistics(), and ZoomVideoSDKQOSSendStatistics::ZoomVideoSDKQOSSendStatistics().

fps

unsigned int ZoomVideoSDKQOSStatistics::fps

Frame rate in FPS (sent or received per direction).

Definition at line 110 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

height

unsigned int ZoomVideoSDKQOSStatistics::height

Frame height (sent or received per direction).

Definition at line 106 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

jitter

unsigned int ZoomVideoSDKQOSStatistics::jitter

Jitter in milliseconds.

Definition at line 98 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

max_loss

unsigned int ZoomVideoSDKQOSStatistics::max_loss

Maximum packet loss ratio in per thousand (e.g. 100 means 10%).

Definition at line 147 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

networkLevel

ZoomVideoSDKNetworkStatus ZoomVideoSDKQOSStatistics::networkLevel

Network quality level.

Definition at line 135 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

packetsLost

unsigned int ZoomVideoSDKQOSStatistics::packetsLost

Number of packets lost during transmission.

Definition at line 127 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

packetsTransferred

unsigned int ZoomVideoSDKQOSStatistics::packetsTransferred

Total number of packets transferred (sent or received per direction).

Definition at line 131 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

rtt

unsigned int ZoomVideoSDKQOSStatistics::rtt

Round-trip time in milliseconds.

Definition at line 94 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

statisticsType

ZoomVideoSDKDataType ZoomVideoSDKQOSStatistics::statisticsType

Statistics type (Audio, Video, or Share).

Definition at line 139 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

timestamp

unsigned int ZoomVideoSDKQOSStatistics::timestamp

Timestamp of the statistics.

Definition at line 86 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

width

unsigned int ZoomVideoSDKQOSStatistics::width

Frame width (sent or received per direction).

Definition at line 102 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().