RTCRtpStreamStats dictionary is returned by the
RTCRtpReceiver.getStats() methods to provide detailed statistics about WebRTC connectivity. While the dictionary has a base set of properties that are present in each of these cases, there are also additional properties added depending on which interface the method is called on.
RTCRtpStreamStats is the base class for all RTP-related statistics reports. It's based on RTCStats and adds the following additional fields.
Note: This interface was called
RTCRTPStreamStats until a specification update in the spring of 2017. Check the Browser compatibility table to know if and when the name change was implemented in specific browsers.
RTCRtpStreamStats dictionary is based on
RTCStats, and inherits its properties. In addition, some or all of the following properties are available.
DOMStringwhich uniquely identifies the object which was inspected to produce the
RTCCodecStatsobject associated with this RTP stream.
DOMStringwhose value is
"audio"if the associated
MediaStreamTrackis audio-only or
"video"if the track contains video. This value will match that of the media type indicated by
RTCCodecStats.codec, as well as the track's
kindproperty. Previously called
- The 32-bit integer which identifies the source of the RTP packets this
RTCRtpStreamStatsobject covers. This value is generated per the RFC 3550 specification.
DOMStringwhich uniquely identifies the
RTCMediaStreamTrackStatsobject representing the associated
MediaStreamTrack. This is not the same as the value of
DOMStringuniquely identifying the object which was inspected to produce the
RTCTransportStatsobject associated with this RTP stream.
These properties are computed locally, and are only available to the device receiving the media stream. Their primary purpose is to examine the error resiliency of the connection, as they provide information about lost packets, lost frames, and how heavily compressed the data is.
- A count of the total number of Full Intra Request (FIR) packets received by the sender. This statistic is only available to the device which is receiving the stream and is only available for video tracks. A FIR packet is sent by the receiving end of the stream when it falls behind or has lost packets and is unable to continue decoding the stream; the sending end of the stream receives the FIR packet and responds by sending a full frame instead of a delta frame, thereby letting the receiver "catch up." The higher this number is, the more often a problem of this nature arose, which can be a sign of network congestion or an overburdened receiving device.
- The number of times the receiver notified the sender that one or more RTP packets has been lost by sending a Negative ACKnowledgement (NACK, also called "Generic NACK") packet to the sender. This value is only available to the receiver.
- The number of times the receiving end of the stream sent a Picture Loss Indiciation (PLI) packet to the sender, indicating that it has lost some amount of encoded video data for one or more frames. Only the receiver has this value, and it's only valid for video tracks.
- The sum of the Quantization Parameter (QP) values associated with every frame received to date on the video track described by this
RTCRtpStreamStatsobject. In general, the higher this number is, the more heavily compressed the video track was. Combined with
RTCSentRtpStreamStats.framesEncoded, you can approximate the average QP over those frames, keeping in mind that codecs often vary the quantizer values even within frames. Also keep in mind that the values of QP can vary from codec to codec, so this value is only potentially useful when compared against the same codec.
- The number of times the receiver notified the sender that one or more consecutive (in scan order) encoded video macroblocks have been lost or corrupted; this notification is sent by the receiver to the sender using a Slice Loss Indication (SLI) packet. This is a fairly technical part of how codecs work and while the higher this value is, the more errors occurred in the stream, generally most of the time this value is only interesting to very intensively hardcore media developers.
|Identifiers for WebRTC's Statistics API
The definition of 'RTCRtpStreamStats' in that specification.
|Candidate Recommendation||Initial definition.|
BCD tables only load in the browser