RTCIceCandidate: toJSON() 方法

Baseline 已廣泛支援

此功能已成熟,可跨多種裝置和瀏覽器版本使用。自 2017 年 9 月以來,它已在瀏覽器中提供。

RTCIceCandidate 方法 toJSON() 將其呼叫的 RTCIceCandidate 物件轉換為 JSON。

然後可以透過在返回的物件上呼叫 stringify() 來獲得該物件的字串化版本。

語法

js
toJSON()

引數

無。

返回值

包含以下屬性的 JSON 物件,這些屬性已設定為 RTCIceCandidate 物件中對應的值

candidate 可選

一個描述 candidate 的網路連線資訊的字串。更多資訊可以在 RTCIceCandidate.candidate 中找到。

sdpMid 可選

一個字串,包含與 candidate 關聯的媒體流的識別符號標籤,如果不存在關聯的媒體流,則為 null。更多資訊可以在 RTCIceCandidate.sdpMid 中找到。

sdpMLineIndex 可選

一個數字屬性,包含與 candidate 關聯的 m-line 在媒體描述的 SDP 中的零基索引,如果沒有此類關聯,則為 null。更多資訊可以在 RTCIceCandidate.sdpMLineIndex 中找到。

usernameFragment 可選

一個字串,包含使用者名稱片段(通常簡稱為 "ufrag" 或 "ice-ufrag")。此片段以及 ICE 密碼 ("ice-pwd") 唯一標識一個正在進行的 ICE 互動(包括與 STUN 伺服器的任何通訊)。更多資訊可以在 RTCIceCandidate.usernameFragment 中找到。

注意:返回的 JSON 物件具有與 RTCIceCandidate() 建構函式中可選傳遞以配置 candidate 的 candidateInfo 物件相同的形式/屬性。

示例

這個簡單的例子獲取了一個表示變數 candidate 中找到的 RTCIceCandidate 的 JSON 字串。

js
let jsonString = candidate.toJSON().stringify();

規範

規範
WebRTC:瀏覽器中的即時通訊
# dom-rtcicecandidate-tojson

瀏覽器相容性