RTCPeerConnectionIceErrorEvent

The RTCPeerConnectionIceErrorEvent interface of the WebRTC API describes an error that occurred while handling ICE negotiation through a STUN or TURN server.

It inherits from the Event interface, adding details that are relevant to errors in ICE negotiations.

The icecandidateerror event fired at RTCPeerConnection is an instance of this object.

Constructor

• RTCPeerConnectionIceErrorEvent()
  • : Creates and returns a new RTCPeerConnectionIceErrorEvent object, with its type and other properties initialized as specified in the parameters. You will not normally create an object of this type yourself.

Instance properties

The RTCPeerConnectionIceErrorEvent interface includes the properties found on the Event interface, as well as the following properties:

• address Read only
  • : A string providing the local IP address used to communicate with the STUN or TURN server being used to negotiate the connection, or null if the local IP address has not yet been exposed as part of a local ICE candidate.
• errorCode Read only
  • : A positive integer value stating the numeric STUN error code returned by the STUN or TURN server, or 701 if no host candidate can reach the server.
• errorText Read only
  • : A string containing the STUN reason text returned by the STUN or TURN server, or a browser-specific string explaining why communication with the server could not be established.
• port Read only
  • : A positive integer value giving the port number over which communication with the STUN or TURN server is taking place, using the IP address given in address. This is null if the connection hasn’t been established (that is, if address is null).
• url Read 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

See Examples in icecandidateerror.

Specifications

Browser compatibility