LocalVideoStats

The 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 int hwEncoderAccelerating;
}

Attributes

uid
The ID of the local user.
sentBitrate
The actual bitrate (Kbps) while sending the local video stream.
Attention: This value does not include the bitrate for resending the video after packet loss.
sentFrameRate
The actual frame rate (fps) while sending the local video stream.
Attention: This value does not include the frame rate for resending the video after packet loss.
captureFrameRate
The frame rate (fps) for capturing the local video stream.
captureFrameWidth
The width (px) for capturing the local video stream.
captureFrameHeight
The height (px) for capturing the local video stream.
regulatedCaptureFrameRate
The frame rate (fps) adjusted by the built-in video capture adapter (regulator) of the SDK for capturing the local video stream. The regulator adjusts the frame rate of the video captured by the camera according to the video encoding configuration.
regulatedCaptureFrameWidth
The width (px) adjusted by the built-in video capture adapter (regulator) of the SDK for capturing the local video stream. The regulator adjusts the height and width of the video captured by the camera according to the video encoding configuration.
regulatedCaptureFrameHeight
The height (px) adjusted by the built-in video capture adapter (regulator) of the SDK for capturing the local video stream. The regulator adjusts the height and width of the video captured by the camera according to the video encoding configuration.
encoderOutputFrameRate
The output frame rate (fps) of the local video encoder.
rendererOutputFrameRate
The output frame rate (fps) of the local video renderer.
targetBitrate
The target bitrate (Kbps) of the current encoder. This is an estimate made by the SDK based on the current network conditions.
targetFrameRate
The target frame rate (fps) of the current encoder.
qualityAdaptIndication
The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate).
  • ADAPT_NONE(0): The local video quality stays the same.
  • ADAPT_UP_BANDWIDTH(1): The local video quality improves because the network bandwidth increases.
  • ADAPT_DOWN_BANDWIDTH(2): The local video quality deteriorates because the network bandwidth decreases.
encodedBitrate
The bitrate (Kbps) while encoding the local video stream.
Attention: This value does not include the bitrate for resending the video after packet loss.
encodedFrameHeight
The height of the encoded video (px).
encodedFrameWidth
The width of the encoded video (px).
encodedFrameCount
The number of the sent video frames, represented by an aggregate value.
codecType
The codec type of the local video. See VIDEO_CODEC_TYPE.
  • VIDEO_CODEC_VP8(1): VP8.
  • VIDEO_CODEC_H264(2): H.264.
  • VIDEO_CODEC_H265(3): (Default) H.265.
Note: In certain scenarios, such as low resolution of the captured video stream or limited device performance, the SDK automatically adjusts to the H.264 encoding format.
txPacketLossRate
The video packet loss rate (%) from the local client to the Agora server before applying the anti-packet loss strategies.
captureBrightnessLevel
The brightness level of the video image captured by the local camera.
  • CAPTURE_BRIGHTNESS_LEVEL_INVALID(-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
  • CAPTURE_BRIGHTNESS_LEVEL_NORMAL(0): The brightness level of the video image is normal.
  • CAPTURE_BRIGHTNESS_LEVEL_BRIGHT(1): The brightness level of the video image is too bright.
  • CAPTURE_BRIGHTNESS_LEVEL_DARK(2): The brightness level of the video image is too dark.
hwEncoderAccelerating
The local video encoding acceleration type.
  • 0: Software encoding is applied without acceleration.
  • 1: Hardware encoding is applied for acceleration.