LocalVideoStats

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

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). See QualityAdaptIndication.
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 VideoCodecType.
txPacketLossRate
The video packet loss rate (%) from the local client to the Agora server before applying the anti-packet loss strategies.
captureFrameRate
The frame rate (fps) for capturing the local video stream.
captureBrightnessLevel
The brightness level of the video image captured by the local camera. See CaptureBrightnessLevelType.
hwEncoderAccelerating
The local video encoding acceleration type.
  • 0: Software encoding is applied without acceleration.
  • 1: Hardware encoding is applied for acceleration.