LocalVideoStats

Local video stream statistics.

export class LocalVideoStats {
  
  uid?: number;
  
  sentBitrate?: number;
  
  sentFrameRate?: number;
  
  captureFrameRate?: number;
  
  captureFrameWidth?: number;
  
  captureFrameHeight?: number;
  
  regulatedCaptureFrameRate?: number;
  
  regulatedCaptureFrameWidth?: number;
  
  regulatedCaptureFrameHeight?: number;
  
  encoderOutputFrameRate?: number;
  
  encodedFrameWidth?: number;
  
  encodedFrameHeight?: number;
  
  rendererOutputFrameRate?: number;
  
  targetBitrate?: number;
  
  targetFrameRate?: number;
  
  qualityAdaptIndication?: QualityAdaptIndication;
  
  encodedBitrate?: number;
  
  encodedFrameCount?: number;
  
  codecType?: VideoCodecType;
  
  txPacketLossRate?: number;
  
  captureBrightnessLevel?: CaptureBrightnessLevelType;

  hwEncoderAccelerating?: number;

}

Properties

uid
User ID of the local user.
sentBitrate
Actual sending bitrate (Kbps)
Note: Does not include bitrate for retransmitted video due to packet loss.
sentFrameRate
Actual sending frame rate (fps).
Note: Does not include frame rate for retransmitted video due to packet loss.
captureFrameRate
Local video capture frame rate (fps).
captureFrameWidth
Local video capture width (px).
captureFrameHeight
Local video capture height (px).
regulatedCaptureFrameRate
Camera capture frame rate (fps) adjusted by the SDK's built-in video capture adapter (regulator). The regulator adjusts the frame rate based on video encoding configuration.
regulatedCaptureFrameWidth
Camera capture width (px) adjusted by the SDK's built-in video capture adapter (regulator). The regulator adjusts the resolution based on video encoding configuration.
regulatedCaptureFrameHeight
Camera capture height (px) adjusted by the SDK's built-in video capture adapter (regulator). The regulator adjusts the resolution based on 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 value is estimated by the SDK based on 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 statistics interval. See QualityAdaptIndication.
encodedBitrate
Video encoding bitrate (Kbps).
Note: Does not include bitrate for retransmitted video due to packet loss.
encodedFrameHeight
Video encoding height (px).
encodedFrameWidth
Video encoding width (px).
encodedFrameCount
Number of video frames sent, cumulative.
codecType
Video codec type. See VideoCodecType.
txPacketLossRate
Video packet loss rate (%) from the local end to the Agora edge server before anti-packet-loss strategies are applied.
captureFrameRate
Local video capture frame rate (fps).
captureBrightnessLevel
Brightness level of the locally captured video. See CaptureBrightnessLevelType.
hwEncoderAccelerating
Local video encoder acceleration type.
  • 0: Software encoding, no acceleration.
  • 1: Hardware encoding acceleration.