io.agora.rtc.RtcStats Class Reference

Public Member Functions
	RtcStats ()
	RtcStats (int connectionId, int duration, int txBytes, int rxBytes, int txAudioBytes, int txVideoBytes, int rxAudioBytes, int rxVideoBytes, short txKBitRate, short rxKBitRate, short rxAudioKBitRate, short txAudioKBitRate, short rxVideoKBitRate, short txVideoKBitRate, short lastmileDelay, int userCount, double cpuAppUsage, double cpuTotalUsage, int gatewayRtt, double memoryAppUsageRatio, double memoryTotalUsageRatio, int memoryAppUsageInKbytes, int connectTimeMs, int firstAudioPacketDuration, int firstVideoPacketDuration, int firstVideoKeyFramePacketDuration, int packetsBeforeFirstKeyFramePacket, int firstAudioPacketDurationAfterUnmute, int firstVideoPacketDurationAfterUnmute, int firstVideoKeyFramePacketDurationAfterUnmute, int firstVideoKeyFrameDecodedDurationAfterUnmute, int firstVideoKeyFrameRenderedDurationAfterUnmute, int txPacketLossRate, int rxPacketLossRate)
int	getConnectionId ()
void	setConnectionId (int connectionId)
int	getDuration ()
void	setDuration (int duration)
int	getTxBytes ()
void	setTxBytes (int txBytes)
int	getRxBytes ()
void	setRxBytes (int rxBytes)
int	getTxAudioBytes ()
void	setTxAudioBytes (int txAudioBytes)
int	getTxVideoBytes ()
void	setTxVideoBytes (int txVideoBytes)
int	getRxAudioBytes ()
void	setRxAudioBytes (int rxAudioBytes)
int	getRxVideoBytes ()
void	setRxVideoBytes (int rxVideoBytes)
short	getTxKBitRate ()
void	setTxKBitRate (short txKBitRate)
short	getRxKBitRate ()
void	setRxKBitRate (short rxKBitRate)
short	getRxAudioKBitRate ()
void	setRxAudioKBitRate (short rxAudioKBitRate)
short	getTxAudioKBitRate ()
void	setTxAudioKBitRate (short txAudioKBitRate)
short	getRxVideoKBitRate ()
void	setRxVideoKBitRate (short rxVideoKBitRate)
short	getTxVideoKBitRate ()
void	setTxVideoKBitRate (short txVideoKBitRate)
short	getLastmileDelay ()
void	setLastmileDelay (short lastmileDelay)
int	getUserCount ()
void	setUserCount (int userCount)
double	getCpuAppUsage ()
void	setCpuAppUsage (double cpuAppUsage)
double	getCpuTotalUsage ()
void	setCpuTotalUsage (double cpuTotalUsage)
int	getGatewayRtt ()
void	setGatewayRtt (int gatewayRtt)
double	getMemoryAppUsageRatio ()
void	setMemoryAppUsageRatio (double memoryAppUsageRatio)
double	getMemoryTotalUsageRatio ()
void	setMemoryTotalUsageRatio (double memoryTotalUsageRatio)
int	getMemoryAppUsageInKbytes ()
void	setMemoryAppUsageInKbytes (int memoryAppUsageInKbytes)
int	getConnectTimeMs ()
void	setConnectTimeMs (int connectTimeMs)
int	getFirstAudioPacketDuration ()
void	setFirstAudioPacketDuration (int firstAudioPacketDuration)
int	getFirstVideoPacketDuration ()
void	setFirstVideoPacketDuration (int firstVideoPacketDuration)
int	getFirstVideoKeyFramePacketDuration ()
void	setFirstVideoKeyFramePacketDuration (int firstVideoKeyFramePacketDuration)
int	getPacketsBeforeFirstKeyFramePacket ()
void	setPacketsBeforeFirstKeyFramePacket (int packetsBeforeFirstKeyFramePacket)
int	getFirstAudioPacketDurationAfterUnmute ()
void	setFirstAudioPacketDurationAfterUnmute (int firstAudioPacketDurationAfterUnmute)
int	getFirstVideoPacketDurationAfterUnmute ()
void	setFirstVideoPacketDurationAfterUnmute (int firstVideoPacketDurationAfterUnmute)
int	getFirstVideoKeyFramePacketDurationAfterUnmute ()
void	setFirstVideoKeyFramePacketDurationAfterUnmute (int firstVideoKeyFramePacketDurationAfterUnmute)
int	getFirstVideoKeyFrameDecodedDurationAfterUnmute ()
void	setFirstVideoKeyFrameDecodedDurationAfterUnmute (int firstVideoKeyFrameDecodedDurationAfterUnmute)
int	getFirstVideoKeyFrameRenderedDurationAfterUnmute ()
void	setFirstVideoKeyFrameRenderedDurationAfterUnmute (int firstVideoKeyFrameRenderedDurationAfterUnmute)
int	getTxPacketLossRate ()
void	setTxPacketLossRate (int txPacketLossRate)
int	getRxPacketLossRate ()
void	setRxPacketLossRate (int rxPacketLossRate)

Detailed Description

The RtcStats class.

Constructor & Destructor Documentation

RtcStats() [1/2]

io.agora.rtc.RtcStats.RtcStats

(

)

RtcStats() [2/2]

io.agora.rtc.RtcStats.RtcStats	(	int	connectionId,
		int	duration,
		int	txBytes,
		int	rxBytes,
		int	txAudioBytes,
		int	txVideoBytes,
		int	rxAudioBytes,
		int	rxVideoBytes,
		short	txKBitRate,
		short	rxKBitRate,
		short	rxAudioKBitRate,
		short	txAudioKBitRate,
		short	rxVideoKBitRate,
		short	txVideoKBitRate,
		short	lastmileDelay,
		int	userCount,
		double	cpuAppUsage,
		double	cpuTotalUsage,
		int	gatewayRtt,
		double	memoryAppUsageRatio,
		double	memoryTotalUsageRatio,
		int	memoryAppUsageInKbytes,
		int	connectTimeMs,
		int	firstAudioPacketDuration,
		int	firstVideoPacketDuration,
		int	firstVideoKeyFramePacketDuration,
		int	packetsBeforeFirstKeyFramePacket,
		int	firstAudioPacketDurationAfterUnmute,
		int	firstVideoPacketDurationAfterUnmute,
		int	firstVideoKeyFramePacketDurationAfterUnmute,
		int	firstVideoKeyFrameDecodedDurationAfterUnmute,
		int	firstVideoKeyFrameRenderedDurationAfterUnmute,
		int	txPacketLossRate,
		int	rxPacketLossRate
	)

Constructor.

Parameters

connectionId	The connection ID.
duration	The call duration (s), represented by an aggregate value.
txBytes	The total number of bytes transmitted, represented by an aggregate value.
rxBytes	The total number of bytes received, represented by an aggregate value.
txAudioBytes	The total number of audio bytes sent (bytes), represented by an aggregate value.
txVideoBytes	The total number of video bytes sent (bytes), represented by an aggregate value.
rxAudioBytes	The total number of audio bytes received (bytes), represented by an aggregate value.
rxVideoBytes	The total number of video bytes received (bytes), represented by an aggregate value.
txKBitRate	The transmission bitrate (Kbps), represented by an instantaneous value.
rxKBitRate	The receiving bitrate (Kbps), represented by an instantaneous value.
rxAudioKBitRate	Audio receiving bitrate (Kbps), represented by an instantaneous value.
txAudioKBitRate	The audio transmission bitrate (Kbps), represented by an instantaneous value.
rxVideoKBitRate	The video receive bitrate (Kbps), represented by an instantaneous value.
txVideoKBitRate	The video transmission bitrate (Kbps), represented by an instantaneous value.
lastmileDelay	The VOS client-server latency (ms).
userCount	The number of users in the channel.
cpuAppUsage	The app CPU usage (%).
cpuTotalUsage	The system CPU usage (%).
gatewayRtt	The round-trip time delay (ms) from the client to the local router.
memoryAppUsageRatio	The memory usage ratio of the app (%).
memoryTotalUsageRatio	The memory usage ratio of the system (%).
memoryAppUsageInKbytes	The memory usage of the app (KB).
connectTimeMs	The time elapsed from the when the app starts connecting to an Agora channel to when the connection is established. 0 indicates that this member does not apply.
firstAudioPacketDuration	The duration (ms) between the app starting connecting to an Agora channel and the first audio packet is received. 0 indicates that this member does not apply.
firstVideoPacketDuration	The duration (ms) between the app starting connecting to an Agora channel and the first video packet is received. 0 indicates that this member does not apply.
firstVideoKeyFramePacketDuration	The duration (ms) between the app starting connecting to an Agora channel and the first video key frame is received. 0 indicates that this member does not apply.
packetsBeforeFirstKeyFramePacket	The number of video packets before the first video key frame is received. 0 indicates that this member does not apply.
firstAudioPacketDurationAfterUnmute	The duration (ms) between the last time unmute audio and the first audio packet is received. 0 indicates that this member does not apply.
firstVideoPacketDurationAfterUnmute	The duration (ms) between the last time unmute video and the first video packet is received. 0 indicates that this member does not apply.
firstVideoKeyFramePacketDurationAfterUnmute	The duration (ms) between the last time unmute video and the first video key frame is received. 0 indicates that this member does not apply.
firstVideoKeyFrameDecodedDurationAfterUnmute	The duration (ms) between the last time unmute video and the first video key frame is decoded. 0 indicates that this member does not apply.
firstVideoKeyFrameRenderedDurationAfterUnmute	The duration (ms) between the last time unmute video and the first video key frame is rendered. 0 indicates that this member does not apply.
txPacketLossRate	The packet loss rate of sender(broadcaster).
rxPacketLossRate	The packet loss rate of receiver(audience).

Member Function Documentation

getConnectionId()

int io.agora.rtc.RtcStats.getConnectionId

(

)

getConnectTimeMs()

int io.agora.rtc.RtcStats.getConnectTimeMs

(

)

getCpuAppUsage()

double io.agora.rtc.RtcStats.getCpuAppUsage

(

)

getCpuTotalUsage()

double io.agora.rtc.RtcStats.getCpuTotalUsage

(

)

getDuration()

int io.agora.rtc.RtcStats.getDuration

(

)

getFirstAudioPacketDuration()

int io.agora.rtc.RtcStats.getFirstAudioPacketDuration

(

)

getFirstAudioPacketDurationAfterUnmute()

int io.agora.rtc.RtcStats.getFirstAudioPacketDurationAfterUnmute

(

)

getFirstVideoKeyFrameDecodedDurationAfterUnmute()

int io.agora.rtc.RtcStats.getFirstVideoKeyFrameDecodedDurationAfterUnmute

(

)

getFirstVideoKeyFramePacketDuration()

int io.agora.rtc.RtcStats.getFirstVideoKeyFramePacketDuration

(

)

getFirstVideoKeyFramePacketDurationAfterUnmute()

int io.agora.rtc.RtcStats.getFirstVideoKeyFramePacketDurationAfterUnmute

(

)

getFirstVideoKeyFrameRenderedDurationAfterUnmute()

int io.agora.rtc.RtcStats.getFirstVideoKeyFrameRenderedDurationAfterUnmute

(

)

getFirstVideoPacketDuration()

int io.agora.rtc.RtcStats.getFirstVideoPacketDuration

(

)

getFirstVideoPacketDurationAfterUnmute()

int io.agora.rtc.RtcStats.getFirstVideoPacketDurationAfterUnmute

(

)

getGatewayRtt()

int io.agora.rtc.RtcStats.getGatewayRtt

(

)

getLastmileDelay()

short io.agora.rtc.RtcStats.getLastmileDelay

(

)

getMemoryAppUsageInKbytes()

int io.agora.rtc.RtcStats.getMemoryAppUsageInKbytes

(

)

getMemoryAppUsageRatio()

double io.agora.rtc.RtcStats.getMemoryAppUsageRatio

(

)

getMemoryTotalUsageRatio()

double io.agora.rtc.RtcStats.getMemoryTotalUsageRatio

(

)

getPacketsBeforeFirstKeyFramePacket()

int io.agora.rtc.RtcStats.getPacketsBeforeFirstKeyFramePacket

(

)

getRxAudioBytes()

int io.agora.rtc.RtcStats.getRxAudioBytes

(

)

getRxAudioKBitRate()

short io.agora.rtc.RtcStats.getRxAudioKBitRate

(

)

getRxBytes()

int io.agora.rtc.RtcStats.getRxBytes

(

)

getRxKBitRate()

short io.agora.rtc.RtcStats.getRxKBitRate

(

)

getRxPacketLossRate()

int io.agora.rtc.RtcStats.getRxPacketLossRate

(

)

getRxVideoBytes()

int io.agora.rtc.RtcStats.getRxVideoBytes

(

)

getRxVideoKBitRate()

short io.agora.rtc.RtcStats.getRxVideoKBitRate

(

)

getTxAudioBytes()

int io.agora.rtc.RtcStats.getTxAudioBytes

(

)

getTxAudioKBitRate()

short io.agora.rtc.RtcStats.getTxAudioKBitRate

(

)

getTxBytes()

int io.agora.rtc.RtcStats.getTxBytes

(

)

getTxKBitRate()

short io.agora.rtc.RtcStats.getTxKBitRate

(

)

getTxPacketLossRate()

int io.agora.rtc.RtcStats.getTxPacketLossRate

(

)

getTxVideoBytes()

int io.agora.rtc.RtcStats.getTxVideoBytes

(

)

getTxVideoKBitRate()

short io.agora.rtc.RtcStats.getTxVideoKBitRate

(

)

getUserCount()

int io.agora.rtc.RtcStats.getUserCount

(

)

setConnectionId()

void io.agora.rtc.RtcStats.setConnectionId

(

int

connectionId

)

setConnectTimeMs()

void io.agora.rtc.RtcStats.setConnectTimeMs

(

int

connectTimeMs

)

setCpuAppUsage()

void io.agora.rtc.RtcStats.setCpuAppUsage

(

double

cpuAppUsage

)

setCpuTotalUsage()

void io.agora.rtc.RtcStats.setCpuTotalUsage

(

double

cpuTotalUsage

)

setDuration()

void io.agora.rtc.RtcStats.setDuration

(

int

duration

)

setFirstAudioPacketDuration()

void io.agora.rtc.RtcStats.setFirstAudioPacketDuration

(

int

firstAudioPacketDuration

)

setFirstAudioPacketDurationAfterUnmute()

void io.agora.rtc.RtcStats.setFirstAudioPacketDurationAfterUnmute

(

int

firstAudioPacketDurationAfterUnmute

)

setFirstVideoKeyFrameDecodedDurationAfterUnmute()

void io.agora.rtc.RtcStats.setFirstVideoKeyFrameDecodedDurationAfterUnmute

(

int

firstVideoKeyFrameDecodedDurationAfterUnmute

)

setFirstVideoKeyFramePacketDuration()

void io.agora.rtc.RtcStats.setFirstVideoKeyFramePacketDuration

(

int

firstVideoKeyFramePacketDuration

)

setFirstVideoKeyFramePacketDurationAfterUnmute()

void io.agora.rtc.RtcStats.setFirstVideoKeyFramePacketDurationAfterUnmute

(

int

firstVideoKeyFramePacketDurationAfterUnmute

)

setFirstVideoKeyFrameRenderedDurationAfterUnmute()

void io.agora.rtc.RtcStats.setFirstVideoKeyFrameRenderedDurationAfterUnmute

(

int

firstVideoKeyFrameRenderedDurationAfterUnmute

)

setFirstVideoPacketDuration()

void io.agora.rtc.RtcStats.setFirstVideoPacketDuration

(

int

firstVideoPacketDuration

)

setFirstVideoPacketDurationAfterUnmute()

void io.agora.rtc.RtcStats.setFirstVideoPacketDurationAfterUnmute

(

int

firstVideoPacketDurationAfterUnmute

)

setGatewayRtt()

void io.agora.rtc.RtcStats.setGatewayRtt

(

int

gatewayRtt

)

setLastmileDelay()

void io.agora.rtc.RtcStats.setLastmileDelay

(

short

lastmileDelay

)

setMemoryAppUsageInKbytes()

void io.agora.rtc.RtcStats.setMemoryAppUsageInKbytes

(

int

memoryAppUsageInKbytes

)

setMemoryAppUsageRatio()

void io.agora.rtc.RtcStats.setMemoryAppUsageRatio

(

double

memoryAppUsageRatio

)

setMemoryTotalUsageRatio()

void io.agora.rtc.RtcStats.setMemoryTotalUsageRatio

(

double

memoryTotalUsageRatio

)

setPacketsBeforeFirstKeyFramePacket()

void io.agora.rtc.RtcStats.setPacketsBeforeFirstKeyFramePacket

(

int

packetsBeforeFirstKeyFramePacket

)

setRxAudioBytes()

void io.agora.rtc.RtcStats.setRxAudioBytes

(

int

rxAudioBytes

)

setRxAudioKBitRate()

void io.agora.rtc.RtcStats.setRxAudioKBitRate

(

short

rxAudioKBitRate

)

setRxBytes()

void io.agora.rtc.RtcStats.setRxBytes

(

int

rxBytes

)

setRxKBitRate()

void io.agora.rtc.RtcStats.setRxKBitRate

(

short

rxKBitRate

)

setRxPacketLossRate()

void io.agora.rtc.RtcStats.setRxPacketLossRate

(

int

rxPacketLossRate

)

setRxVideoBytes()

void io.agora.rtc.RtcStats.setRxVideoBytes

(

int

rxVideoBytes

)

setRxVideoKBitRate()

void io.agora.rtc.RtcStats.setRxVideoKBitRate

(

short

rxVideoKBitRate

)

setTxAudioBytes()

void io.agora.rtc.RtcStats.setTxAudioBytes

(

int

txAudioBytes

)

setTxAudioKBitRate()

void io.agora.rtc.RtcStats.setTxAudioKBitRate

(

short

txAudioKBitRate

)

setTxBytes()

void io.agora.rtc.RtcStats.setTxBytes

(

int

txBytes

)

setTxKBitRate()

void io.agora.rtc.RtcStats.setTxKBitRate

(

short

txKBitRate

)

setTxPacketLossRate()

void io.agora.rtc.RtcStats.setTxPacketLossRate

(

int

txPacketLossRate

)

setTxVideoBytes()

void io.agora.rtc.RtcStats.setTxVideoBytes

(

int

txVideoBytes

)

setTxVideoKBitRate()

void io.agora.rtc.RtcStats.setTxVideoKBitRate

(

short

txVideoKBitRate

)

setUserCount()

void io.agora.rtc.RtcStats.setUserCount

(

int

userCount

)

---

The documentation for this class was generated from the following file:

• RtcStats.java