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

浏览器兼容性