RTCRtpSender

The RTCRtpSender interface provides the ability to control and obtain details about how a particular MediaStreamTrack 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 an RTCDTMFSender which can be used to send DTMF codes to the remote peer.

Properties

RTCRtpSender.dtmf Read only

An RTCDTMFSender which can be used to send DTMF tones using "telephone-event" payloads on the RTP session represented by the RTCRtpSender object. If null, the track and/or the connection doesn't support DTMF. Only audio tracks can support DTMF.

RTCRtpSender.rtcpTransport Read only

The transport over which Real-time Transport Control Protocol (RTCP) information is exchanged. This value is null before the RTCDtlsTransport object is created. When bundling is in use, more than one RTCRtpSender can share the same transport, sending all RTP and RTCP information over that one transport.

RTCRtpSender.track Read only

The MediaStreamTrack which is being handled by the RTCRtpSender. If track is null, the RTCRtpSender doesn't transmit anything.

RTCRtpSender.transport Read only

The RTCDtlsTransport over which media data for the track is being transmitted. The data is transmitted using RTP packets. Before the transport is established, this value is null.

Methods

RTCRtpSender.getParameters()

Returns a RTCRtpParameters object describing the current configuration for the encoding and transmission of media on the track.

RTCRtpSender.getStats()

Returns a Promise which is fulfilled with a RTCStatsReport which provides statistics data for all outbound streams being sent using this RTCRtpSender.

RTCRtpSender.setParameters()

Applies changes to parameters which configure how the track is encoded and transmitted to the remote peer.

RTCRtpSender.replaceTrack()

Attempts to replace the track currently being sent by the RTCRtpSender 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.

Static methods

RTCRtpSender.getCapabilities()

Returns an RTCRtpCapabilities object describing the system's capabilities for sending a specified kind of media data.

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also

• WebRTC API
• RTCPeerConnection.addTrack()
• RTCPeerConnection.getSenders()
• RTCRtpReceiver