RTCPeerConnection.ondatachannel

The RTCPeerConnection.ondatachannel property is an EventHandler which specifies a function which is called when the datachannel event occurs on an RTCPeerConnection. This event, of type RTCDataChannelEvent, is sent when an RTCDataChannel is added to the connection by the remote peer calling createDataChannel().

At the time this event is received, the RTCDataChannel it indicates may not yet actually be open. Be sure to wait for the "open" event to be fired on the new RTCDataChannel before using the it.

Syntax

RTCPeerConnection.ondatachannel = function;

Value

Set this property to be a function you provide which receives as input a single parameter: an RTCDataChannelEvent which provides in its channel property the RTCDataChannel which has been created.

Example

pc.ondatachannel = function(ev) {
  console.log('Data channel is created!');
  ev.channel.onopen = function() {
    console.log('Data channel is open and ready to be used.');
  };
};

Specifications

Specification	Status	Comment
WebRTC 1.0: Real-time Communication Between Browser The definition of 'RTCPeerConnection.ondatachannel' in that specification.	Working Draft	Initial specification.

Browser compatibility

[1] Though this property is not prefixed, the interface it belongs to is.

[2] This property's name isn't prefixed, but the interface it's in, RTCPeerConnection, was prefixed as MozRTCPeerConnection until Firefox 44.

See also

• The datachannel event and its type, RTCDataChannelEvent.
• RTCPeerConnection.createDataChannel()
• A simple RTCDataChannel sample