|
88 | 88 | [[!WEBRTC]].
|
89 | 89 | </p>
|
90 | 90 | </section><!-- VS: getStats() remains in base spec! -->
|
| 91 | + <section class="informative"> |
| 92 | + <h2>Basic concepts</h2> |
| 93 | + <p>The stats API is defined in [[!GETUSERMEDIA]]. It is defined to return |
| 94 | + a set of objects that are a subclass of the RTCStats dictionary. This is |
| 95 | + normatively defined in [[!GETUSERMEDIA]], but is reproduced here |
| 96 | + for ease of reference. |
| 97 | + </p> |
| 98 | + <pre class="idl"> |
| 99 | + dictionary RTCStats { |
| 100 | + DOMHighResTimeStamp timestamp; |
| 101 | + RTCStatsType type; |
| 102 | + DOMString id; |
| 103 | + }; |
| 104 | + </pre> |
| 105 | + </section> |
91 | 106 | <section id="rtctatstype-*">
|
92 | 107 | <h2>
|
93 | 108 | RTCStatsType
|
94 |
| - </h2><code>RTCStatsType</code> object is initialized to the name of the dictionary that the |
95 |
| - <code>RTCStats</code> represents. |
96 |
| - <div class="note"> |
97 |
| - OPEN ISSUE: Need to define an IANA registry for the RTCStatsType and populate it with the |
98 |
| - following set as baseline. |
99 |
| - </div> |
| 109 | + </h2> |
| 110 | + <p>The <code>RTCStatsType</code> member indicates the type of the |
| 111 | + object that the |
| 112 | + <code>RTCStats</code> object represents. An object with a given "type" |
| 113 | + can be only one type of dictionary, but multiple "type" values may use |
| 114 | + the same type of dictionary.</p> |
| 115 | + <p>This specification is normative for the allowed values of <code>RTCStatsType</code>.</p> |
100 | 116 | <section id="rtcstatstype-str*">
|
| 117 | + |
| 118 | + <pre class="idl"> |
| 119 | +enum RTCStatsType { |
| 120 | + "inbound-rtp", |
| 121 | +"outbound-rtp", |
| 122 | +"peer-connection", |
| 123 | +"data-channel", |
| 124 | +"track", |
| 125 | +"transport", |
| 126 | +"candidate-pair", |
| 127 | +"local-candidate", |
| 128 | +"remote-candidate", |
| 129 | +"certificate" |
| 130 | +}; |
| 131 | + </pre> |
| 132 | + |
101 | 133 | <h3>
|
102 | 134 | RTCStatsType DOMString
|
103 |
| - </h3><!-- |
104 |
| - As per discussions: Move enum to a string that is in a registry |
105 |
| - <div class="note"> |
106 |
| - Updated the enum in [[!WEBRTC]]: to use lowercasenospacesordashes |
107 |
| - name convention, and added new enum values. |
108 |
| - </div> --> |
109 |
| - <!-- TODO: point to the actual stats dictionaries --> |
110 |
| - <!-- <dl class="idl" title="DOMString RTCStatsType"> --> |
| 135 | + </h3> |
| 136 | + |
| 137 | + |
111 | 138 | <p>
|
112 |
| - <var>RTCStatsType</var> is a equal to one of the following strings defined in |
113 |
| - [IANA-TOBE]: |
| 139 | + The following strings are valid values for <var>RTCStatsType</var>: |
114 | 140 | </p>
|
115 | 141 | <dl>
|
116 | 142 | <dt>
|
@@ -196,6 +222,14 @@ <h3>
|
196 | 222 | It is accessed by the <code><a>RTCIceCandidateStats</a></code> for the remote candidate.
|
197 | 223 | </p>
|
198 | 224 | </dd>
|
| 225 | + <dt> |
| 226 | + <code>"certificate"</code> |
| 227 | + </dt> |
| 228 | + <dd> |
| 229 | + <p> |
| 230 | + Information about a certificate used by an RTCIceTransport. |
| 231 | + </p> |
| 232 | + </dd> |
199 | 233 | </dl>
|
200 | 234 | </section>
|
201 | 235 | </section>
|
|
0 commit comments