Documentation
Interactive Live Streaming Premium (Legacy)
Console 官网 Community Technical support
English
search-icon

Agora Web SDK API Reference

Overview AgoraRTC Client Stream Error codes Warning Codes

Video statistics of the local stream.

If getLocalVideoStats is called successfully, the LocalVideoStatsMap interface provides the UID and LocalVideoStats of the local user.

Hierarchy

  • LocalVideoStats

Index

Properties

Properties

Optional Readonly CaptureFrameRate

CaptureFrameRate: string

Frame rate of the captured video, in fps.

Optional Readonly CaptureResolutionHeight

CaptureResolutionHeight: string

Height (pixels) of the captured video.

Optional Readonly CaptureResolutionWidth

CaptureResolutionWidth: string

Width (pixels) of the captured video.

Optional Readonly EncodeDelay

EncodeDelay: string

Delay from capturing to encoding the local video, in ms.

Optional Readonly MuteState

MuteState: string

Whether the video is muted or not.

  • "1": Muted.
  • "0": Unmuted.

Optional Readonly SendBitrate

SendBitrate: string

Bitrate of the sent video, in Kbps.

Optional Readonly SendFrameRate

SendFrameRate: string

Frame rate of the sent video, in fps.

Optional Readonly SendResolutionHeight

SendResolutionHeight: string

Height of the sent video, in pixels.

Optional Readonly SendResolutionWidth

SendResolutionWidth: string

Width of the sent video, in pixels.

Optional Readonly TargetSendBitrate

TargetSendBitrate: string

Bitrate of the local video set in setVideoProfile.

Optional Readonly TotalDuration

TotalDuration: string

Total duration of the published video, in seconds.

Optional Readonly TotalFreezeTime

TotalFreezeTime: string

Total freeze time of the encoded video, in seconds.