RTCPeerConnectionIceEvent: RTCPeerConnectionIceEvent() constructor

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨September 2018⁩.

The RTCPeerConnectionIceEvent() constructor creates a new RTCPeerConnectionIceEvent object.

Syntax

new RTCPeerConnectionIceEvent(type, options)

A string with the name of the event. It is case-sensitive and browsers always set it to icecandidate.

An object that, in addition of the properties defined in Event(), can have the following properties:

candidate: A RTCIceCandidate representing the ICE candidate being concerned by the event. If null, the event indicates the end of candidate gathering.
url: A string containing the URL of the STUN or TURN server which was used to gather the candidate. If the candidate was not gathered by a STUN or TURN server, this value must be null, which is also the default value.