The WebRTC API's RTCErrorEvent
interface represents an error sent to a WebRTC object. It's based on the standard Event
interface, but adds RTC-specific information describing the error, as shown below.
Constructor
RTCErrorEvent()
- Creates and returns a new
RTCErrorEvent
object.
Properties
In addition to the standard properties available on the Event
interface, RTCErrorEvent
also includes the following:
error
Read only- An
RTCError
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 the SDP or what SCTP cause code was at issue).
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 probably RTCPeerConnectionIceErrorEvent
, used by the icecandidateerror
event, which signals an error that has occurred while gathering ICE candidates during connection negotiation.
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCErrorEvent' in that specification. |
Candidate Recommendation | Initial definition. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
RTCErrorEvent | Chrome ? | Edge ? | Firefox ? | IE No support No | Opera ? | Safari ? | WebView Android ? | Chrome Android ? | Firefox Android ? | Opera Android ? | Safari iOS Full support 6 | Samsung Internet Android ? |
error | Chrome ? | Edge ? | Firefox ? | IE No support No | Opera ? | Safari ? | WebView Android ? | Chrome Android ? | Firefox Android ? | Opera Android ? | Safari iOS Full support 6 | Samsung Internet Android ? |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
See also
- WebRTC API
RTCError
- The
error
event occurs on the following interfaces:RTCDataChannel
andRTCDtlsTransport
RTCPeerConnectionIceErrorEvent