Back to Content

RTCRtpReceiver

files/en-us/web/api/rtcrtpreceiver/index.md

latest2.7 KB
Original Source

{{APIRef("WebRTC")}}

The RTCRtpReceiver interface of the WebRTC API manages the reception and decoding of data for a {{domxref("MediaStreamTrack")}} on an {{domxref("RTCPeerConnection")}}.

Instance properties

  • {{domxref("RTCRtpReceiver.jitterBufferTarget")}}
    • : A {{domxref("DOMHighResTimeStamp")}} that indicates an application's preferred hold time for media in the jitter buffer, allowing it influence the tradeoff between playout delay and the risk of running out of audio or video frames due to network jitter.
  • {{domxref("RTCRtpReceiver.track")}} {{ReadOnlyInline}}
    • : Returns the {{domxref("MediaStreamTrack")}} associated with the current RTCRtpReceiver instance.
  • {{domxref("RTCRtpReceiver.transport")}} {{ReadOnlyInline}}
    • : Returns the {{domxref("RTCDtlsTransport")}} instance over which the media for the receiver's track is received.
  • {{domxref("RTCRtpReceiver.transform")}}
    • : An {{domxref("RTCRtpScriptTransform")}} is used to insert a transform stream ({{domxref("TransformStream")}}) running in a worker thread into the receiver pipeline, allowing stream transforms to be applied to incoming encoded video and audio frames.

Obsolete properties

  • rtcpTransport {{deprecated_inline}}
    • : This property has been removed; the RTP and RTCP transports have been combined into a single transport. Use the {{domxref("RTCRtpReceiver.transport", "transport")}} property instead.

Static methods

  • {{domxref("RTCRtpReceiver.getCapabilities_static", "RTCRtpReceiver.getCapabilities()")}}
    • : Returns the most optimistic view of the capabilities of the system for receiving media of the given kind.

Instance methods

  • {{domxref("RTCRtpReceiver.getContributingSources()")}}
    • : Returns an array that contains an object for each unique CSRC (contributing source) identifier received by the current RTCRtpReceiver in the last ten seconds.
  • {{domxref("RTCRtpReceiver.getParameters()")}}
    • : Returns an object that contains information about how the RTC data is to be decoded.
  • {{domxref("RTCRtpReceiver.getStats()")}}
    • : Returns a {{jsxref("Promise")}} whose fulfillment handler receives a {{domxref("RTCStatsReport")}} which contains statistics about the incoming streams and their dependencies.
  • {{domxref("RTCRtpReceiver.getSynchronizationSources()")}}
    • : Returns an array that contains an object for each unique SSRC (synchronization source) identifier received by the current RTCRtpReceiver in the last ten seconds.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • WebRTC
  • {{domxref("RTCStatsReport")}}
  • {{domxref("RTCRtpSender")}}
  • {{domxref("RTCPeerConnection.getStats()")}}