AgoraChannelStats Class Reference

Inherits <NSObject>.

Properties
NSUInteger	duration
NSUInteger	txBytes
NSUInteger	rxBytes
NSUInteger	txAudioKBitrate
NSUInteger	rxAudioKBitrate
NSUInteger	txVideoKBitrate
NSUInteger	rxVideoKBitrate
NSUInteger	txAudioBytes
NSUInteger	txVideoBytes
NSUInteger	rxAudioBytes
NSUInteger	rxVideoBytes
NSUInteger	lastmileDelay
NSUInteger	userCount
double	cpuAppUsage
double	cpuTotalUsage
NSInteger	gatewayRtt
double	memoryAppUsageRatio
double	memoryTotalUsageRatio
NSInteger	memoryAppUsageInKbytes
NSInteger	connectTimeMs
NSUInteger	txKBitrate
NSUInteger	rxKBitrate
NSInteger	firstAudioPacketDuration
NSInteger	firstVideoPacketDuration
NSInteger	firstVideoKeyFramePacketDuration
NSInteger	packetsBeforeFirstKeyFramePacket
NSInteger	txPacketLossRate
NSInteger	rxPacketLossRate
NSInteger	lanAccelerateState

Property Documentation

duration

- (NSUInteger) duration

readwritenonatomicassign

Call duration of the local user in seconds, represented by an aggregate value.

txBytes

- (NSUInteger) txBytes

readwritenonatomicassign

The number of bytes sent.

rxBytes

- (NSUInteger) rxBytes

readwritenonatomicassign

The number of bytes received.

txAudioKBitrate

- (NSUInteger) txAudioKBitrate

readwritenonatomicassign

The bitrate (Kbps) of sending the audio packet.

rxAudioKBitrate

- (NSUInteger) rxAudioKBitrate

readwritenonatomicassign

The bitrate (Kbps) of receiving the audio.

txVideoKBitrate

- (NSUInteger) txVideoKBitrate

readwritenonatomicassign

The bitrate (Kbps) of sending the video.

rxVideoKBitrate

- (NSUInteger) rxVideoKBitrate

readwritenonatomicassign

The bitrate (Kbps) of receiving the video.

txAudioBytes

- (NSUInteger) txAudioBytes

readwritenonatomicassign

The total number of audio bytes sent, represented by an aggregate value.

txVideoBytes

- (NSUInteger) txVideoBytes

readwritenonatomicassign

The total number of video bytes sent, represented by an aggregate value.

rxAudioBytes

- (NSUInteger) rxAudioBytes

readwritenonatomicassign

The total number of audio bytes received, represented by an aggregate value.

rxVideoBytes

- (NSUInteger) rxVideoBytes

readwritenonatomicassign

The total number of video bytes received, represented by an aggregate value.

lastmileDelay

- (NSUInteger) lastmileDelay

readwritenonatomicassign

The client-to-server delay (milliseconds).

userCount

- (NSUInteger) userCount

readwritenonatomicassign

The number of users in the channel.

cpuAppUsage

- (double) cpuAppUsage

readwritenonatomicassign

Application CPU usage (%).

Note

- The value of cpuAppUsage is always reported as 0 in the rtcEngine:didLeaveChannelWithStats: callback.

cpuTotalUsage

- (double) cpuTotalUsage

readwritenonatomicassign

The system CPU usage (%).

Note

- The value of cpuTotalUsage is always reported as 0 in the rtcEngine:didLeaveChannelWithStats: callback.

gatewayRtt

- (NSInteger) gatewayRtt

readwritenonatomicassign

The round-trip time delay (ms) from the client to the local router.

Note

This property is disabled on devices running iOS 14 or later, and enabled on devices running versions earlier than iOS 14 by default. To enable this property on devices running iOS 14 or later, technical support.

memoryAppUsageRatio

- (double) memoryAppUsageRatio

readwritenonatomicassign

The memory ratio occupied by the app (%).

Note

This value is for reference only. Due to system limitations, you may not get this value.

memoryTotalUsageRatio

- (double) memoryTotalUsageRatio

readwritenonatomicassign

The memory occupied by the system (%).

Note

This value is for reference only. Due to system limitations, you may not get this value.

memoryAppUsageInKbytes

- (NSInteger) memoryAppUsageInKbytes

readwritenonatomicassign

The memory size occupied by the app (KB).

Note

This value is for reference only. Due to system limitations, you may not get this value.

connectTimeMs

- (NSInteger) connectTimeMs

readwritenonatomicassign

The duration (ms) between the SDK starts connecting and the connection is established. If the value reported is 0, it means invalid.

txKBitrate

- (NSUInteger) txKBitrate

readwritenonatomicassign

The actual bitrate (Kbps) while sending the local video stream.

rxKBitrate

- (NSUInteger) rxKBitrate

readwritenonatomicassign

The receiving bitrate (Kbps).

firstAudioPacketDuration

- (NSInteger) firstAudioPacketDuration

readwritenonatomicassign

The duration(ms) between first audio packet received and connection start, 0 if not valid

firstVideoPacketDuration

- (NSInteger) firstVideoPacketDuration

readwritenonatomicassign

The duration(ms) between first video packet received and connection start, 0 if not valid

firstVideoKeyFramePacketDuration

- (NSInteger) firstVideoKeyFramePacketDuration

readwritenonatomicassign

The duration(ms) between first video key frame received and connection start, 0 if not valid

packetsBeforeFirstKeyFramePacket

- (NSInteger) packetsBeforeFirstKeyFramePacket

readwritenonatomicassign

Video packet number before first video key frame received, 0 if not valid

txPacketLossRate

- (NSInteger) txPacketLossRate

readwritenonatomicassign

The packet loss rate (%) from the client to the Agora server before applying the anti-packet-loss algorithm.

rxPacketLossRate

- (NSInteger) rxPacketLossRate

readwritenonatomicassign

The packet loss rate (%) from the Agora server to the client before using the anti-packet-loss method.

lanAccelerateState

- (NSInteger) lanAccelerateState

readwritenonatomicassign

The local network acceleration state. A value of 1 indicates that local network acceleration is active, while 0 indicates it is inactive. @technical preview