RTCPeerConnection.currentLocalDescription

The read-only property RTCPeerConnection.currentLocalDescription returns an RTCSessionDescription object describing the local end of the connection as it was most recently successfully negotiated since the last time the RTCPeerConnection 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 the currentLocalDescription, call RTCPeerConnection.setLocalDescription(), 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, see Pending and current descriptions in WebRTC connectivity.

Syntax

sessionDescription = RTCPeerConnection.currentLocalDescription;

Return value

The current description of the local end of the connection, if one has been set. If none has been successfully set, this value is null.

Example

This example looks at the currentLocalDescription and displays an alert containing the RTCSessionDescription object's type and sdp fields.

var pc = new RTCPeerConnection();
…
var sd = pc.currentLocalDescription;
if (sd) {
  alert("Local session: type='" +         
        sd.type + "'; sdp description='" +
        sd.sdp + "'");
}
else {
  alert("No local session yet.");
}

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also

• RTCPeerConnection.setLocalDescription(), RTCPeerConnection.pendingLocalDescription, RTCPeerConnection.localDescription
• RTCPeerConnection.setRemoteDescription(), RTCPeerConnection.remoteDescription, RTCPeerConnection.pendingRemoteDescription, RTCPeerConnection.currentRemoteDescription
• WebRTC