RTCDataChannel: label property

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨January 2020⁩.

The read-onlyRTCDataChannel propertylabelreturns a string containing a name describing the data channel. Theselabels are not required to be unique.

You may use the label as you wish; you could use it to identify all the channels thatare being used for the same purpose, by giving them all the same name. Or you could giveeach channel a unique label for tracking purposes. It's entirely up to the designdecisions made when building your site or app.

A unique ID can be found in theid property.

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

Value

A string identifier assigned by the website or app when the data channel was created,as specified whenRTCPeerConnection.createDataChannel() was called tocreate the channel.

Example

This sample creates a data channel on anRTCPeerConnection, then, sometime later, sets the content of a UI element to display the channel's name.

const pc = new RTCPeerConnection();const dc = pc.createDataChannel("my channel");// …document.getElementById("channel-name").appendChild(  Object.assign(document.createElement("span"), {    className: "channelName",    textContent: dc.label,  }),);