RTCPeerConnection: currentLocalDescription 屬性

Baseline 已廣泛支援

此特性已相當成熟,可在許多裝置和瀏覽器版本上使用。自 ⁨2020 年 1 月⁩ 起,所有主流瀏覽器均已支援。

RTCPeerConnection 介面的只讀屬性 currentLocalDescription 返回一個 RTCSessionDescription 物件,該物件描述了連線的本地端在最近一次成功協商(自從 RTCPeerConnection 完成協商並連線到遠端對端以來)時的狀態。還包括自描述首次例項化(作為 offer 或 answer)以來 ICE 代理可能已生成的任何 ICE 候選列表。

要更改 currentLocalDescription,請呼叫 RTCPeerConnection.setLocalDescription(),這將觸發一系列事件,最終設定此值。有關具體發生了什麼以及更改不一定瞬時發生的原因的詳細資訊,請參閱 WebRTC 連線頁面上的 掛起和當前描述

注意:RTCPeerConnection.localDescription 不同,此值代表連線本地端的實際當前狀態;localDescription 可能指定連線當前正在切換到的描述。

連線本地端的當前描述,如果已設定。如果尚未成功設定,則此值為 null

示例

此示例檢查 currentLocalDescription 並顯示一個包含 RTCSessionDescription 物件 typesdp 欄位的警報。

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

瀏覽器相容性

注意: currentLocalDescriptionpendingLocalDescription 在 WebRTC 規範中的新增相對較新。在不支援它們的瀏覽器中,請直接使用 localDescription

另見