RTCIceTransport:getLocalCandidates() 方法

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

RTCIceTransport 接口的 getLocalCandidates() 方法返回一个 RTCIceCandidate 对象数组,每个对象对应一个在当前 ICE 代理会话期间由本地设备收集到的候选者。

在 ICE 代理将这些本地候选者通过 icecandidate 事件传递给本地客户端代码之前,会将它们放入此列表中,以便客户端可以将这些候选者转发给远程对等端。

语法

js
getLocalCandidates()

参数

无。

返回值

一个 JavaScript Array,其中包含一个 RTCIceCandidate 对象,代表在 ICE 候选者收集会话期间迄今为止已识别的每个候选者。

您无法将这些本地候选者与匹配的远程候选者关联起来。要查找迄今为止找到的最佳匹配,请调用 RTCIceTransport.getSelectedCandidatePair()

示例

这个简单的示例从 RTCPeerConnection 的第一个 RTCRtpSenderRTCIceTransport 中获取本地候选者列表,然后将列表中的所有候选者输出到控制台。

js
const localCandidates = pc
  .getSenders()[0]
  .transport.iceTransport.getLocalCandidates();

localCandidates.forEach((candidate, index) => {
  console.log(`Candidate ${index}: ${candidate.candidate}`);
});

规范

规范
WebRTC:浏览器中的实时通信
# dom-rtcicetransport-getlocalcandidates

浏览器兼容性