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 the WebRTC Connectivity page.
Note: Unlike RTCPeerConnection.localDescription
, this value represents the actual current state of the local end of the connection; localDescription
may specify a description which the connection is currently in the process of switching over to.