RTCDataChannelEvent()

The RTCDataChannelEvent() constructor creates a new RTCDataChannelEvent.

Note: You will rarely if ever construct an RTCDataChannelEvent by hand; these events are normally created and sent by the WebRTC layer itself.

Syntax

 new RTCDataChannelEvent(type, rtcDataChannelEventInit);

Parameters

type

A string which specifies the name of the event. There is only one type of RTCDataChannelEvent, so this will always be "datachannel".

rtcDataChannelEventInit

An object with the following fields:

  • channel of type RTCDataChannel, representing the data channel being concerned by the event.
  • bubbles, optional, inherited from EventInit. Indicates if the event must bubble or not. Default is false.
  • cancelable, optional, inherited from EventInit. Indicates if the event can be canceled or not. Default is false.

Value

A new RTCDataChannelEvent configured as specified.

Example

In this example, a new datachannel event is created. dc is a data channel which already exists. 

var event = new RTCDataChannelEvent("datachannel", {"channel": dc});

Specifications

Specification
WebRTC 1.0: Real-Time Communication Between Browsers
# dom-rtcdatachannelevent-constructor

Browser compatibility

BCD tables only load in the browser

See also