RTCDataChannelEvent: channel property

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

The read-only property RTCDataChannelEvent.channel returns the RTCDataChannel associated with the event.

Value

A RTCDataChannel object representing the data channel linking the receiving RTCPeerConnection to its remote peer.

Example

The first line of code in the datachannel event handler shown below takes the channel from the event object and saves it locally for use by the code handling data traffic.

js
pc.ondatachannel = (event) => {
  inboundDataChannel = event.channel;
  inboundDataChannel.onmessage = handleIncomingMessage;
  inboundDataChannel.onopen = handleChannelOpen;
  inboundDataChannel.onclose = handleChannelClose;
};

Specifications

Specification
WebRTC: Real-Time Communication in Browsers
# dom-datachannelevent-channel

Browser compatibility

BCD tables only load in the browser

See also