RTCPeerConnection: localDescription プロパティ

Baseline 広く利用可能

この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2017年9月以降、すべてのブラウザーで利用可能です。

RTCPeerConnection.localDescription は読み取り専用プロパティで、接続のローカル側のセッションを説明する RTCSessionDescription を返します。まだ設定されていない場合は null となります。

構文

const sessionDescription = peerConnection.localDescription

より基本的なレベルでは、 RTCPeerConnection.pendingLocalDescription のプロパティが null でない場合、その値が返されます。それ以外の場合は、 RTCPeerConnection.currentLocalDescription の値が返されます。このアルゴリズムの詳細と使用理由については、 WebRTC Connectivity ページの Pending and current descriptions を参照してください。

例

この例では localDescription を見て、RTCSessionDescription オブジェクトの type と sdp フィールドを含むアラートを表示します。

const pc = new RTCPeerConnection();
// ...
const sd = pc.localDescription;
if (sd) {
  alert(`Local session: type='${sd.type}'; sdp description='${sd.sdp}'`);
} else {
  alert("No local session yet.");
}