Agora RTC Objective-C API Reference  Refactor
Properties
AgoraRtcRemoteVideoStats Class Reference

Inherits <NSObject>.

Properties

NSUInteger uid
 
NSUInteger delay
 
NSUInteger width
 
NSUInteger height
 
NSUInteger receivedBitrate
 
NSUInteger receivedFrameRate
 
AgoraVideoStreamType rxStreamType
 
NSInteger decoderOutputFrameRate
 
NSInteger rendererOutputFrameRate
 
NSInteger frameLossRate
 
NSInteger packetLossRate
 
NSInteger totalFrozenTime
 
NSUInteger totalActiveTime
 
NSInteger publishDuration
 
NSInteger frozenRate
 
NSInteger avSyncTimeMs
 
NSInteger mosValue
 

Detailed Description

Statistics of the remote video stream.

Property Documentation

◆ uid

- (NSUInteger) uid
readwritenonatomicassign

ID of the remote user sending the video stream.

◆ delay

- (NSUInteger) delay
readwritenonatomicassign

Time delay (ms).

◆ width

- (NSUInteger) width
readwritenonatomicassign

Width (pixels) of the video stream.

◆ height

- (NSUInteger) height
readwritenonatomicassign

Height (pixels) of the video stream.

◆ receivedBitrate

- (NSUInteger) receivedBitrate
readwritenonatomicassign

Data receive bitrate (Kbps) since last count.

◆ receivedFrameRate

- (NSUInteger) receivedFrameRate
readwritenonatomicassign

Data receive frame rate (fps) since last count.

◆ rxStreamType

- (AgoraVideoStreamType) rxStreamType
readwritenonatomicassign

Video stream type; high- or low-video stream.

◆ decoderOutputFrameRate

- (NSInteger) decoderOutputFrameRate
readwritenonatomicassign

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

◆ rendererOutputFrameRate

- (NSInteger) rendererOutputFrameRate
readwritenonatomicassign

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

◆ frameLossRate

- (NSInteger) frameLossRate
readwritenonatomicassign

The video frame loss rate (%) of the remote video stream in the reported interval.

◆ packetLossRate

- (NSInteger) packetLossRate
readwritenonatomicassign

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

◆ totalFrozenTime

- (NSInteger) totalFrozenTime
readwritenonatomicassign

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.

◆ totalActiveTime

- (NSUInteger) totalActiveTime
readwritenonatomicassign

The total time (ms) when the remote user neither stops sending the audio stream nor disables the audio module after joining the channel.

◆ publishDuration

- (NSInteger) publishDuration
readwritenonatomicassign

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

◆ frozenRate

- (NSInteger) frozenRate
readwritenonatomicassign

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

◆ avSyncTimeMs

- (NSInteger) avSyncTimeMs
readwritenonatomicassign

The offset (ms) between audio and video stream. A positive value indicates the audio leads the video, and a negative value indicates the audio lags the video.

◆ mosValue

- (NSInteger) mosValue
readwritenonatomicassign

The quality of the remote video stream in the reported interval. The quality is determined by the Agora real-time video MOS (Mean Opinion Score) measurement method. The return value range is [0, 500]. Dividing the return value by 100 gets the MOS score, which ranges from 0 to 5. The higher the score, the better the video quality.

Note
For textured video data, this parameter always returns 0.