WebRTCwindow_and_dedicated
The RTCError interface of the WebRTC API describes an error which has occurred while handling RTC operations.
It's based upon the standard DOMException interface that describes general DOM errors.
Constructor
- RTCError.RTCError
- : Creates and returns a new
RTCErrorobject instance.
- : Creates and returns a new
Instance properties
Also inherits properties from its parent interface, DOMException.
- RTCError.errorDetail
- : A string specifying the WebRTC-specific error code identifying the type of error that occurred.
- RTCError.receivedAlert
- : A positive integer value indicating the fatal DTLS error received from the network.
Only valid if the
errorDetailstring isdtls-failure. Ifnull, no DTLS error was received.
- : A positive integer value indicating the fatal DTLS error received from the network.
Only valid if the
- RTCError.sctpCauseCode
- : An integer specifying the SCTP cause code indicating the cause of the failed SCTP negotiation.
Set if
errorDetailissctp-failure.nullif the error isn't an SCTP error.
- : An integer specifying the SCTP cause code indicating the cause of the failed SCTP negotiation.
Set if
- RTCError.sdpLineNumber
- : An integer identifying the line number of the SDP on which the syntax error occurred.
Set if
errorDetailissdp-syntax-error.nullif the error isn't an SDP syntax error.
- : An integer identifying the line number of the SDP on which the syntax error occurred.
Set if
- RTCError.sentAlert
- : A positive integer indicating the fatal DTLS error that was sent out by this device.
Set if
errorDetailisdtls-failure. Ifnull, no DTLS error was transmitted.
- : A positive integer indicating the fatal DTLS error that was sent out by this device.
Set if
[!NOTE] All
RTCErrorobjects have their DOMException.name set toOperationError.
Examples
Basic usage
In this example, a handler is established for an RTCDataChannel's RTCDataChannel.error_event event.
dataChannel.addEventListener("error", (event) => {
let error = event.error; // event.error is an RTCError
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—as indicated by the RTCError.errorDetail property being set to sdp-syntax-error— a message string is constructed to present the error message and line number within the SDP message where 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 EventTarget.addEventListener to add the handler for error events.
You can also use the RTCDataChannel object's RTCDataChannel.error_event event handler property, like this:
dataChannel.onerror = (event) => {
let error = event.error;
/* and so forth */
};
Specifications
Browser compatibility
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
