RTCPeerConnection.pendingRemoteDescription
The read-only property
RTCPeerConnection.pendingRemoteDescription returns an
RTCSessionDescription object describing a pending configuration change
for the remote 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.currentRemoteDescription or
RTCPeerConnection.remoteDescription to get the current session
description for the remote endpoint. For details on the difference, see
Pending and current
descriptions in WebRTC connectivity.
Syntax
sessionDescription = RTCPeerConnection.pendingRemoteDescription;
Return value
If a remote description change is in progress, this is an
RTCSessionDescription describing the proposed configuration. Otherwise,
this returns null.
Example
This example looks at the pendingRemoteDescription to determine whether or
not there's a description change being processed.
var pc = new RTCPeerConnection();
ā¦
var sd = pc.pendingRemoteDescription;
if (sd) {
// There's a description change underway!
}
else {
// No description change pending
}
Specifications
| Specification |
|---|
| WebRTC 1.0: Real-Time Communication Between Browsers # dom-peerconnection-pendingremotedesc |
Browser compatibility
BCD tables only load in the browser
Note: The addition of pendingRemoteDescription and
currentRemoteDescription
to the WebRTC spec is relatively recent. In browsers which don't support them, only
remoteDescription is available.