LocalVideoStats

Statistics of the local video stream.

class LocalVideoStats {
  const LocalVideoStats(
      {this.uid,
      this.sentBitrate,
      this.sentFrameRate,
      this.captureFrameRate,
      this.captureFrameWidth,
      this.captureFrameHeight,
      this.regulatedCaptureFrameRate,
      this.regulatedCaptureFrameWidth,
      this.regulatedCaptureFrameHeight,
      this.encoderOutputFrameRate,
      this.encodedFrameWidth,
      this.encodedFrameHeight,
      this.rendererOutputFrameRate,
      this.targetBitrate,
      this.targetFrameRate,
      this.qualityAdaptIndication,
      this.encodedBitrate,
      this.encodedFrameCount,
      this.codecType,
      this.txPacketLossRate,
      this.captureBrightnessLevel,
      this.hwEncoderAccelerating});

  @JsonKey(name: 'uid')
  final int? uid;

  @JsonKey(name: 'sentBitrate')
  final int? sentBitrate;

  @JsonKey(name: 'sentFrameRate')
  final int? sentFrameRate;

  @JsonKey(name: 'captureFrameRate')
  final int? captureFrameRate;

  @JsonKey(name: 'captureFrameWidth')
  final int? captureFrameWidth;

  @JsonKey(name: 'captureFrameHeight')
  final int? captureFrameHeight;

  @JsonKey(name: 'regulatedCaptureFrameRate')
  final int? regulatedCaptureFrameRate;

  @JsonKey(name: 'regulatedCaptureFrameWidth')
  final int? regulatedCaptureFrameWidth;

  @JsonKey(name: 'regulatedCaptureFrameHeight')
  final int? regulatedCaptureFrameHeight;

  @JsonKey(name: 'encoderOutputFrameRate')
  final int? encoderOutputFrameRate;

  @JsonKey(name: 'encodedFrameWidth')
  final int? encodedFrameWidth;

  @JsonKey(name: 'encodedFrameHeight')
  final int? encodedFrameHeight;

  @JsonKey(name: 'rendererOutputFrameRate')
  final int? rendererOutputFrameRate;

  @JsonKey(name: 'targetBitrate')
  final int? targetBitrate;

  @JsonKey(name: 'targetFrameRate')
  final int? targetFrameRate;

  @JsonKey(name: 'qualityAdaptIndication')
  final QualityAdaptIndication? qualityAdaptIndication;

  @JsonKey(name: 'encodedBitrate')
  final int? encodedBitrate;

  @JsonKey(name: 'encodedFrameCount')
  final int? encodedFrameCount;

  @JsonKey(name: 'codecType')
  final VideoCodecType? codecType;

  @JsonKey(name: 'txPacketLossRate')
  final int? txPacketLossRate;

  @JsonKey(name: 'captureBrightnessLevel')
  final CaptureBrightnessLevelType? captureBrightnessLevel;

  @JsonKey(name: 'hwEncoderAccelerating')
  final int? hwEncoderAccelerating;

  factory LocalVideoStats.fromJson(Map<String, dynamic> json) =>
      _$LocalVideoStatsFromJson(json);

  Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this);
}

Properties

uid
ID of the local user.
sentBitrate
Actual sending bitrate (Kbps)
Note: Excludes bitrate of retransmitted video after packet loss.
sentFrameRate
Actual sending frame rate (fps).
Note: Excludes frame rate of retransmitted video after packet loss.
captureFrameRate
Frame rate of local video capture (fps).
captureFrameWidth
Width of local video capture (px).
captureFrameHeight
Height of local video capture (px).
regulatedCaptureFrameRate
Frame rate (fps) of video captured by the camera after adjustment by the SDK's built-in video capture adapter (regulator). The regulator adjusts the camera capture frame rate based on the video encoding configuration.
regulatedCaptureFrameWidth
Width (px) of video captured by the camera after adjustment by the SDK's built-in video capture adapter (regulator). The regulator adjusts the width and height of the camera capture video based on the video encoding configuration.
regulatedCaptureFrameHeight
Height (px) of video captured by the camera after adjustment by the SDK's built-in video capture adapter (regulator). The regulator adjusts the width and height of the camera capture video based on the video encoding configuration.
encoderOutputFrameRate
Output frame rate of the local video encoder, in fps.
rendererOutputFrameRate
Output frame rate of the local video renderer, in fps.
targetBitrate
Target encoding bitrate (Kbps) of the current encoder. This bitrate is estimated by the SDK based on the current network conditions.
targetFrameRate
Target encoding frame rate (fps) of the current encoder.
qualityAdaptIndication
Adaptation status of local video quality (based on target frame rate and target bitrate) during the statistical cycle. See QualityAdaptIndication.
encodedBitrate
Video encoding bitrate (Kbps).
Note: Excludes bitrate of retransmitted video after packet loss.
encodedFrameHeight
Video encoding height (px).
encodedFrameWidth
Video encoding width (px).
encodedFrameCount
Number of video frames sent, cumulative value.
codecType
Video codec type. See VideoCodecType.
txPacketLossRate
Video packet loss rate (%) from the local end to the Agora edge server before weak network recovery.
captureFrameRate
Frame rate of local video capture (fps).
captureBrightnessLevel
Brightness level of locally captured video quality. See CaptureBrightnessLevelType.
hwEncoderAccelerating
Local video encoding acceleration type.
  • 0: Uses software encoding, no acceleration.
  • 1: Uses hardware encoding for acceleration.