RTCSessionDescription

Constructor

RTCSessionDescription()

Creates a new RTCSessionDescription by specifying the type and sdp. All methods that accept RTCSessionDescription objects also accept objects with the same properties, so you can use a plain object instead of creating an RTCSessionDescription instance.

Instance properties

The RTCSessionDescription interface doesn't inherit any properties.

RTCSessionDescription.type Read only

An enum describing the session description's type.

RTCSessionDescription.sdp Read only

A string containing the SDP describing the session.

Instance methods

The RTCSessionDescription doesn't inherit any methods.

RTCSessionDescription.toJSON()

Returns a JSON description of the object. The values of both properties, type and sdp, are contained in the generated JSON.

Example

signalingChannel.onmessage = (evt) => {
  if (!pc) start(false);

  const message = JSON.parse(evt.data);
  if (message.type && message.sdp) {
    pc.setRemoteDescription(
      new RTCSessionDescription(message),
      () => {
        // if we received an offer, we need to answer
        if (pc.remoteDescription.type === "offer") {
          pc.createAnswer(localDescCreated, logError);
        }
      },
      logError,
    );
  } else {
    pc.addIceCandidate(
      new RTCIceCandidate(message.candidate),
      () => {},
      logError,
    );
  }
};

Specifications

Browser compatibility

See also

• WebRTC
• RTCPeerConnection.setLocalDescription() and RTCPeerConnection.setRemoteDescription()