RTCPeerConnectionIceEvent()

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The RTCPeerConnectionIceEvent() constructor creates a new RTCPeerConnectionIceEvent object.

Syntax

new RTCPeerConnectionIceEvent(type, options)

Parameters

type

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

options Optional

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.

Return value

A new RTCPeerConnectionIceEvent object, configured as specified in the provided options.

Specifications

Specification
WebRTC 1.0: Real-Time Communication Between Browsers
# dom-rtcpeerconnectioniceevent-constructor

Browser compatibility

BCD tables only load in the browser

See also