AgoraChannelStats Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

Statistics of the channel

  duration

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

@property (assign, nonatomic) NSInteger duration

Declared In

AgoraObjects.h

  txBytes

Total number of bytes transmitted, represented by an aggregate value.

@property (assign, nonatomic) NSInteger txBytes

Declared In

AgoraObjects.h

  rxBytes

Total number of bytes received, represented by an aggregate value.

@property (assign, nonatomic) NSInteger rxBytes

Declared In

AgoraObjects.h

  txAudioBytes

Total number of audio bytes sent (bytes), represented by an aggregate value.

@property (assign, nonatomic) NSInteger txAudioBytes

Declared In

AgoraObjects.h

  txVideoBytes

Total number of video bytes sent (bytes), represented by an aggregate value.

@property (assign, nonatomic) NSInteger txVideoBytes

Declared In

AgoraObjects.h

  rxAudioBytes

Total number of audio bytes received (bytes), represented by an aggregate value.

@property (assign, nonatomic) NSInteger rxAudioBytes

Declared In

AgoraObjects.h

  rxVideoBytes

Total number of video bytes received (bytes), represented by an aggregate value.

@property (assign, nonatomic) NSInteger rxVideoBytes

Declared In

AgoraObjects.h

  txKBitrate

Total packet transmission bitrate (Kbps), represented by an instantaneous value.

@property (assign, nonatomic) NSInteger txKBitrate

Declared In

AgoraObjects.h

  rxKBitrate

Total receive bitrate (Kbps), represented by an instantaneous value.

@property (assign, nonatomic) NSInteger rxKBitrate

Declared In

AgoraObjects.h

  txAudioKBitrate

Audio packet transmission bitrate (Kbps), represented by an instantaneous value.

@property (assign, nonatomic) NSInteger txAudioKBitrate

Declared In

AgoraObjects.h

  rxAudioKBitrate

Audio receive bitrate (Kbps), represented by an instantaneous value.

@property (assign, nonatomic) NSInteger rxAudioKBitrate

Declared In

AgoraObjects.h

  txVideoKBitrate

Video transmission bitrate (Kbps), represented by an instantaneous value.

@property (assign, nonatomic) NSInteger txVideoKBitrate

Declared In

AgoraObjects.h

  rxVideoKBitrate

Video receive bitrate (Kbps), represented by an instantaneous value.

@property (assign, nonatomic) NSInteger rxVideoKBitrate

Declared In

AgoraObjects.h

  lastmileDelay

Client-server latency (ms)

@property (assign, nonatomic) NSInteger lastmileDelay

Declared In

AgoraObjects.h

  txPacketLossRate

The packet loss rate (%) from the local client to Agora’s edge server, before using the anti-packet-loss method.

@property (assign, nonatomic) NSInteger txPacketLossRate

Declared In

AgoraObjects.h

  rxPacketLossRate

The packet loss rate (%) from Agora’s edge server to the local client, before using the anti-packet-loss method.

@property (assign, nonatomic) NSInteger rxPacketLossRate

Declared In

AgoraObjects.h

  userCount

Number of users in the channel.

@property (assign, nonatomic) NSInteger userCount

Discussion

  • Communication profile: The number of users in the channel.
  • Interactive live streaming profile:

    • If the local user is an audience: The number of users in the channel = The number of hosts in the channel + 1.
    • If the user is a host: The number of users in the channel = The number of hosts in the channel.

Declared In

AgoraObjects.h

  cpuAppUsage

Application CPU usage (%).

@property (assign, nonatomic) double cpuAppUsage

Discussion

This property reported in the didLeaveChannelWithStats callback is always 0.

Declared In

AgoraObjects.h

  cpuTotalUsage

System CPU usage (%).

@property (assign, nonatomic) double cpuTotalUsage

Discussion

This property reported in the didLeaveChannelWithStats callback is always 0.

Declared In

AgoraObjects.h

  gatewayRtt

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

@property (assign, nonatomic) NSInteger gatewayRtt

Discussion

Note: (iOS only) As of v3.3.0, 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, contact support@agora.io. See FAQ for details.

Declared In

AgoraObjects.h

  memoryAppUsageRatio

The memory usage ratio of the app (%).

@property (assign, nonatomic) double memoryAppUsageRatio

Discussion

Note: This value is for reference only. Due to system limitations, you may not get the value of this member.

Declared In

AgoraObjects.h

  memoryTotalUsageRatio

The memory usage ratio of the system (%).

@property (assign, nonatomic) double memoryTotalUsageRatio

Discussion

Note: This value is for reference only. Due to system limitations, you may not get the value of this member.

Declared In

AgoraObjects.h

  memoryAppUsageInKbytes

The memory usage of the app (KB).

@property (assign, nonatomic) NSInteger memoryAppUsageInKbytes

Discussion

Note: This value is for reference only. Due to system limitations, you may not get the value of this member.

Declared In

AgoraObjects.h