RTCPeerConnection.setRemoteDescription()

The RTCPeerConnection.setRemoteDescription() method changes the remote description associated with the connection. This description specifies the properties of the remote end of the connection, including the media format. The actual connection is affected by this change, so it must be able to support both the old and new descriptions in order for the change to actually take place. The method takes a single parameter—the session description—and it returns a Promise which is fulfilled once the description has been changed, asynchronously.

This is typically called after receiving an offer or answer from another peer over the signaling server.

Syntax

aPromise = pc.setRemoteDescription(sessionDescription);

pc.setRemoteDescription(sessionDescription, successCallback, errorCallback);  

Parameters

sessionDescription

An RTCSessionDescriptionInit or RTCSessionDescription which specifies the configuration of the remote end of the connection.

Return value

A Promise which is fulfilled once the value of RTCPeerConnection.remoteDescription is successfully changed or rejected if the change cannot be applied (for example, if the specified description is incompatible with one or both of the peers on the connection).

Deprecated parameters

In older code and documentation, you may see a callback-based version of this function used. This has been deprecated and its use is strongly discouraged. You should update any existing code to use the Promise-based version of setRemoteDescription() instead. The parameters for the older form of setRemoteDescription() are described below, to aid in updating existing code.

successCallback

A JavaScript Function which accepts no input parameters to be be called once the description has been successfully set. At that time, the offer can be sent to a remote peer via the signaling server.

errorCallback

A function matching the signautre RTCPeerConnectionErrorCallback which gets called if the description can't be set. It takes one input parameter:

• errorInformation: A DOMString describing the reason why the description couldn't be set.

This deprecated form of the method returns instantaneously without waiting for the actual setting to be done: in case of success, the successCallback will be called; in case of failure, the errorCallback will be called.

Deprecated exceptions

When using the deprecated callback-based version of setRemoteDescription(), the following exceptions may occur:

InvalidStateError

The connection's signalingState is "closed", indicating that the connection is not currently open, so negotiation cannot take place.

InvalidSessionDescriptionError

The RTCSessionDescription specified by the sessionDescription parameter is invalid.

Example

// TBD

Specifications

Browser compatibility

[1] Though this property is not prefixed, the interface it belongs to is, until Firefox 44.

See also

• WebRTC
• RTCPeerConnection.remoteDescription, RTCPeerConnection.pendingRemoteDescription, RTCPeerConnection.currentRemoteDescription