RTCPeerConnection: remoteDescription-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 remoteDescription-Eigenschaft der RTCPeerConnection-Schnittstelle gibt eine RTCSessionDescription zurück, die die Sitzung (einschließlich Konfiguration und Medieninformationen) für das entfernte Ende der Verbindung beschreibt. Falls dies noch nicht gesetzt wurde, ist der Wert null.

Der zurückgegebene Wert spiegelt typischerweise eine entfernte Beschreibung wider, die über den Signalisierungsserver empfangen wurde (entweder als Angebot oder als Antwort) und dann durch das Aufrufen von RTCPeerConnection.setRemoteDescription() in Ihrem Code wirksam gemacht wurde.

Syntax

js
const sessionDescription = peerConnection.remoteDescription

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

Beispiel

Dieses Beispiel betrachtet die remoteDescription und zeigt ein Alert-Fenster an, das die Felder type und sdp des RTCSessionDescription-Objekts enthält.

js
const pc = new RTCPeerConnection();
// ...
const sd = pc.remoteDescription;
if (sd) {
  alert(`Remote session: type='${sd.type}'; sdp description='${sd.sdp}'`);
} else {
  alert("No remote session yet.");
}

Spezifikationen

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

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch