RTCPeerConnection:currentLocalDescription 属性
currentLocalDescription
是 RTCPeerConnection
接口的只读属性,它返回一个 RTCSessionDescription
对象,该对象描述了连接本地端在上次 RTCPeerConnection
完成协商并连接到远程对等体后,最近一次成功协商的结果。还包括自描述表示的提议或应答首次实例化以来,ICE 代理可能已经生成的任何 ICE 候选者的列表。
要更改 currentLocalDescription
,请调用 RTCPeerConnection.setLocalDescription()
,这将触发一系列事件,最终导致此值被设置。有关确切发生的情况以及为什么更改并非一定立即发生的详细信息,请参阅 WebRTC 连接页面中的 挂起描述和当前描述。
注意:与 RTCPeerConnection.localDescription
不同,此值表示连接本地端的实际当前状态;localDescription
可能指定连接当前正在切换到的描述。
值
连接本地端的当前描述(如果已设置)。如果尚未成功设置,则此值为 null
。
示例
此示例查看 currentLocalDescription
并显示一个警报,其中包含 RTCSessionDescription
对象的 type
和 sdp
字段。
js
const pc = new RTCPeerConnection();
// ...
const sd = pc.currentLocalDescription;
if (sd) {
alert(`Local session: type='${sd.type}'; sdp description='${sd.sdp}'`);
} else {
alert("No local session yet.");
}
规范
规范 |
---|
WebRTC:浏览器中的实时通信 # dom-peerconnection-currentlocaldesc |
浏览器兼容性
BCD 表格仅在启用 JavaScript 的浏览器中加载。
注意:向 WebRTC 规范添加 currentLocalDescription
和 pendingLocalDescription
是最近才完成的。在不支持它们的浏览器中,只需使用 localDescription
。