在此页

• 句法
• 范例
• 规范
• 浏览器兼容性
• 相关话题

RTCPeerConnection 方法 getStats() returns a promise which resolves with data providing statistics about either the overall connection or about the specified MediaStreamTrack .

句法

promise = rtcPeerConnection.getStats(selector)
					

参数

选择器 可选

MediaStreamTrack for which to gather statistics. If this is null (the default value), statistics will be gathered for the entire RTCPeerConnection .

返回值

A Promise which resolves with an RTCStatsReport object providing connection statistics. The contents of the report depend on the 选择器 as well as other details of the connection.

异常

This method does not throw exceptions; instead, it rejects the returned promise with one of the following errors:

InvalidAccessError

There is no RTCRtpSender or RTCRtpReceiver whose track matches the specified 选择器 ，或 选择器 matches more than one sender or receiver.

Obsolete syntax

先前， getStats() used success and failure callbacks to report the results to you, instead of using a promise.

This version of getStats() is obsolete; in addition, the data it returns is entirely different from the current specification, and the form of that data was never documented. This form of getStats() has been or will soon be removed from most browsers; you should not use it, and should update existing code to use the new promise-based version . Check the 浏览器兼容性 table to verify the state of this method.

promise = rtcPeerConnection.getStats(selector, successCallback, failureCallback)  
						

参数

选择器 可选

MediaStreamTrack for which to gather statistics. If this is null (the default value), statistics will be gathered for the entire RTCPeerConnection .

successCallback

A callback function to call when the stats have been retrieved. The function receives as input a single parameter: an RTCStatsReport with the collected statistics. No output is expected from the function.

failureCallback

A function to call when an error occurs while attempting to collect statistics. The callback receives as input the exception (a DOMException object describing the error which occurred. No return value is expected from the callback.

范例

This example creates a periodic function using setInterval() that collects statistics for an RTCPeerConnection every second, generating an HTML-formatted report and inserting it into a specific element in the DOM.

window.setInterval(function() {
  myPeerConnection.getStats(null).then(stats => {
    let statsOutput = "";
    stats.forEach(report => {
      statsOutput += `<h2>Report: ${report.type}</h3>\n<strong>ID:</strong> ${report.id}<br>\n` +
                     `<strong>Timestamp:</strong> ${report.timestamp}<br>\n`;
      // Now the statistics for this report; we intentially drop the ones we
      // sorted to the top above
      Object.keys(report).forEach(statName => {
        if (statName !== "id" && statName !== "timestamp" && statName !== "type") {
          statsOutput += `<strong>${statName}:</strong> ${report[statName]}<br>\n`;
        }
      });
    });
    document.querySelector(".stats-box").innerHTML = statsOutput;
  });
}, 1000);
							

This works by calling getStats() , then, when the promise is resolved, iterates over the RTCStats objects on the returned RTCStatsReport . A section is created for each report with a header and all of the statistics below, with the type, ID, and timestamp handled specially to place them at the top of the list.

Once the HTML for the report is generated, it is injected into the element whose class is "stats-box" by setting its innerHTML 特性。

规范

规范	状态	注释
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCPeerConnection.getStats()' in that specification.	候选推荐	初始定义。

浏览器兼容性

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request. 更新 GitHub 上的兼容性数据

	桌面						移动
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
getStats	Chrome 58 58 Promise resolves with RTCStatsReport . 54 Promise-based version. 24	Edge 15	Firefox Yes	IE No	Opera 45	Safari 11	WebView Android 58 58 Promise resolves with RTCStatsReport . 54 Promise-based version. Yes	Chrome Android 58 58 Promise resolves with RTCStatsReport . 54 Promise-based version. Yes	Firefox Android Yes	Opera Android 43	Safari iOS Yes	Samsung Internet Android 7.0 7.0 Promise resolves with RTCStatsReport . 6.0 Promise-based version. Yes
可选 MediaStreamTrack argument	Chrome 67	Edge ≤79	Firefox ?	IE No	Opera 54	Safari ?	WebView Android 67	Chrome Android 67	Firefox Android ?	Opera Android 48	Safari iOS ?	Samsung Internet Android 9.0
Uses callbacks instead of promises 弃用	Chrome 24	Edge 15	Firefox 27 — 66	IE No	Opera 45	Safari 11	WebView Android Yes	Chrome Android Yes	Firefox Android ?	Opera Android 43	Safari iOS ?	Samsung Internet Android Yes

图例

完整支持

完整支持

不支持

不支持

兼容性未知 ?

兼容性未知

弃用。不要用于新网站。

弃用。不要用于新网站。

见实现注意事项。

元数据

• 最后修改： Jan 25, 2020

相关话题

1. WebRTC API
2. RTCPeerConnection
3. 构造函数

   1. RTCPeerConnection()
4. 特性

   1. canTrickleIceCandidates
   2. connectionState
   3. currentLocalDescription
   4. currentRemoteDescription
   5. getDefaultIceServers()
   6. iceConnectionState
   7. iceGatheringState
   8. localDescription
   9. onaddstream
   10. onconnectionstatechange
   11. ondatachannel
   12. onicecandidate
   13. oniceconnectionstatechange
   14. onicegatheringstatechange
   15. onidentityresult
   16. onidpassertionerror
   17. onidpvalidationerror
   18. onnegotiationneeded
   19. onpeeridentity
   20. onremovestream
   21. onsignalingstatechange
   22. ontrack
   23. peerIdentity
   24. pendingLocalDescription
   25. pendingRemoteDescription
   26. remoteDescription
   27. sctp
   28. signalingState
5. 方法

   1. addIceCandidate()
   2. addStream()
   3. addTrack()
   4. close()
   5. createAnswer()
   6. createDataChannel()
   7. createOffer()
   8. generateCertificate()
   9. getConfiguration()
   10. getIdentityAssertion()
   11. getReceivers()
   12. getSenders()
   13. getStats()
   14. getStreamById()
   15. getTransceivers()
   16. removeStream()
   17. removeTrack()
   18. restartIce()
   19. setConfiguration()
   20. setIdentityProvider()
   21. setLocalDescription()
   22. setRemoteDescription()
6. 事件

   1. addstream
   2. identityresult
   3. negotiationneeded
   4. removestream
   5. signalingstatechange
7. 继承：

   1. EventTarget
8. Related pages for WebRTC

   1. MediaDevices.getUserMedia()
   2. Navigator.mediaDevices
   3. RTCCertificate
   4. RTCDTMFSender
   5. RTCDTMFToneChangeEvent
   6. RTCDataChannel
   7. RTCDataChannelEvent
   8. RTCDtlsTransport
   9. RTCErrorEvent
   10. RTCIceCandidate
   11. RTCIceTransport
   12. RTCPeerConnectionIceErrorEvent
   13. RTCPeerConnectionIceEvent
   14. RTCRtpReceiver
   15. RTCRtpSender
   16. RTCRtpTransceiver
   17. RTCSctpTransport
   18. RTCSessionDescription
   19. RTCStatsEvent
   20. RTCStatsReport
   21. RTCTrackEvent