RTCPeerConnection: sctp property

Baseline 2023
Newly available

Since May 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

The sctp read-only property of the RTCPeerConnection interface returns an RTCSctpTransport describing the SCTP transport over which SCTP data is being sent and received. If SCTP hasn't been negotiated, this value is null.

The SCTP transport is used for transmitting and receiving data for any and all RTCDataChannels on the peer connection.

Value

A RTCSctpTransport object describing the SCTP transport being used by the RTCPeerConnection for transmitting and receiving on its data channels, or null if SCTP negotiation hasn't happened.

Example

js
const peerConnection = new RTCPeerConnection();
const channel = peerConnection.createDataChannel("Mydata");
channel.onopen = (event) => {
  channel.send("sending a message");
};
channel.onmessage = (event) => {
  console.log(event.data);
};
// Determine the largest message size that can be sent
const sctp = peerConnection.sctp;
const maxMessageSize = sctp.maxMessageSize;

Specifications

Specification
WebRTC: Real-Time Communication in Browsers
# dom-rtcpeerconnection-sctp

Browser compatibility

See also