RTCIceCandidate:toJSON() 方法
RTCIceCandidate
的 toJSON()
方法将其调用的 RTCIceCandidate
转换为 JSON 格式。
通过在返回的对象上调用 stringify()
来获取对象的字符串版本。
语法
js
toJSON()
参数
无参数。
返回值
一个具有以下属性的 JSON 对象,这些属性已设置为 RTCIceCandidate
对象中的相应值。
candidate
可选-
候选者的网络连接信息的字符串。更多信息可以查阅
RTCIceCandidate.candidate
。 sdpMid
可选-
一个包含候选者关联的媒体流的标识标签的字符串,如果没有关联的媒体流,则为
null
。更多信息可以查阅RTCIceCandidate.sdpMid
。 sdpMLineIndex
可选-
一个包含候选者关联的媒体行(m-line)的从零开始的索引号,位于媒体描述的 SDP 中,如果不存在关联则为
null
。更多信息可以查阅RTCIceCandidate.sdpMLineIndex
。 usernameFragment
可选-
一个包含用户名片段(通常简称为“ufrag”或“ice-ufrag”)的字符串。其连同 ICE 密码(“ice-pwd”),作为一个正在进行的 ICE 交互的唯一标识(包括所有与 STUN 服务器的通信)。更多信息可以查阅
RTCIceCandidate.usernameFragment
。
备注:
返回的 JSON 对象的格式/属性,与传递给 RTCIceCandidate()
构造函数的配置候选者的 candidateInfo
对象相同。
示例
这个简单的示例获取变量 candidate
中构建表示一个 RTCIceCandidate
的 JSON 字符串。
js
let jsonString = candidate.toJSON().stringify();
规范
Specification |
---|
WebRTC: Real-Time Communication in Browsers # dom-rtcicecandidate-tojson |
浏览器兼容性
BCD tables only load in the browser