The read-only property RTCPeerConnection.pendingLocalDescription
returns an RTCSessionDescription
object describing a pending configuration change for the local end of the connection. This does not describe the connection as it currently stands, but as it may exist in the near future. Use RTCPeerConnection.currentLocalDescription
or RTCPeerConnection.localDescription
to get the current state of the endpoint. For details on the difference, see Pending and current descriptions in WebRTC connectivity.
Syntax
sessionDescription = RTCPeerConnection.pendingLocalDescription;
Return value
If a local description change is in progress, this is an RTCSessionDescription
describing the proposed configuration. Otherwise, this returns null
.
Example
This example looks at the pendingLocalDescription
to determine whether or not there's a description change being processed.
var pc = new RTCPeerConnection(); … var sd = pc.pendingLocalDescription; if (sd) { // There's a description change underway! } else { // No description change pending }
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCPeerConnection.pendingLocalDescription' in that specification. |
Candidate Recommendation | Initial specification. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
pendingLocalDescription | Chrome Full support 70 | Edge Full support ≤18 | Firefox Full support 22 | IE No support No | Opera
Full support
43
| Safari Full support 11 | WebView Android Full support 70 | Chrome Android Full support 70 | Firefox Android Full support 44 | Opera Android
Full support
43
| Safari iOS Full support Yes | Samsung Internet Android Full support 6.0 |
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
- See implementation notes.
The addition of pendingLocalDescription
and currentLocalDescription
to the WebRTC spec is relatively recent. In browsers which don't support them, only localDescription
is available.