LocalVideoStats

Statistics of the local video stream.

public static class LocalVideoStats {
    public int uid;
    public int sentBitrate;
    public int sentFrameRate;
    public int captureFrameRate;
    public int captureFrameWidth;
    public int captureFrameHeight;
    public int regulatedCaptureFrameRate;
    public int regulatedCaptureFrameWidth;
    public int regulatedCaptureFrameHeight;
    public int encoderOutputFrameRate;
    public int rendererOutputFrameRate;
    public int targetBitrate;
    public int targetFrameRate;
    public int qualityAdaptIndication;
    public int encodedBitrate;
    public int encodedFrameWidth;
    public int encodedFrameHeight;
    public int encodedFrameCount;
    public int codecType;
    public int txPacketLossRate;
    public int captureBrightnessLevel;
    public boolean dualStreamEnabled;
    public int hwEncoderAccelerating;
    public int encodedFrameDepth;
}

Properties

uid

User ID of the local user.

sentBitrate

Actual bitrate (Kbps) of the local video stream during transmission.

Note: This value does not include the bitrate of retransmissions caused by packet loss.

sentFrameRate

Actual frame rate (fps) of the local video stream during transmission.

Note: This value does not include the frame rate of retransmissions caused by packet loss.

captureFrameRate

Frame rate (fps) when capturing the local video stream.

captureFrameWidth

Width (px) when capturing the local video stream.

captureFrameHeight

Height (px) when capturing the local video stream.

regulatedCaptureFrameRate

Frame rate (fps) of the local video adjusted by the built-in video capture regulator of the Agora SDK based on the encoding configuration.

regulatedCaptureFrameWidth

Width (px) of the local video adjusted by the built-in video capture regulator of the Agora SDK based on the encoding configuration.

regulatedCaptureFrameHeight

Height (px) of the local video adjusted by the built-in video capture regulator of the Agora SDK based on the encoding configuration.

encoderOutputFrameRate

Output frame rate (fps) of the local video encoder.

rendererOutputFrameRate

Output frame rate (fps) of the local video renderer.

targetBitrate

Target bitrate (Kbps) of the current encoder.

Note: This value is estimated by the SDK based on the current network conditions.

targetFrameRate

Target frame rate (fps) of the current encoder.

qualityAdaptIndication

Video quality adaptation status of the local video stream during the statistical period:

ADAPT_NONE (0): Video quality remains unchanged.
ADAPT_UP_BANDWIDTH (1): Video quality improves due to increased network bandwidth.
ADAPT_DOWN_BANDWIDTH (2): Video quality degrades due to decreased network bandwidth.

encodedBitrate

Bitrate (Kbps) when encoding the local video stream.

Note: This value does not include the bitrate of retransmissions caused by packet loss.

encodedFrameWidth

Width (px) of the encoded video.

encodedFrameHeight

Height (px) of the encoded video.

encodedFrameCount

Total number of video frames sent, represented as an aggregate value.

codecType

Note: In some scenarios (e.g., low capture resolution or limited device performance), the SDK automatically switches to H.264 encoding format.

Encoder type used for the local video. The optional values are as follows. See VIDEO_CODEC_TYPE:

VIDEO_CODEC_VP8 (1): VP8.
VIDEO_CODEC_H264 (2): H.264.
VIDEO_CODEC_H265 (3): H.265 (default).

txPacketLossRate

Video packet loss rate (%) from the local client to the Agora server before applying anti-packet-loss strategies.

captureBrightnessLevel

Note: After a few seconds, you can get the brightness level from the next callback's captureBrightnessLevel.

Brightness level of the video image captured by the local camera:

CAPTURE_BRIGHTNESS_LEVEL_INVALID (-1): SDK did not detect brightness.
CAPTURE_BRIGHTNESS_LEVEL_NORMAL (0): Normal brightness.
CAPTURE_BRIGHTNESS_LEVEL_BRIGHT (1): Overly bright.
CAPTURE_BRIGHTNESS_LEVEL_DARK (2): Too dark.

dualStreamEnabled

Whether dual-stream mode is enabled:

true: Dual-stream mode is enabled.
false: Dual-stream mode is not enabled.

hwEncoderAccelerating

Hardware acceleration type for local video encoding:

0: Software encoding, no acceleration.
1: Hardware encoding acceleration.