Skip to main content

RTCRtpReceiver

The RTCRtpReceiver interface of the WebRTC API manages the reception and decoding of data for a MediaStreamTrack on an RTCPeerConnection.

MDN Reference

Methods​

getContributingSources()​

getContributingSources(): RTCRtpContributingSource[];

The getContributingSources() method of the RTCRtpReceiver interface returns an array of objects, each corresponding to one CSRC (contributing source) identifier received by the current RTCRtpReceiver in the last ten seconds.

MDN Reference

Returns​

RTCRtpContributingSource[]

getParameters()​

getParameters(): RTCRtpReceiveParameters;

The getParameters() method of the RTCRtpReceiver interface returns an object describing the current configuration for how the receiver's track is decoded.

MDN Reference

Returns​

RTCRtpReceiveParameters

getStats()​

getStats(): Promise<RTCStatsReport>;

The RTCRtpReceiver method getStats() asynchronously requests an RTCStatsReport object which provides statistics about incoming traffic on the owning RTCPeerConnection, returning a Promise whose fulfillment handler will be called once the results are available.

MDN Reference

Returns​

Promise<RTCStatsReport>

getSynchronizationSources()​

getSynchronizationSources(): RTCRtpSynchronizationSource[];

The getSynchronizationSources() method of the RTCRtpReceiver interface returns an array of objects, each corresponding to one SSRC (synchronization source) identifier received by the current RTCRtpReceiver in the last ten seconds.

MDN Reference

Returns​

RTCRtpSynchronizationSource[]

Properties​

jitterBufferTarget​

jitterBufferTarget: number | null;

The jitterBufferTarget property of the RTCRtpReceiver interface is a DOMHighResTimeStamp that indicates the application's preferred duration, in milliseconds, for which the jitter buffer should hold media before playing it out.

MDN Reference

track​

readonly track: MediaStreamTrack;

The track read-only property of the RTCRtpReceiver interface returns the MediaStreamTrack associated with the current RTCRtpReceiver instance.

MDN Reference

transform​

transform: RTCRtpScriptTransform | null;

The transform property of the RTCRtpReceiver object is used to insert a transform stream (TransformStream) running in a worker thread into the receiver pipeline. This allows stream transforms to be applied to encoded video and audio frames as they arrive from the packetizer (before they are played/rendered).

MDN Reference

transport​

readonly transport: RTCDtlsTransport | null;

The read-only transport property of an RTCRtpReceiver object provides the RTCDtlsTransport object used to interact with the underlying transport over which the receiver is exchanging Real-time Transport Control Protocol (RTCP) packets.

MDN Reference