RTCPeerConnection: localDescription-Eigenschaft

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

Die schreibgeschützte Eigenschaft localDescription der RTCPeerConnection-Schnittstelle gibt eine RTCSessionDescription zurück, die die Sitzung für das lokale Ende der Verbindung beschreibt. Wenn sie noch nicht gesetzt wurde, ist dies null.

Wert

Auf einer grundsätzlicheren Ebene ist der zurückgegebene Wert der Wert von RTCPeerConnection.pendingLocalDescription, wenn diese Eigenschaft nicht null ist; andernfalls wird der Wert von RTCPeerConnection.currentLocalDescription zurückgegeben. Weitere Informationen zu diesem Algorithmus und warum er verwendet wird, finden Sie unter Ausstehende und aktuelle Beschreibungen auf der WebRTC-Konnektivitätsseite.

Beispiel

Dieses Beispiel betrachtet die localDescription und zeigt einen Alarm mit den Feldern type und sdp des RTCSessionDescription-Objekts an.

js
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.");
}

Spezifikationen

Specification
WebRTC: Real-Time Communication in Browsers
# dom-peerconnection-localdescription

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch