RTCPeerConnectionIceEvent

The RTCPeerConnectionIceEvent interface represents events that occur in relation to ICE candidates with the target, usually an RTCPeerConnection.

Only one event is of this type: icecandidate.

Event RTCPeerConnectionIceEvent

Instance properties

A RTCPeerConnectionIceEvent being an Event, this event also implements these properties.

RTCPeerConnectionIceEvent.candidate Read only

Contains the RTCIceCandidate containing the candidate associated with the event, or null if this event indicates that there are no further candidates to come.

Constructors

RTCPeerConnectionIceEvent()

Returns a new RTCPeerConnectionIceEvent. It takes two parameters, the first being a string representing the type of the event; the second a dictionary containing the RTCIceCandidate it refers to.

Instance methods

A RTCPeerConnectionIceEvent being an Event, this event also implements these properties. There is no specific RTCDataChannelEvent method.

Examples

js
pc.onicecandidate = (ev) => {
  console.log(
    `The ICE candidate (trsp addr: '${ev.candidate.candidate}') added to connection.`,
  );
};

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Opera Safari Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet WebView Android
RTCPeerConnectionIceEvent 56 15 24 43 12 56 24 43 12 6.0 56
RTCPeerConnectionIceEvent 5624–56 15 24 4315–43 12 5625–56 24 4314–43 12 6.01.5–6.0 564.4–56
candidate 24 15 24 15 12 25 24 14 12 1.5 4.4
url No No No No 12 No No No 12 No No

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnectionIceEvent