Back to Content

RTCDataChannelEvent: channel property

files/en-us/web/api/rtcdatachannelevent/channel/index.md

latest1.1 KB
Original Source

{{APIRef("WebRTC")}}

The read-only property RTCDataChannelEvent.channel returns the {{domxref("RTCDataChannel")}} associated with the event.

Value

A {{domxref("RTCDataChannel")}} object representing the data channel linking the receiving {{domxref("RTCPeerConnection")}} to its remote peer.

Example

The first line of code in the {{DOMxRef("RTCPeerConnection.datachannel_event", "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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{DOMxRef("RTCPeerConnection.datachannel_event", "datachannel")}}
  • {{domxref("RTCDataChannel")}}
  • A simple RTCDataChannel sample
  • {{domxref("RTCPeerConnection")}}