Web/API/RTCPeerConnectionIceEvent/RTCPeerConnectionIceEvent

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

The RTCPeerConnectionIceEvent() constructor creates a new RTCPeerConnectionIceEvent.

Syntax

 var event = new RTCPeerConnectionIceEvent(type, options);

Parameters

type

Is a DOMString containing the name of the event, like "icecandidate".

options

A dictionary of type RTCPeerConnectionInit, which may contain one or more of the following fields:

"candidate" (optional, default is null)

• A RTCIceCandidate representing the ICE candidate being concerned by the event.  If null, the event indicates the end of candidate gathering.
• "url" (optional, default is null): 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.
• "bubbles" (optional, default is false): Inherited from EventInit(), this Boolean option indicates whether or not the event must bubble.
• "cancelable" (optional, default is false, inherited from EventInit(), this Boolean indicates whether or not the event can be canceled.

Return value

A newly-created RTCPeerConnectionIceEvent, configured as specified in the provided options.

Specifications

Specification	Status	Comment
WebRTC 1.0: Real-time Communication Between BrowsersThe definition of 'RTCPeerConnectionIceEvent()' in that specification.	Candidate Recommendation	Initial definition.

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
RTCPeerConnectionIceEvent() constructor Experimental'	Chrome Full support 56	Edge Full support ≤18	Firefox Full support Yes	IE No support No	Opera Full support Yes	Safari ?	WebView Android Full support 56	Chrome Android Full support 56	Firefox Android Full support Yes	Opera Android Full support Yes	Safari iOS ?	Samsung Internet Android Full support 6.0

Legend

Full support  

Full support

No support  

No support

Compatibility unknown  

Compatibility unknown

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

See also

• WebRTC
• Its usual target: RTCPeerConnection.

RTCPeerConnectionIceEvent() by Mozilla Contributors is licensed under CC-BY-SA 2.5.