RTCDataChannelEvent()

Jump to:

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);

type

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

rtcDataChannelEventInit

A RTCDataChannelEventInit dictionary, which has 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.

A new RTCDataChannelEvent configured as specified.

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

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

Specification	Status	Comment
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCDataChannelEvent' in that specification.	Candidate Recommendation	Initial specification.

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Edge Mobile	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
Basic support	Chrome Full support 57	Edge ?	Firefox Full support 22	IE ?	Opera Full support 44	Safari ?	WebView Android Full support 57	Chrome Android Full support 57	Edge Mobile ?	Firefox Android Full support 22	Opera Android Full support 44	Safari iOS ?	Samsung Internet Android Full support 7.0

Tags:

Contributors to this page: fscholz, Sheppy, teoli

Last updated by: fscholz, Feb 13, 2018, 6:09:58 AM