Merge pull request #90 from taylor-b/issue_89_candidate_deleted

Adding "deleted" property to RTCIceCandidateStats.
w3c · Dec 12, 2016 · 920d51c · 920d51c
2 parents 0dc9573 + 5b48534
commit 920d51c
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/webrtc-stats.html b/webrtc-stats.html
@@ -1374,6 +1374,7 @@ <h3>
              RTCIceCandidateType      candidateType;
              long                     priority;
              DOMString                url;
+             boolean                  deleted = false;
 };</pre>
           <section>
             <h2>
@@ -1442,6 +1443,23 @@ <h2>
                   surfaced in an <code>RTCPeerConnectionIceEvent</code>.
                 </p>
               </dd>
+              <dt>
+                <dfn><code>deleted</code></dfn> of type <span class=
+                "idlMemberType"><a>boolean</a></span>, defaulting to <code>false</code>
+              </dt>
+              <dd>
+                <p>
+                  For local candidates, <code>true</code> indicates that the
+                  candidate has been deleted/freed as described by [[!RFC5245]].
+                  For host candidates, this means that any network resources
+                  (typically a socket) associated with the candidate have been
+                  released. For TURN candidates, this means the TURN allocation
+                  is no longer active.
+                </p>
+                <p>
+                  For remote candidates, this property is not applicable.
+                </p>
+              </dd>
             </dl>
           </section>
         </div>