Web/API/RTCDataChannel/id

From Get docs

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


The read-only RTCDataChannel property id returns an ID number (between 0 and 65,534) which uniquely identifies the RTCDataChannel. This ID is set at the time the data channel is created, either by the user agent (if RTCDataChannel.negotiated is false) or by the site or app script (if negotiated is true).

Each RTCPeerConnection can therefore have up to a theoretical maximum of 65,534 data channels on it, although the actual maximum may vary from browser to browser.

In early versions of the WebRTC specification, this property's name was stream. Code that uses that property needs to be updated.


Syntax

var id = aDataChannel.id;

Value

An unsigned short value (that is, an integer between 0 and 65,535) which uniquely identifies the data channel.

While the label property doesn't have to be unique, this ID number is guaranteed to be unique among all data channels. Additionally, known implementations of WebRTC use the same ID on both peers. A unique ID makes it easier for your code to do its own out-of-band data channel-related signaling.

This can be also useful for logging and debugging purposes.

Example

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

console.log("Channel id: " + dc.id);

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between BrowsersThe definition of 'RTCDataChannel.id' 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

id

Experimental'

Chrome

Full support 56

Edge

Full support ≤79

Firefox

No support No

IE

No support No

Opera

Full support 43

Safari

No support No

WebView Android

Full support 56

Chrome Android

Full support 56

Firefox Android

No support No

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.


See also