This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.
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 isnull
): ARTCIceCandidate
representing the ICE candidate being concerned by the event. Ifnull
, the event indicates the end of candidate gathering."url"
(optional, default isnull
): 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 benull
."bubbles"
(optional, default isfalse
): Inherited fromEventInit()
, this Boolean option indicates whether or not the event must bubble."cancelable"
(optional, default isfalse
, inherited fromEventInit()
, 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 Browser The definition of 'RTCPeerConnectionIceEvent()' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | (Yes) | (Yes) | No support | (Yes) | ? |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | ? | ? | ? | No support | ? | ? |
See also
- WebRTC
- Its usual target:
RTCPeerConnection
.