ContextQMD
Back to Content

RTCDataChannelStats

files/en-us/web/api/rtcdatachannelstats/index.md

latest3.7 KB
Original Source

{{APIRef("WebRTC")}}

The RTCDataChannelStats dictionary of the WebRTC API provides statistics related to one {{domxref("RTCDataChannel")}} object on the connection.

The report can be obtained by iterating the {{domxref("RTCStatsReport")}} returned by {{domxref("RTCPeerConnection.getStats()")}} until you find an entry with the type of data-channel.

The data channels statistics may be correlated to a particular channel by comparing the dataChannelIdentifier property to a matching {{domxref("RTCDataChannel.id")}}.

Instance properties

  • {{domxref("RTCDataChannelStats.bytesSent", "bytesSent")}} {{optional_inline}}
    • : A positive integer value indicating the total number of payload bytes sent on the associated RTCDataChannel.
  • {{domxref("RTCDataChannelStats.bytesReceived", "bytesReceived")}} {{optional_inline}}
    • : A positive integer value indicating the total number of payload bytes received on the associated RTCDataChannel.
  • {{domxref("RTCDataChannelStats.dataChannelIdentifier", "dataChannelIdentifier")}} {{optional_inline}}
    • : A positive integer value containing the {{domxref("RTCDataChannel.id", "id")}} of the associated RTCDataChannel.
  • {{domxref("RTCDataChannelStats.label", "label")}} {{optional_inline}}
    • : A string containing the {{domxref("RTCDataChannel.label", "label")}} of the associated RTCDataChannel.
  • {{domxref("RTCDataChannelStats.messagesReceived", "messagesReceived")}} {{optional_inline}}
    • : A positive integer value indicating the total number of message events fired for received messages on the associated RTCDataChannel.
  • {{domxref("RTCDataChannelStats.messagesSent", "messagesSent")}} {{optional_inline}}
    • : A positive integer value indicating the total number of message events fired for sent messages on the channel.
  • {{domxref("RTCDataChannelStats.protocol", "protocol")}} {{optional_inline}}
    • : A string containing the {{domxref("RTCDataChannel.protocol", "protocol")}} of the associated RTCDataChannel.
  • {{domxref("RTCDataChannelStats.state", "state")}}
    • : The {{domxref("RTCDataChannel.readyState", "readyState")}} of the associated RTCDataChannel.

Common instance properties

The following properties are common to all WebRTC statistics objects (See RTCStatsReport for more information).

<!-- RTCStats -->
  • {{domxref("RTCDataChannelStats.id", "id")}}
    • : A string that uniquely identifies the object that is being monitored to produce this set of statistics.
  • {{domxref("RTCDataChannelStats.timestamp", "timestamp")}}
    • : A {{domxref("DOMHighResTimeStamp")}} object indicating the time at which the sample was taken for this statistics object.
  • {{domxref("RTCDataChannelStats.type", "type")}}
    • : A string with the value "data-channel", indicating the type of statistics that the object contains.

Examples

Given a variable myPeerConnection, which is an instance of {{domxref("RTCPeerConnection")}}, the code below uses await to wait for the statistics report, and then iterates it using RTCStatsReport.forEach(). It then filters the dictionaries for just those reports that have the type of data-channel and logs the result.

js
const stats = await myPeerConnection.getStats();

stats.forEach((report) => {
  if (report.type === "data-channel") {
    // Log the channel information
    console.log(report);
  }
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}