RTCRtpReceiver: transform property

Value

A RTCRtpScriptTransform, or null if the receiver has no associated transform stream.

Example

Note that this is part of a larger example in the guide topic Using WebRTC Encoded Transforms.

Adding a transform for incoming frames

This example shows how you add a WebRTC encoded transform to modify an incoming stream. The code assumes that there is an RTCPeerConnection called peerConnection that is already connected to a remote peer.

To add a transform stream into the pipeline for incoming frames we need to construct an RTCRtpScriptTransform and assign it to the receiver's transform property. We can do this in the track event handler as shown. This event is fired on the peer connection whenever the remote end sends a track. The event.receiver property is an RTCRtpReceiver.

const worker = new Worker("worker.js");
peerConnection.ontrack = (event) => {
  event.receiver.transform = new RTCRtpScriptTransform(worker, {
    someOption: "receiverTransform",
  });
};

Because the transform is constructed immediately after creation of the RTCRtpReceiver, it will receive the first incoming frame. The object passed as the second parameter in the RTCRtpScriptTransform constructor is sent to the worker thread, and can be used by worker code to provide a different transform for the incoming frames than is used for outgoing frames.

Specifications

Browser compatibility

See also

• Using WebRTC Encoded Transforms
• RTCRtpSender.transform