RTCIceTransport: gatheringstatechange event

A gatheringstatechange event is sent to an RTCIceTransport when its ICE candidate gathering state changes.

The gathering state, whose actual status can be found in the transport object's gatheringState property, indicates whether or not the ICE agent has begun gathering candidates on this transport, and if so, if it has finished doing so.

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

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

ongatheringstatechange = (event) => {};

Event type

A generic Event.

Examples

This example creates a handler for gatheringstatechange events on each RTCRtpSender associated with a given RTCPeerConnection. Here, the addEventListener() method is called to add a listener for gatheringstatechange events:

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,
  );
});

Likewise, you can use the ongatheringstatechange event handler property:

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 */
    }
  };
});

Specifications

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

Browser compatibility

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

See also