RTCRtpSender

BaselineWidely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2018.

* Some parts of this feature may have varying levels of support.

TheRTCRtpSender interface provides the ability to control and obtain details about how a particularMediaStreamTrack is encoded and sent to a remote peer.

With it, you can configure the encoding used for the corresponding track, get information about the device's media capabilities, and so forth. You can also obtain access to anRTCDTMFSender which can be used to sendDTMF codes (to simulate the user pressing buttons on a telephone's dial pad) to the remote peer.

Instance properties

RTCRtpSender.dtmfRead only: AnRTCDTMFSender which can be used to sendDTMF tones usingtelephone-event payloads on theRTP session represented by theRTCRtpSender object. Ifnull, the track and/or the connection doesn't support DTMF. Only audio tracks can support DTMF.
RTCRtpSender.trackRead only: TheMediaStreamTrack which is being handled by theRTCRtpSender. Iftrack isnull, theRTCRtpSender doesn't transmit anything.
RTCRtpSender.transportRead only: TheRTCDtlsTransport over which the sender is exchanging the RTP and RTCP packets used to manage transmission of media and control data. This value isnull until the transport is established. When bundling is in use, more than transceiver may be sharing the same transport object.
RTCRtpSender.transform: AnRTCRtpScriptTransform is used to insert a transform stream (TransformStream) running in a worker thread into the sender pipeline, allowing stream transforms to be applied to encoded video and audio frames after they are output by a codec, and before they are sent.

Obsolete properties

rtcpTransportDeprecated: This property has been removed; the RTP and RTCP transports have been combined into a single transport. Use thetransport property instead.

Static methods

RTCRtpSender.getCapabilities(): Returns an object describing the system's capabilities for sending a specified kind of media data.

Instance methods

RTCRtpSender.getParameters(): Returns an object describing the current configuration for the encoding and transmission of media on thetrack.
RTCRtpSender.getStats(): Returns aPromise which is fulfilled with aRTCStatsReport which provides statistics data for all outbound streams being sent using thisRTCRtpSender.
RTCRtpSender.setParameters(): Applies changes to parameters which configure how thetrack is encoded and transmitted to the remote peer.
RTCRtpSender.setStreams(): Sets thestream(s) associated with thetrack being transmitted by this sender.
RTCRtpSender.replaceTrack(): Attempts to replace the track currently being sent by theRTCRtpSender with another track, without performing renegotiation. This method can be used, for example, to toggle between the front- and rear-facing cameras on a device.