Web/API/RTCStats

The RTCStats dictionary is the basic statistics object used by WebRTC's statistics monitoring model, providing the properties required of all statistics data objects. Specific classes of statistic are defined as dictionaries based on RTCStats. For example, statistics about a received RTP stream are represented by RTCReceivedRtpStreamStats.

Properties

id

A DOMString which uniquely identifies the object which was inspected to produce this object based on RTCStats.

timestamp

A DOMHighResTimeStamp object indicating the time at which the sample was taken for this statistics object.

type

A DOMString indicating the type of statistics the object contains, taken from the enum type RTCStatsType.

The statistics type hierarchy

The various dictionaries that are used to define the contents of the objects that contain each of the various types of statistics for WebRTC are structured in such a way that they build upon the core RTCStats dictionary, each layer adding more relevant information.

• RTCStats is the foundation of all WebRTC statistics objects
  • RTCRtpStreamStats adds to RTCStats information that applies to all RTP endpoints (that is, both local and remote endpoints, and regardless of whether the endpoint is a sender or a receiver)
    • RTCReceivedRtpStreamStats further adds statistics measured at the receiving end of an RTP stream, regardless of whether it's local or remote.
      • RTCInboundRtpStreamStats contains statistics that can only be measured on a receiver at the local end of the RTP connection.
      • RTCOutboundRtpStreamStats contains statistics related to the receiver at the remote end of the RTP stream.
    • RTCSentRtpStreamStats offers statistics related to the sending end of an RTP stream.
      • RTCOutboundRtpStreamStats contains statistics about the local sending endpoint of an RTP stream.
      • RTCRemoteOutboundRtpStreamStats holds statistics related to the remote sending end an RTP stream.

Specifications

Specification	Status	Comment
WebRTC 1.0: Real-time Communication Between BrowsersThe definition of 'RTCStats' in that specification.	Candidate Recommendation	Initial specification.

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

No compatibility data found. Please contribute data for "api.RTCStats" (depth: 1) to the MDN compatibility data repository.

RTCStats by Mozilla Contributors is licensed under CC-BY-SA 2.5.