RTCIceCandidateStats

RTCIceCandidateStatsWebRTC API 的一个字典,用于报告与 RTCIceCandidate 相关的统计信息。

可以通过迭代 RTCStatsReport(由 RTCPeerConnection.getStats() 返回)来获取统计信息,直到找到一个类型为 local-candidate 的报告。

实例属性

address 可选

包含候选地址的字符串。此值可以是 IPv4 地址、IPv6 地址或完全限定域名。此属性以前名为 ip,并且仅接受 IP 地址。

候选类型

RTCIceCandidate.type 中的值之一匹配的字符串,指示对象提供哪些统计信息的候选类型。

deleted 可选

一个布尔值,指示候选是否已释放或删除;默认值为 false。对于本地候选,如果候选已删除或释放,则其值为 true。对于主机候选,true 表示与候选关联的任何网络资源(通常是网络套接字)都已释放。对于 TURN 候选,已删除候选的 TURN 分配不再处于活动状态。此属性不存在于远程候选。

port 可选

候选使用的网络端口号。

priority 可选

候选的优先级,对应于 RTCIceCandidate.priority

protocol 可选

指定用于在 port 上传输数据的协议(tcpudp)的字符串。

relayProtocol 可选

一个字符串,标识端点用于与 TURN 服务器通信的协议;有效值为 tcpudptls。仅存在于本地候选。

传输 ID

一个字符串,唯一标识用于获取与这些统计信息对应的候选关联的 RTCTransportStats 的传输对象。

url 可选

对于本地候选,url 属性是接收候选的 ICE 服务器的 URL。此 URL 与表示将候选传递给本地对等方的 RTCPeerConnectionIceEvent 对象中包含的 URL 匹配。

常见实例属性

以下属性在所有 WebRTC 统计信息对象中都通用。

ID

一个唯一标识正在监视以生成此组统计信息的对象的字符串。

时间戳

一个 DOMHighResTimeStamp 对象,指示为该统计信息对象获取样本的时间。

类型

值为 "local-candidate" 的字符串,指示对象包含的统计信息类型。

示例

待定

规范

规范
WebRTC 统计 API 的标识符
# dom-rtcstatstype-local-candidate

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。