RTCErrorEvent: RTCErrorEvent() constructor

Available in workers

The RTCErrorEvent() constructor creates a new RTCErrorEvent object.

Note that you will not normally create an object of this type yourself.

Syntax

new RTCErrorEvent(type, options)

Parameters

• type
  • : A string with the name of the event. This is usually "error".
• options
  • : An object that, in addition to the properties defined in Event(), can have the following properties:
    • error
      • : A RTCError describing the cause and the location of the error.

Return value

A new RTCErrorEvent object.

Examples

Basic usage

This example shows how you might create an RTCErrorEvent instance.

// Construct an RTCError (used to initialize the event)
const rtcError = new RTCError(
  {
    errorDetail: "sdp-syntax-error",
    sdpLineNumber: 42,
  },
  "SDP syntax error on line 42",
);

// Construct the RTCErrorEvent, passing the RTCError
const event = new RTCErrorEvent("error", {
  error: rtcError, // required
  bubbles: true, // Optional (inherited from Event)
  cancelable: false, // Optional (inherited from Event)
});

Specifications

Browser compatibility