RTCPeerConnection.ondatachannel

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for the proper prefixes to use in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the spec changes.

The RTCPeerConnection.ondatachannel event handler is a property containing the code to execute when the datachannel event, of type RTCDataChannelEvent, is received by this RTCPeerConnection. Such an event is sent when a RTCDataChannel is added to this connection, in response to the other peer creating a data channel.

Be aware that the data channel available on the datachannel event is not open. Before using the data channel, you should wait for the "open" event to fire.

Syntax

peerconnection.ondatachannel = function;

Values

  • function is the name of a user-defined function, without the () suffix or any parameters, or an anonymous function declaration, such as function(event) {...}. An event handler always has one single parameter, containing the event, here of type RTCDataChannelEvent.

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

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support (Yes) [1] (Yes) [1] Not supported (Yes) ?
Feature Android Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support ? ? ? Not supported ? ?

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

See also

Document Tags and Contributors

 Contributors to this page: so_matt_basta, teoli
 Last updated by: so_matt_basta,