LocalVideoStats

WebRTC stats from a local video stream

Properties

active?

optional active: boolean

Indicates if SDK is actively sending local video or not

---

bytesSent?

optional bytesSent: number

The total number of video bytes sent, including retransmissions

---

encoderImplementation?

optional encoderImplementation: string

Identifies the encoder implementation used for encoding video (e.g., 'SimulcastEncoder', 'ExternalEncoder', 'libvpx')

---

firCount?

optional firCount: number

The total number of Full Intra Request (FIR) packets received

---

frameHeight?

optional frameHeight: number

Represents the height of the last encoded frame

---

framesEncoded?

optional framesEncoded: number

The number of video frames encoded

---

framesPerSecond?

optional framesPerSecond: number

The number of encoded frames during the last second

---

framesSent?

optional framesSent: number

Represents the total number of frames sent

---

frameWidth?

optional frameWidth: number

Represents the width of the last encoded frame

---

headerBytesSent?

optional headerBytesSent: number

The number of RTP header bytes sent

---

hugeFramesSent?

optional hugeFramesSent: number

Represents the total number of huge frames sent

---

keyFramesEncoded?

optional keyFramesEncoded: number

The number of video key frames encoded

---

nackCount?

optional nackCount: number

The NACK count received by SDK for sending video

---

networkQuality?

optional networkQuality: NetworkQuality

The network quality associated with publishing local video

---

packetsLost?

optional packetsLost: number

The number of video RTP packets lost

---

packetsSent?

optional packetsSent: number

The number of video RTP packets sent

---

pliCount?

optional pliCount: number

The total number of Picture Loss Indication (PLI) packets received

---

qualityLimitationBandwidthDuration?

optional qualityLimitationBandwidthDuration: number

Total time spent in quality limitation state due to restricted bandwidth (in seconds)

---

qualityLimitationCpuDuration?

optional qualityLimitationCpuDuration: number

Total time spent in quality limitation state due to CPU (in seconds)

---

qualityLimitationReason?

optional qualityLimitationReason: string

The current reason for limiting the resolution and/or framerate

---

qualityLimitationResolutionChanges?

optional qualityLimitationResolutionChanges: number

The total time spent in each quality limitation state (in seconds)

---

retransmittedBytesSent?

optional retransmittedBytesSent: number

The number of retransmitted bytes

---

retransmittedPacketsSent?

optional retransmittedPacketsSent: number

The number of video RTP packets retransmitted

---

rid?

optional rid: string

Represents the layer used by simulcast; not empty only when simulcast is enabled

---

ssrc?

optional ssrc: number

A positive 32-bit integer uniquely identifying the SSRC of the RTP packets whose statistics are covered by this stream

---

totalEncodedBytesTarget?

optional totalEncodedBytesTarget: number

Incremented by the target frame size in bytes every time a frame has been encoded

---

totalEncodeTime?

optional totalEncodeTime: number

The total time spent encoding video frames (in seconds)

---

totalPacketSendDelay?

optional totalPacketSendDelay: number

The total number of seconds that RTP packets have been buffered locally