ZoomVideoSDKQOSRecvStatistics Struct Reference

QOS statistics for inbound media stream (receiving). More...

#include <zoom_video_sdk_user_helper_interface.h>

Inherits ZoomVideoSDKQOSStatistics.

Public Member Functions
	ZoomVideoSDKQOSRecvStatistics ()
void	reset ()
Public Member Functions inherited from ZoomVideoSDKQOSStatistics
	ZoomVideoSDKQOSStatistics ()
void	reset ()

Public Attributes
unsigned long long	bytesReceived
	Total bytes received (receive only).
unsigned int	packetsReceived
	Total number of packets received (receive only).
unsigned int	estimatedPlayoutTimestamp
	Estimated playout timestamp (receive only).
unsigned int	totalDecodeTime
	Total time spent decoding in milliseconds (receive only).
unsigned int	framesDecoded
	Total number of frames decoded (receive only).
double	jitterBufferDelay
	Accumulated playout delay introduced by the jitter buffer, in seconds (receive only).
unsigned long long	jitterBufferEmittedCount
	Total audio samples decoded from RTP packets (receive only).
unsigned long long	headerBytesReceived
	Total bytes of RTP headers (and padding) received (receive only).
unsigned int	packetsDiscarded
	Non-FEC packets discarded by NetEQ (receive only, audio only).
unsigned int	fecPacketsReceived
	Total number of FEC packets received (receive only, audio only).
unsigned int	fecPacketsDiscarded
	FEC packets discarded by NetEQ (receive only, audio only).
double	jitterBufferTargetDelay
	Accumulated current target delay of the jitter buffer, in seconds (receive only, audio only).
double	jitterBufferMinimumDelay
	Accumulated minimum achievable jitter buffer delay, in seconds (receive only, audio only).
unsigned long long	totalSamplesReceived
	Total audio samples generated by NetEQ (receive only, audio only).
unsigned long long	concealedSamples
	Samples produced by concealment instead of real decode (receive only, audio only).
unsigned long long	silentConcealedSamples
	Subset of concealedSamples that are silent (receive only, audio only).
unsigned long long	concealmentEvents
	Number of concealment events (receive only, audio only).
unsigned long long	insertedSamplesForDeceleration
	Samples inserted to slow down playout (deceleration) (receive only, audio only).
unsigned long long	removedSamplesForAcceleration
	Samples removed to speed up playout (acceleration) (receive only, audio only).
double	totalSamplesDuration
	Total duration of all audio samples received, in seconds (receive only, audio only).
double	audioLevel
	Most recent audio level of the received stream, range [0.0, 1.0] (receive only, audio only).
double	totalAudioEnergy
	Accumulated audio energy (receive only, audio only).
Public Attributes inherited from ZoomVideoSDKQOSStatistics
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.
double	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

QOS statistics for inbound media stream (receiving).

Note

Inherits common fields from ZoomVideoSDKQOSStatistics; adds receive-specific properties.

Definition at line 250 of file zoom_video_sdk_user_helper_interface.h.

Constructor & Destructor Documentation

ZoomVideoSDKQOSRecvStatistics()

ZoomVideoSDKQOSRecvStatistics::ZoomVideoSDKQOSRecvStatistics ( )

inline

Definition at line 341 of file zoom_video_sdk_user_helper_interface.h.

    {
        ZoomVideoSDKQOSStatistics::direction = ZoomVideoSDKStatisticsDirection_Receive;
        reset();
    }

References ZoomVideoSDKQOSStatistics::direction, reset(), and ZoomVideoSDKStatisticsDirection_Receive.

Member Function Documentation

reset()

void ZoomVideoSDKQOSRecvStatistics::reset ( )

inline

Definition at line 347 of file zoom_video_sdk_user_helper_interface.h.

    {
        ZoomVideoSDKQOSStatistics::reset();
        direction = ZoomVideoSDKStatisticsDirection_Receive;
        bytesReceived = 0;
        packetsReceived = 0;
        estimatedPlayoutTimestamp = 0;
        totalDecodeTime = 0;
        framesDecoded = 0;
        jitterBufferDelay = 0.0;
        jitterBufferEmittedCount = 0;
        headerBytesReceived = 0;
        packetsDiscarded = 0;
        fecPacketsReceived = 0;
        fecPacketsDiscarded = 0;
        jitterBufferTargetDelay = 0.0;
        jitterBufferMinimumDelay = 0.0;
        totalSamplesReceived = 0;
        concealedSamples = 0;
        silentConcealedSamples = 0;
        concealmentEvents = 0;
        insertedSamplesForDeceleration = 0;
        removedSamplesForAcceleration = 0;
        totalSamplesDuration = 0.0;
        audioLevel = 0.0;
        totalAudioEnergy = 0.0;
    }

References audioLevel, bytesReceived, concealedSamples, concealmentEvents, ZoomVideoSDKQOSStatistics::direction, estimatedPlayoutTimestamp, fecPacketsDiscarded, fecPacketsReceived, framesDecoded, headerBytesReceived, insertedSamplesForDeceleration, jitterBufferDelay, jitterBufferEmittedCount, jitterBufferMinimumDelay, jitterBufferTargetDelay, packetsDiscarded, packetsReceived, removedSamplesForAcceleration, ZoomVideoSDKQOSStatistics::reset(), silentConcealedSamples, totalAudioEnergy, totalDecodeTime, totalSamplesDuration, totalSamplesReceived, and ZoomVideoSDKStatisticsDirection_Receive.

Referenced by ZoomVideoSDKQOSRecvStatistics().

Member Data Documentation

audioLevel

double ZoomVideoSDKQOSRecvStatistics::audioLevel

Most recent audio level of the received stream, range [0.0, 1.0] (receive only, audio only).

Definition at line 335 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

bytesReceived

unsigned long long ZoomVideoSDKQOSRecvStatistics::bytesReceived

Total bytes received (receive only).

Definition at line 255 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

concealedSamples

unsigned long long ZoomVideoSDKQOSRecvStatistics::concealedSamples

Samples produced by concealment instead of real decode (receive only, audio only).

Definition at line 311 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

concealmentEvents

unsigned long long ZoomVideoSDKQOSRecvStatistics::concealmentEvents

Number of concealment events (receive only, audio only).

Definition at line 319 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

estimatedPlayoutTimestamp

unsigned int ZoomVideoSDKQOSRecvStatistics::estimatedPlayoutTimestamp

Estimated playout timestamp (receive only).

Definition at line 263 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

fecPacketsDiscarded

unsigned int ZoomVideoSDKQOSRecvStatistics::fecPacketsDiscarded

FEC packets discarded by NetEQ (receive only, audio only).

Definition at line 295 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

fecPacketsReceived

unsigned int ZoomVideoSDKQOSRecvStatistics::fecPacketsReceived

Total number of FEC packets received (receive only, audio only).

Definition at line 291 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

framesDecoded

unsigned int ZoomVideoSDKQOSRecvStatistics::framesDecoded

Total number of frames decoded (receive only).

Definition at line 271 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

headerBytesReceived

unsigned long long ZoomVideoSDKQOSRecvStatistics::headerBytesReceived

Total bytes of RTP headers (and padding) received (receive only).

Definition at line 283 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

insertedSamplesForDeceleration

unsigned long long ZoomVideoSDKQOSRecvStatistics::insertedSamplesForDeceleration

Samples inserted to slow down playout (deceleration) (receive only, audio only).

Definition at line 323 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

jitterBufferDelay

double ZoomVideoSDKQOSRecvStatistics::jitterBufferDelay

Accumulated playout delay introduced by the jitter buffer, in seconds (receive only).

Definition at line 275 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

jitterBufferEmittedCount

unsigned long long ZoomVideoSDKQOSRecvStatistics::jitterBufferEmittedCount

Total audio samples decoded from RTP packets (receive only).

Definition at line 279 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

jitterBufferMinimumDelay

double ZoomVideoSDKQOSRecvStatistics::jitterBufferMinimumDelay

Accumulated minimum achievable jitter buffer delay, in seconds (receive only, audio only).

Definition at line 303 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

jitterBufferTargetDelay

double ZoomVideoSDKQOSRecvStatistics::jitterBufferTargetDelay

Accumulated current target delay of the jitter buffer, in seconds (receive only, audio only).

Definition at line 299 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

packetsDiscarded

unsigned int ZoomVideoSDKQOSRecvStatistics::packetsDiscarded

Non-FEC packets discarded by NetEQ (receive only, audio only).

Definition at line 287 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

packetsReceived

unsigned int ZoomVideoSDKQOSRecvStatistics::packetsReceived

Total number of packets received (receive only).

Definition at line 259 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

removedSamplesForAcceleration

unsigned long long ZoomVideoSDKQOSRecvStatistics::removedSamplesForAcceleration

Samples removed to speed up playout (acceleration) (receive only, audio only).

Definition at line 327 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

silentConcealedSamples

unsigned long long ZoomVideoSDKQOSRecvStatistics::silentConcealedSamples

Subset of concealedSamples that are silent (receive only, audio only).

Definition at line 315 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

totalAudioEnergy

double ZoomVideoSDKQOSRecvStatistics::totalAudioEnergy

Accumulated audio energy (receive only, audio only).

Definition at line 339 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

totalDecodeTime

unsigned int ZoomVideoSDKQOSRecvStatistics::totalDecodeTime

Total time spent decoding in milliseconds (receive only).

Definition at line 267 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

totalSamplesDuration

double ZoomVideoSDKQOSRecvStatistics::totalSamplesDuration

Total duration of all audio samples received, in seconds (receive only, audio only).

Definition at line 331 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().

totalSamplesReceived

unsigned long long ZoomVideoSDKQOSRecvStatistics::totalSamplesReceived

Total audio samples generated by NetEQ (receive only, audio only).

Definition at line 307 of file zoom_video_sdk_user_helper_interface.h.

Referenced by reset().