RTCIceTransport: gatheringstatechange-Ereignis

Ein gatheringstatechange-Ereignis wird an ein RTCIceTransport gesendet, wenn sich der Zustand des ICE-Kandidatensammelns ändert.

Der Sammelzustand, dessen aktueller Status in der gatheringState-Eigenschaft des Transportobjekts gefunden werden kann, zeigt an, ob der ICE-Agent damit begonnen hat, Kandidaten auf diesem Transport zu sammeln und, falls ja, ob er dies abgeschlossen hat.

Dieses Ereignis kann nicht abgebrochen werden und wird nicht gebubbelt.

Syntax

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

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

ongatheringstatechange = (event) => {};

Ereignistyp

Ein generisches Event.

Beispiele

Dieses Beispiel erstellt einen Handler für gatheringstatechange-Ereignisse auf jedem RTCRtpSender, das mit einer gegebenen RTCPeerConnection verbunden ist. Hier wird die Methode addEventListener() 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-Ereignishandler-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

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
gatheringstatechange event

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

Siehe auch

Verwandte RTCIceTransport-Ereignisse

Verwandte RTCPeerConnection-Ereignisse