RTCPeerConnectionIceEvent()

This is an experimental technology
Check 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 Browsers
The definition of 'RTCPeerConnectionIceEvent()' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support56 Yes Yes ? Yes ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support5656 ? Yes Yes ?6.0

See also

Document Tags and Contributors

Contributors to this page: fscholz, jpmedley, Sheppy, teoli
Last updated by: fscholz,