LocalVideoStats

Statistics of the local video stream.

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
The ID of the local user.
sentBitrate
Actual sending bitrate (Kbps)
Note: Does not include the bitrate of retransmitted video after packet loss.
sentFrameRate
Actual sending frame rate (fps).
Note: Does not include the frame rate of retransmitted video after packet loss.
captureFrameRate
Frame rate of the local video capture (fps).
captureFrameWidth
Width of the local video capture (px).
captureFrameHeight
Height of the local video capture (px).
regulatedCaptureFrameRate
Frame rate (fps) of the video captured by the camera after being adjusted 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 the video captured by the camera after being adjusted by the SDK's built-in video capture adapter (regulator). The regulator adjusts the camera capture resolution based on the video encoding configuration.
regulatedCaptureFrameHeight
Height (px) of the video captured by the camera after being adjusted by the SDK's built-in video capture adapter (regulator). The regulator adjusts the camera capture resolution 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, 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 statistics interval. See QualityAdaptIndication.
encodedBitrate
Video encoding bitrate (Kbps).
Note: Does not include the bitrate of retransmitted video after packet loss.
encodedFrameHeight
Height of the encoded video (px).
encodedFrameWidth
Width of the encoded video (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 anti-weak network measures.
captureFrameRate
Frame rate of the local video capture (fps).
captureBrightnessLevel
Brightness level of the locally captured video. See CaptureBrightnessLevelType.
hwEncoderAccelerating
Local video encoding acceleration type.
  • 0: Software encoding, no acceleration.
  • 1: Hardware encoding acceleration.