Web/API/RTCDataChannel/label

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

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 name. 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 BrowsersThe definition of 'RTCDataChannel.label' in that specification.	Candidate Recommendation	Initial specification.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`label` Experimental'	Chrome Full support 56	Edge Full support ≤79	Firefox Full support Yes	IE No support No	Opera Full support 43	Safari No support No	WebView Android Full support 56	Chrome Android Full support 56	Firefox Android Full support Yes	Opera Android Full support 43	Safari iOS No support No	Samsung Internet Android Full support 6.0

Legend

Full support: Full support
No support: No support
Experimental. Expect behavior to change in the future.': Experimental. Expect behavior to change in the future.