RTCPeerConnection: datachannel event

A datachannel event is sent to an RTCPeerConnection instance when an RTCDataChannel has been added to the connection, as a result of the remote peer calling RTCPeerConnection.createDataChannel().

Note: This event is not dispatched when the local end of the connection creates the channel.

Bubbles No
Cancelable No
Interface RTCDataChannelEvent
Event handler property ondatachannel

Examples

This example sets up a function that handles datachannel events by gathering the information needed to communicate with the newly added RTCDataChannel and by adding event handlers for the events that occur on that channel.

pc.addEventListener("datachannel", ev => {
  receiveChannel = ev.channel;
  receiveChannel.onmessage = myHandleMessage;
  receiveChannel.onopen = myHandleOpen;
  receiveChannel.onclose = myHandleClose;
}, false);

receiveChannel is set to the value of the event's channel property, which specifies the RTCDataChannel object representing the data channel linking the remote peer to the local one.

This same code can also instead use the RTCPeerConnection interface's ondatachannel event handler property, like this:

pc.ondatachannel = ev => {
  receiveChannel = ev.channel;
  receiveChannel.onmessage = myHandleMessage;
  receiveChannel.onopen = myHandleOpen;
  receiveChannel.onclose = myHandleClose;
}

Specifications

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

Browser compatibility

BCD tables only load in the browser

See also