blob: 9c95acc3b21769c69531d6d8464451e526196f60 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
---
title: RTCStats
slug: Web/API/RTCStats
tags:
- API
- Dictionary
- NeedsTranslation
- RTCStats
- Reference
- Report
- Statistics
- Stats
- TopicStub
- WebRTC
- rtc
translation_of: Web/API/RTCStats
---
<div>{{APIRef("WebRTC")}}</div>
<p><span class="seoSummary">The <strong><code>RTCStats</code></strong> dictionary is the basic statistics object used by WebRTC's statistics monitoring model, providing the properties required of all statistics data objects.</span> Specific classes of statistic are defined as dictionaries based on <code>RTCStats</code>. For example, statistics about a received {{Glossary("RTP")}} stream are represented by {{domxref("RTCReceivedRtpStreamStats")}}.</p>
<h2 id="Properties">Properties</h2>
<dl>
<dt>{{domxref("RTCStats.id", "id")}}</dt>
<dd>A {{domxref("DOMString")}} which uniquely identifies the object which was inspected to produce this object based on <code>RTCStats</code>.</dd>
<dt>{{domxref("RTCStats.timestamp", "timestamp")}}</dt>
<dd>A {{domxref("DOMHighResTimeStamp")}} object indicating the time at which the sample was taken for this statistics object.</dd>
<dt>{{domxref("RTCStats.type", "type")}}</dt>
<dd>A {{domxref("DOMString")}} indicating the type of statistics the object contains, taken from the enum type {{domxref("RTCStatsType")}}.</dd>
</dl>
<h2 id="The_statistics_type_hierarchy">The statistics type hierarchy</h2>
<p>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 <code>RTCStats</code> dictionary, each layer adding more relevant information.</p>
<ul>
<li>{{domxref("RTCStats")}} is the foundation of all WebRTC statistics objects
<ul>
<li>{{domxref("RTCRtpStreamStats")}} adds to <code>RTCStats</code> 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)
<ul>
<li>{{domxref("RTCReceivedRtpStreamStats")}} further adds statistics measured at the receiving end of an RTP stream, regardless of whether it's local or remote.
<ul>
<li>{{domxref("RTCInboundRtpStreamStats")}} contains statistics that can only be measured on a receiver at the local end of the RTP connection.</li>
<li>{{domxref("RTCOutboundRtpStreamStats")}} contains statistics related to the receiver at the remote end of the RTP stream.</li>
</ul>
</li>
<li>{{domxref("RTCSentRtpStreamStats")}} offers statistics related to the sending end of an RTP stream.
<ul>
<li>{{domxref("RTCOutboundRtpStreamStats")}} contains statistics about the local sending endpoint of an RTP stream.</li>
<li>{{domxref("RTCRemoteOutboundRtpStreamStats")}} holds statistics related to the remote sending end an RTP stream.</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 id="Specifications">Specifications</h2>
<table class="standard-table">
<thead>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{ SpecName('WebRTC 1.0', '#dom-rtcstats', 'RTCStats') }}</td>
<td>{{ Spec2('WebRTC 1.0') }}</td>
<td>Initial specification.</td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility">Browser compatibility</h2>
<p>{{Compat("api.RTCStats")}}</p>
|
