The RTCError
interface describes an error which has occurred while handling WebRTC operations. It's based upon the standard DOMException
interface that describes general DOM errors.
Constructor
RTCError()
- Creates and returns a new
RTCError
object initialized with the properties of the providedRTCErrorInit
dictionary and, optionally, a string to use as the value of the error'smessage
property.
Properties
In addition to the properties defined by the parent interface, DOMException
, RTCError
includes the following properties:
errorDetail
Read only- A
DOMString
specifying the WebRTC-specific error code identifying the type of error that occurred. receivedAlert
Read only- An unsigned long integer value indicating the fatal DTLS error which was received from the network. Only valid if the
errorDetail
string isdtls-failure
. Ifnull
, no DTLS error was received. sctpCauseCode
Read only- If
errorDetail
issctp-failure
, this property is a long integer specifying the SCTP cause code indicating the cause of the failed SCTP negotiation.null
if the error isn't an SCTP error. sdpLineNumber
Read only- If
errorDetail
issdp-syntax-error
, this property is a long integer identifying the line number of the SDP on which the syntax error occurred.null
if the error isn't an SDP syntax error. sentAlert
Read only- If
errorDetail
isdtls-failure
, this property is an unsigned long integer indicating the fatal DTLS error that was sent out by this device. Ifnull
, no DTLS error was transmitted.
All RTCError
objects have their name
set to OperationError
.
Examples
In this example, a handler is established for an RTCDataChannel
's error
event.
dataChannel.addEventListener("error", (event) => { let error = event.error; if (error.errorDetail === "sdp-syntax-error") { let errLine = error.sdpLineNumber; let errMessage = error.message; let alertMessage = `A syntax error occurred interpreting line ${errLine} of the SDP: ${errMessage}`; showMyAlertMessage("Data Channel Error", alertMessage); } else { terminateMyConnection(); } });
If the error is an SDP syntax error—indicated by its errorDetail
property being sdp-syntax-error
—, a message string is constructed to present the error message and the line number within the SDP at which the error occurred. This message is then displayed using a function called showMyAlertMessage()
, which stands in for whatever output mechanism this code might use.
Any other error is treated as terminal, causing a terminateMyConnection()
function to be called.
The above example uses addEventListener()
to add the handler for error
events. You can also use the RTCDataChannel
object's onerror
event handler property, like this:
dataChannel.onerror = (event) => { let error = event.error; /* and so forth */ };
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCError' in that specification. |
Candidate Recommendation | Initial definition. |
Browser compatibility
No compatibility data found. Please contribute data for "api.RTCError" (depth: 1) to the MDN compatibility data repository.