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

瀏覽器相容性