dom / latest / rtcrtpsender.html /

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 simulate the user pressing buttons on a telephone's dial pad) 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.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 the sender is exchanging the RTP and RTCP packets used to manage transmission of media and control data. This value is null until the transport is established. When bundling is in use, more than transceiver may be sharing the same transport object.

Obsolete properties

rtcpTransport Deprecated

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

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.setStreams()

Sets the MediaStream(s) associated with the track being transmitted by this sender.

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 compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
RTCRtpSender
64
13
34
No
51
11
64
64
34
47
11
9.0
createEncodedStreams
86
86
No
No
72
No
86
86
No
61
No
14.0
dtmf
66
79
52
No
53
13.1
66
66
52
47
13.4
9.0
getCapabilities
69
13
No
No
56
12.1
69
69
No
48
12.2
10.0
getParameters
68
79
46
No
55
11
68
68
46
48
11
10.0
getStats
67
13
55
No
54
12.1
67
67
55
48
12.2
9.0
replaceTrack
65
79
34
No
52
11
65
65
34
47
11
9.0
rtcpTransport
75
13
34
No
62
No
75
75
34
54
No
11.0
setParameters
68
79
64
Changes to parameters that should update live now do so starting in Firefox 64.
46
No
55
12.1
68
68
64
Changes to parameters that should update live now do so starting in Firefox 64.
46
48
12.2
10.0
setStreams
76
79
No
No
63
14.1
79
76
No
54
14.5
12.0
track
64
13
34
No
51
11
64
64
34
47
11
9.0
transport
75
13
34
No
62
15.4
75
75
34
54
15.4
11.0

See also

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpSender