RTCPeerConnection: currentRemoteDescription property

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⁩.

ThecurrentRemoteDescription read-only property of theRTCPeerConnection interface returns anRTCSessionDescription object describing the remote end of the connection as it was most recently successfully negotiated since the last time theRTCPeerConnection finished negotiating and connecting to a remote peer.Also included is a list of any ICE candidates that may already have been generated by the ICE agent since the offer or answer represented by the description was first instantiated.

To change thecurrentRemoteDescription, callRTCPeerConnection.setRemoteDescription(), which triggers a series of events which leads to this value being set.For details on what exactly happens and why the change isn't necessarily instantaneous, seePending and current descriptions in the WebRTC Connectivity page.

Note:UnlikeRTCPeerConnection.remoteDescription, this value represents the actual current state of the local end of the connection;remoteDescription may specify a description which the connection is currently in the process of switching over to.

Value

The current description of the remote end of the connection, if one has been set.If none has been successfully set, this value isnull.

Examples

This example looks at thecurrentRemoteDescription and displays an alert containing theRTCSessionDescription object'stype andsdp fields.

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