LocalVideoStats

Collects statistics of the local video stream.

struct LocalVideoStats {
  uid_t uid;
  int sentBitrate;
  int sentFrameRate;
  int captureFrameRate;
  int captureFrameWidth;
  int captureFrameHeight;
  int regulatedCaptureFrameRate;
  int regulatedCaptureFrameWidth;
  int regulatedCaptureFrameHeight;
  int encoderOutputFrameRate;
  int encodedFrameWidth;
  int encodedFrameHeight;
  int rendererOutputFrameRate;
  int targetBitrate;
  int targetFrameRate;
  QUALITY_ADAPT_INDICATION qualityAdaptIndication;
  int encodedBitrate;
  int encodedFrameCount;
  VIDEO_CODEC_TYPE codecType;
  unsigned short txPacketLossRate;
  CAPTURE_BRIGHTNESS_LEVEL_TYPE captureBrightnessLevel;
  bool dualStreamEnabled;
  int hwEncoderAccelerating;
  VideoDimensions simulcastDimensions[SimulcastConfig::STREAM_LAYER_COUNT_MAX];
  int encodedFrameDepth;
};

Properties

uid
User ID of the local user.
sentBitrate
Actual bitrate (Kbps) of the sent local video stream.
sentFrameRate
Actual frame rate (fps) of the sent local video stream.
captureFrameRate
Frame rate (fps) of the captured local video stream.
captureFrameWidth
Width (px) of the captured local video stream.
captureFrameHeight
Height (px) of the captured local video stream.
regulatedCaptureFrameRate
Frame rate (fps) of the local video stream after being adjusted by the SDK's built-in video capture regulator.
regulatedCaptureFrameWidth
Width (px) of the local video stream after being adjusted by the SDK's built-in video capture regulator.
regulatedCaptureFrameHeight
Height (px) of the local video stream after being adjusted by the SDK's built-in video capture regulator.
encoderOutputFrameRate
Output frame rate (fps) of the local video encoder.
encodedFrameWidth
Width (px) of the encoded video.
encodedFrameHeight
Height (px) of the encoded video.
rendererOutputFrameRate
Output frame rate (fps) of the local video renderer.
targetBitrate
Target bitrate (Kbps) of the current encoder, estimated by the SDK based on the current network conditions.
targetFrameRate
Target frame rate (fps) of the current encoder.
qualityAdaptIndication
Quality adaptation status of the local video stream during the reporting interval (based on target frame rate and target bitrate). See QUALITY_ADAPT_INDICATION.
encodedBitrate
Bitrate (Kbps) used when encoding the local video stream.
encodedFrameCount
Total number of sent video frames (aggregated value).
codecType
Codec type of the local video. See VIDEO_CODEC_TYPE.
txPacketLossRate
Video packet loss rate (%) from the local client to the Agora server before applying anti-packet-loss strategies.
captureBrightnessLevel
Brightness level of the video image captured by the local camera. See CAPTURE_BRIGHTNESS_LEVEL_TYPE.
dualStreamEnabled
Whether dual-stream mode is enabled.
  • true: Dual-stream mode is enabled.
  • false: Dual-stream mode is not enabled.
hwEncoderAccelerating
Local video encoder acceleration type:
  • 0: Software encoding, no acceleration.
  • 1: Hardware encoding acceleration.
simulcastDimensions
Encoded frame dimensions of video streams at different quality layers. See VideoDimensions.