RTCDataChannel.label

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage 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 specification changes.

The read-only RTCDataChannel property label returns a DOMString containing a name describing the data channel. These labels are not required to be unique.

You may use the label as you wish; you could use it to identify all the channels that are being used for the same purpose, by giving them all the same namel. Or you could give each channel a unique label for tracking purposes. It's entirely up to the design decisions made when building your site or app.

A unique ID can be found in the id property.

A data channel's label is set when the channel is created by calling RTCPeerConnection.createDataChannel(). It cannot be changed after that.

Syntax

var name = aDataChannel.label;

Value

A string identifier assigned by the Web site or app when the data channel was created, as specified when RTCPeerConnection.createDataChannel() was called to create the channel.

Example

This sample creates a data channel on an RTCPeerConnection, then, some time later, sets the content of a UI element to display the channel's name.

var pc = new RTCPeerConnection();
var dc = pc.createDataChannel("my channel");

/* ... */

document.getElementById("channel-name").innerHTML =
          "<span class='channelName'>" + dc.label + "</span>";

Specifications

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

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support (Yes) 24 (24) [1] No support (Yes) ?
Feature Android Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support 28 [2] 24.0 (24) [1] No support No support No support (Yes)

[1] The interface is called DataChannel and not RTCDataChannel in Firefox. However, a binding has been in place since Firefox 24 so that either name will work.

[2] WebRTC, including RTCDataChannel, was introduced in Chrome 28 for Android behind a flag, and enabled by default starting in Chrome 29 for Android.

See also

Document Tags and Contributors

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