The
RTCIceCandidateStats
dictionary's deleted
property indicates whether or not the candidate has been deleted or released.
Syntax
isDeleted = rtcIceCandidateStats.deleted;
Value
A Boolean value indicating whether or not the candidate has been deleted or released. If this value is true
, the candidate described by the RTCIceCandidateStats
object is no longer under consideration. dThe exact meaning varies depending on the type of candidate:
- Local candidate
- A value of
true
means the candidate has been deleted as described by RFC 5245: 8.3. - Host candidate
- A value of
true
indicates that the candidate's network resources have been released. This generally mean sthat any associated socket(s) have been closed and released. - Remote (TURN) candidate
- A value of
true
means the candidate's TURN allocation is no longer active.
The net result is the same; the candidate is no longer under consideration if this value is true
.
Example
In this example, setInterval()
is used to set up a function that runs periodically to display the latest statistics for candidates. Only candidates which have not been deleted are included in the output.
window.setInterval(function() { myPeerConnection.getStats(null).then(stats => { let statsOutput = ""; stats.forEach(report => { if ((stats.type === "local-candidate" || stats.type === "remote.candidate") && !stats.deleted) { statsOutput += `<h2>Report: ${report.type}</h3>\n<strong>ID:</strong> ${report.id}<br>\n` + `<strong>Timestamp:</strong> ${report.timestamp}<br>\n`; // Now the statistics for this report; we intentially drop the ones we // sorted to the top above Object.keys(report).forEach(statName => { if (statName !== "id" && statName !== "timestamp" && statName !== "type") { statsOutput += `<strong>${statName}:</strong> ${report[statName]}<br>\n`; } }); } }); document.querySelector(".stats-box").innerHTML = statsOutput; }); }, 1000);
Specifications
Specification | Status | Comment |
---|---|---|
Identifiers for WebRTC's Statistics API The definition of 'RTCIceCandidateStats.deleted' 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.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
deleted | Chrome No support No | Edge No support No | Firefox No support No | IE No support No | Opera ? | Safari ? | WebView Android No support No | Chrome Android No support No | Firefox Android No support No | Opera Android ? | Safari iOS ? | Samsung Internet Android No support No |
Legend
- No support
- No support
- Compatibility unknown
- Compatibility unknown