Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKQOSStatistics Class Reference

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

#include <ZMVideoSDKUserHelper.h>

Inherits NSObject.

Inherited by ZMVideoSDKQOSRecvStatistics, ZMVideoSDKQOSSendStatistics, ZMVideoSDKShareStatisticInfo, and ZMVideoSDKVideoStatisticInfo.

Properties

ZMVideoSDKStatisticsDirection direction
 Gets the direction of statistics (send or receive).
NSInteger timestamp
 Gets the timestamp of the statistics.
NSString *_Nullable codecName
 Gets the name of the codec. For video/share: "h264", "av1". For audio: "silk", "opus", "pcm", "G722", "G729". Valid only during callback execution.
NSInteger rtt
 Gets the round-trip time in milliseconds.
NSInteger jitter
 Gets the jitter in milliseconds.
NSInteger width
 Frame width (sent or received per direction).
NSInteger height
 Frame height (sent or received per direction).
NSInteger fps
 Frame rate in FPS (sent or received per direction).
NSInteger bps
 Gets the bits per second.
NSInteger bytesTransferred
 Gets the total bytes transferred (sent or received per direction).
NSInteger packetsLost
 Gets the number of packets lost during transmission.
NSInteger packetsTransferred
 Gets the total number of packets transferred (sent or received per direction).
ZMVideoSDKNetworkStatus networkLevel
 Gets the network quality level.
ZMVideoSDKDataType statisticsType
 Gets the statistics type (Audio, Video, or Share).
NSInteger avg_loss
 Gets the average packet loss ratio in per thousand (e.g. 100 means 10%).
NSInteger max_loss
 Gets the maximum packet loss ratio in per thousand (e.g. 100 means 10%).
NSInteger bandwidth
 Gets the estimated bandwidth in bps.

Detailed Description

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

Note
Common fields only; Send/Receive-specific fields are in ZMVideoSDKQOSSendStatistics and ZMVideoSDKQOSRecvStatistics.

Definition at line 57 of file ZMVideoSDKUserHelper.h.

Property Documentation

◆ avg_loss

- (NSInteger) avg_loss
readnonatomicassign

Gets the average packet loss ratio in per thousand (e.g. 100 means 10%).

Definition at line 132 of file ZMVideoSDKUserHelper.h.

◆ bandwidth

- (NSInteger) bandwidth
readnonatomicassign

Gets the estimated bandwidth in bps.

Definition at line 142 of file ZMVideoSDKUserHelper.h.

◆ bps

- (NSInteger) bps
readnonatomicassign

Gets the bits per second.

Definition at line 102 of file ZMVideoSDKUserHelper.h.

◆ bytesTransferred

- (NSInteger) bytesTransferred
readnonatomicassign

Gets the total bytes transferred (sent or received per direction).

Definition at line 107 of file ZMVideoSDKUserHelper.h.

◆ codecName

- (NSString* _Nullable) codecName
readnonatomiccopy

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

Definition at line 72 of file ZMVideoSDKUserHelper.h.

◆ direction

- (ZMVideoSDKStatisticsDirection) direction
readnonatomicassign

Gets the direction of statistics (send or receive).

Definition at line 62 of file ZMVideoSDKUserHelper.h.

◆ fps

- (NSInteger) fps
readnonatomicassign

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

Definition at line 97 of file ZMVideoSDKUserHelper.h.

◆ height

- (NSInteger) height
readnonatomicassign

Frame height (sent or received per direction).

Definition at line 92 of file ZMVideoSDKUserHelper.h.

◆ jitter

- (NSInteger) jitter
readnonatomicassign

Gets the jitter in milliseconds.

Definition at line 82 of file ZMVideoSDKUserHelper.h.

◆ max_loss

- (NSInteger) max_loss
readnonatomicassign

Gets the maximum packet loss ratio in per thousand (e.g. 100 means 10%).

Definition at line 137 of file ZMVideoSDKUserHelper.h.

◆ networkLevel

- (ZMVideoSDKNetworkStatus) networkLevel
readnonatomicassign

Gets the network quality level.

Definition at line 122 of file ZMVideoSDKUserHelper.h.

◆ packetsLost

- (NSInteger) packetsLost
readnonatomicassign

Gets the number of packets lost during transmission.

Definition at line 112 of file ZMVideoSDKUserHelper.h.

◆ packetsTransferred

- (NSInteger) packetsTransferred
readnonatomicassign

Gets the total number of packets transferred (sent or received per direction).

Definition at line 117 of file ZMVideoSDKUserHelper.h.

◆ rtt

- (NSInteger) rtt
readnonatomicassign

Gets the round-trip time in milliseconds.

Definition at line 77 of file ZMVideoSDKUserHelper.h.

◆ statisticsType

- (ZMVideoSDKDataType) statisticsType
readnonatomicassign

Gets the statistics type (Audio, Video, or Share).

Definition at line 127 of file ZMVideoSDKUserHelper.h.

◆ timestamp

- (NSInteger) timestamp
readnonatomicassign

Gets the timestamp of the statistics.

Definition at line 67 of file ZMVideoSDKUserHelper.h.

◆ width

- (NSInteger) width
readnonatomicassign

Frame width (sent or received per direction).

Definition at line 87 of file ZMVideoSDKUserHelper.h.