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
.
Instance properties
id
-
A string 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 string indicating the type of statistics the object contains.
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 objectsRTCRtpStreamStats
adds toRTCStats
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.RTCRemoteInboundRtpStreamStats
contains statistics relevant to the remote receiving end of an RTP stream — usually computed by combining local data with data received via an RTCP RR or XR block.
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.
RTCAudioSourceStats
contains statistics about audio media sources.RTCVideoSourceStats
contains statistics about video media sources.RTCPeerConnectionStats
adds toRTCStats
information about the connection.
Specifications
Specification |
---|
Identifiers for WebRTC's Statistics API # dom-rtcstats |