RTCPeerConnection.remoteDescription
This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.
The read-only property RTCPeerConnection.remoteDescription
returns a RTCSessionDescription
describing the session (which includes configuration and media information) for the remote end of the connection. If this hasn't been set yet, this is null
.
The returned value typically reflects a remote description which has been received over the signaling server (as either an offer or an answer) and then put into effect by your code calling RTCPeerConnection.setRemoteDescription()
in response.
Syntax
var sessionDescription = peerConnection.remoteDescription;
On a more fundamental level, the returned value is the value of RTCPeerConnection.pendingRemoteDescription
if that property isn't null
; otherwise, the value of RTCPeerConnection.currentRemoteDescription
is returned. See "Pending and current descriptions" in WebRTC connectivity for details on this algorithm and why it's used.
Example
This example looks at the remoteDescription
and displays an alert containing the RTCSessionDescription
object's type
and sdp
fields.
var pc = new RTCPeerConnection(); … var sd = pc.remoteDescription; if (sd) { alert("Remote session: type='" + sd.type + "'; sdp description='" + sd.sdp + "'"); } else { alert("No remote session yet."); }
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browser The definition of 'RTCPeerConnection.remoteDescription' in that specification. |
Working Draft | Initial specification. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | (Yes) [1] | (Yes) [1] | No support | (Yes) | ? |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | ? | ? | ? | No support | ? | ? |
[1] Though this property is not prefixed, the interface it belongs to was until Firefox 44.
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | (Yes) [1] | 22 (22) [1] | No support | (Yes) | ? |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | ? | ? | 22.0 (22) | No support | ? | ? |
[1] Though this property is not prefixed, the interface it belongs to is, until Firefox 44.
See also
RTCPeerConnection.setRemoteDescription()
,RTCPeerConnection.pendingRemoteDescription
,RTCPeerConnection.currentRemoteDescription
RTCPeerConnection.setLocalDescription()
,RTCPeerConnection.pendingLocalDescription
,RTCPeerConnection.currentLocalDescription
,RTCPeerConnection.localDescription
- WebRTC
License
© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/rtcpeerconnection/remotedescription