TheRTCPeerConnectionIceErrorEvent interface—based upon theEvent interface—provides details pertaining to anICE error announced by sending anicecandidateerror event to theRTCPeerConnection object.

Constructor

RTCPeerConnectionIceErrorEvent()

Creates and returns a newRTCPeerConnectionIceErrorEvent object, with itstype and other properties initialized as specified in the parameters. You will not normally create an object of this type yourself.

Instance properties

TheRTCPeerConnectionIceErrorEvent interface includes the properties found on theEvent interface, as well as the following properties:

addressRead only

A string providing the local IP address used to communicate with theSTUN orTURN server being used to negotiate the connection, ornull if the local IP address has not yet been exposed as part of a local ICE candidate.

errorCodeRead only

An unsigned integer value stating the numericSTUN error code returned by the STUN or TURN server. If no host candidate can reach the server, this property is set to the number 701, which is outside the range of valid STUN error codes. The 701 error is fired only once per server URL, and only while theiceGatheringState isgathering.

errorTextRead only

A string containing the STUN reason text returned by the STUN or TURN server. If communication with the STUN or TURN server couldn't be established at all, this string will be a browser-specific string explaining the error.

portRead only

An unsigned integer value giving the port number over which communication with the STUN or TURN server is taking place, using the IP address given inaddress.null if the connection hasn't been established (that is, ifaddress isnull).

urlRead only

A string indicating the URL of the STUN or TURN server with which the error occurred.

Instance methods

RTCPeerConnectionIceErrorEvent has no methods other than any provided by the parent interface,Event.

Examples

TBD

Specifications

Browser compatibility