RTCIceCandidateStats: deleted-Eigenschaft

Die deleted-Eigenschaft des RTCIceCandidateStats-Wörterbuchs zeigt an, ob der Kandidat gelöscht oder freigegeben wurde.

Wert

Ein Boolean-Wert, der angibt, ob der Kandidat gelöscht oder freigegeben wurde. Ist dieser Wert true, wird der vom RTCIceCandidateStats-Objekt beschriebene Kandidat nicht mehr berücksichtigt. Die genaue Bedeutung variiert abhängig vom Typ des Kandidaten:

Lokaler Kandidat

Ein Wert von true bedeutet, dass der Kandidat gelöscht wurde, wie in RFC 5245, Abschnitt 8.3 beschrieben.

Host-Kandidat

Ein Wert von true zeigt an, dass die Netzwerkressourcen des Kandidaten freigegeben wurden. Dies bedeutet im Allgemeinen, dass alle zugehörigen Socket(s) geschlossen und freigegeben wurden.

Remote (TURN)-Kandidat

Ein Wert von true bedeutet, dass die TURN-Zuweisung des Kandidaten nicht mehr aktiv ist.

Das Nettoergebnis ist dasselbe; der Kandidat wird nicht mehr in Betracht gezogen, wenn dieser Wert true ist.

Beispiele

In diesem Beispiel wird setInterval() verwendet, um eine Funktion einzurichten, die regelmäßig ausgeführt wird, um die neuesten Statistiken für Kandidaten anzuzeigen. Nur Kandidaten, die nicht gelöscht wurden, sind in der Ausgabe enthalten.

js
setInterval(() => {
  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 intentionally 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);

Spezifikationen

No specification found

No specification data found for api.RTCIceCandidateStats.deleted.
Check for problems with this page or contribute a missing spec_url to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.

Browser-Kompatibilität

BCD tables only load in the browser