RTCPeerConnection: signalingstatechange event

{{APIRef("WebRTC")}}

A signalingstatechange event is sent to an {{domxref("RTCPeerConnection")}} to notify it that its signaling state, as indicated by the {{domxref("RTCPeerConnection.signalingState", "signalingState")}} property, has changed.

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

addEventListener("signalingstatechange", (event) => { })

onsignalingstatechange = (event) => { }

Event type

A generic {{domxref("Event")}}.

Examples

Given an {{domxref("RTCPeerConnection")}}, pc, and an updateStatus() function that presents status information to the user, this code sets up an event handler to let the user know when the ICE negotiation process finishes up.

pc.addEventListener("signalingstatechange", (ev) => {
  switch (pc.signalingState) {
    case "stable":
      updateStatus("ICE negotiation complete");
      break;
  }
});

Using onsignalingstatechange, it looks like this:

pc.onsignalingstatechange = (ev) => {
  switch (pc.signalingState) {
    case "stable":
      updateStatus("ICE negotiation complete");
      break;
  }
};

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• WebRTC API
• {{domxref("RTCPeerConnection.signalingState")}}