RTCIceCandidateStats

Baseline Widely available *

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

* Some parts of this feature may have varying levels of support.

Từ điển RTCIceCandidateStats của WebRTC API được dùng để báo cáo các thống kê liên quan đến một RTCIceCandidate.

Có thể lấy các thống kê bằng cách duyệt qua RTCStatsReport được trả về bởi RTCPeerConnection.getStats() cho đến khi tìm thấy báo cáo có type là local-candidate.

Thuộc tính phiên bản

address Optional: Một chuỗi chứa địa chỉ của ứng viên. Giá trị này có thể là địa chỉ IPv4, địa chỉ IPv6, hoặc tên miền đầy đủ. Thuộc tính này trước đây có tên là ip và chỉ chấp nhận địa chỉ IP. Tương ứng với RTCIceCandidate.address.
candidateType: Một chuỗi khớp với một trong các giá trị trong RTCIceCandidate.type, cho biết loại ứng viên mà đối tượng cung cấp thống kê.
deleted: Một boolean cho biết liệu ứng viên đã bị xóa hoặc giải phóng hay chưa.
foundation Optional Experimental: Một chuỗi xác định duy nhất ứng viên trên nhiều kênh truyền tải. Tương ứng với RTCIceCandidate.foundation.
port Optional: Số cổng mạng được sử dụng bởi ứng viên. Tương ứng với RTCIceCandidate.port.
priority Optional: Mức độ ưu tiên của ứng viên. Tương ứng với RTCIceCandidate.priority.
protocol Optional: Một chuỗi chỉ định giao thức (tcp hoặc udp) được sử dụng để truyền dữ liệu trên port. Tương ứng với RTCIceCandidate.protocol.
relayProtocol: Một chuỗi chỉ định giao thức đang được sử dụng bởi ứng viên ICE cục bộ để giao tiếp với máy chủ TURN.
transportId: Một chuỗi xác định duy nhất đối tượng kênh truyền tải được kiểm tra để lấy RTCTransportStats liên kết với ứng viên tương ứng với các thống kê này.
url Optional: Một chuỗi chỉ định URL của máy chủ ICE từ đó ứng viên được mô tả đã được lấy. Thuộc tính này chỉ có sẵn cho ứng viên cục bộ.
usernameFragment Optional Experimental: Một chuỗi chứa đoạn tên người dùng ICE ("ice-ufrag"). Tương ứng với RTCIceCandidate.usernameFragment.

Thuộc tính phiên bản chung

Các thuộc tính sau đây có ở tất cả các đối tượng thống kê WebRTC.

id: Một chuỗi xác định duy nhất đối tượng đang được giám sát để tạo ra tập hợp thống kê này.
timestamp: Một đối tượng DOMHighResTimeStamp chỉ ra thời điểm lấy mẫu cho đối tượng thống kê này.
type: Một chuỗi có giá trị "local-candidate", chỉ ra loại thống kê mà đối tượng chứa.

Với biến myPeerConnection là một phiên bản của RTCPeerConnection, đoạn code dưới đây sử dụng await để chờ báo cáo thống kê, sau đó duyệt qua nó bằng RTCStatsReport.forEach(). Nó lọc các từ điển chỉ lấy những báo cáo có type là local-candidate và ghi lại kết quả.

const stats = await myPeerConnection.getStats();

stats.forEach((report) => {
  if (report.type === "local-candidate") {
    // Ghi lại thông tin ứng viên ICE
    console.log(report);
  }
});