RTCDataChannelEvent()
Experimental
This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The RTCDataChannelEvent()
constructor creates a new
RTCDataChannelEvent
.
You will rarely if ever construct an RTCDataChannelEvent
by hand; these
events are normally created and sent by the WebRTC layer itself.
Syntax
var event = new RTCDataChannelEvent(type, rtcDataChannelEventInit);
Parameters
type
- A
DOMString
which specifies the name of the event. There is only one type ofRTCDataChannelEvent
, so this will always be"datachannel"
. rtcDataChannelEventInit
- A
RTCDataChannelEventInit
dictionary, which has following fields:"channel"
of typeRTCDataChannel
, representing the data channel being concerned by the event."bubbles"
, optional, inherited fromEventInit
. Indicates if the event must bubble or not. Default isfalse
."cancelable"
, optional, inherited fromEventInit
. 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 | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCDataChannelEvent' in that specification. |
Candidate Recommendation | Initial specification. |
Browser compatibility
BCD tables only load in the browser