RTCErrorEvent

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

The WebRTC API'sRTCErrorEvent interface represents an error sent to a WebRTC object. It's based on the standardEvent interface, but adds RTC-specific information describing the error, as shown below.

Constructor

RTCErrorEvent(): Creates and returns a newRTCErrorEvent object.

Instance properties

In addition to the standard properties available on theEvent interface,RTCErrorEvent also includes the following:

errorRead only: AnRTCError object specifying the error which occurred; this object includes the type of error that occurred, information about where the error occurred (such as which line number in theSDP or whatSCTP cause code was at issue).

Instance methods

No additional methods are provided beyond any found on the parent interface,Event.

Description

There are other data types used for error events in WebRTC, as needed for errors with special information sharing requirements. The most common of these is probablyRTCPeerConnectionIceErrorEvent, used by theicecandidateerror event, which signals an error that has occurred while gathering ICE candidates during connection negotiation.