RTCPeerConnectionIceEvent()

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

Browser compatibility

See also

• WebRTC
• Its usual target: RTCPeerConnection.