RTCIceTransport: gatheringstatechange Ereignis

Baseline 2024
Newly available

Since April 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Ein gatheringstatechange-Ereignis wird an einen RTCIceTransport gesendet, wenn sich der ICE-Kandidatensammlungszustand ändert.

Der Sammlungszustand, dessen aktueller Status in der gatheringState-Eigenschaft des Transportobjekts gefunden werden kann, gibt an, ob der ICE-Agent begonnen hat, Kandidaten für diesen Transport zu sammeln, und falls ja, ob er damit fertig ist.

Dieses Ereignis kann nicht abgebrochen werden und wird nicht weitergegeben.

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener() oder setzen Sie eine Ereignis-Handler-Eigenschaft.

js
addEventListener("gatheringstatechange", (event) => { })

ongatheringstatechange = (event) => { }

Ereignistyp

Ein generisches Event.

Beispiele

Dieses Beispiel erstellt einen Handler für gatheringstatechange-Ereignisse auf jedem RTCRtpSender, der mit einer gegebenen RTCPeerConnection assoziiert ist. Hier wird die addEventListener()-Methode aufgerufen, um einen Listener für gatheringstatechange-Ereignisse hinzuzufügen:

js
pc.getSenders().forEach((sender) => {
  sender.transport.iceTransport.addEventListener(
    "gatheringstatechange",
    (ev) => {
      let transport = ev.target;

      if (transport.gatheringState === "complete") {
        /* this transport has finished gathering candidates,
        but others may still be working on it */
      }
    },
    false,
  );
});

Ebenso können Sie die ongatheringstatechange-Ereignis-Handler-Eigenschaft verwenden:

js
pc.getSenders().forEach((sender) => {
  sender.transport.iceTransport.ongatheringstatechange = (ev) => {
    let transport = ev.target;

    if (transport.gatheringState === "complete") {
      /* this transport has finished gathering candidates,
         but others may still be working on it */
    }
  };
});

Spezifikationen

Specification
WebRTC: Real-Time Communication in Browsers
# event-icetransport-gatheringstatechange
WebRTC: Real-Time Communication in Browsers
# dom-rtcicetransport-ongatheringstatechange

Browser-Kompatibilität

Siehe auch

Verwandte RTCIceTransport-Ereignisse

Verwandte RTCPeerConnection-Ereignisse