RTCRtpTransceiver
Baseline
Widely available
*
This feature is well established and works across many devices and browser versions. It’s been available across browsers since October 2018.
* Some parts of this feature may have varying levels of support.
The WebRTC interface RTCRtpTransceiver describes a permanent pairing of an RTCRtpSender and an RTCRtpReceiver, along with some shared state.
Each SDP media section describes one bidirectional SRTP ("Secure Real Time Protocol") stream (excepting the media section for RTCDataChannel, if present).
This pairing of send and receive SRTP streams is significant for some applications, so RTCRtpTransceiver is used to represent this pairing, along with other important state from the media section.
Each non-disabled SRTP media section is always represented by exactly one transceiver.
A transceiver is uniquely identified using its mid property, which is the same as the media ID (mid) of its corresponding m-line. An RTCRtpTransceiver is associated with an m-line if its mid is non-null; otherwise it's considered disassociated.
Instance properties
currentDirectionRead only-
A read-only string which indicates the transceiver's current negotiated directionality, or
nullif the transceiver has never participated in an exchange of offers and answers. To change the transceiver's directionality, set the value of thedirectionproperty. direction-
A string which is used to set the transceiver's desired direction.
midRead only-
The media ID of the m-line associated with this transceiver. This association is established, when possible, whenever either a local or remote description is applied. This field is
nullif neither a local or remote description has been applied, or if its associated m-line is rejected by either a remote offer or any answer. receiverRead only-
The
RTCRtpReceiverobject that handles receiving and decoding incoming media. senderRead only-
The
RTCRtpSenderobject responsible for encoding and sending data to the remote peer. stopped-
Indicates whether or not sending and receiving using the paired
RTCRtpSenderandRTCRtpReceiverhas been permanently disabled, either due to SDP offer/answer, or due to a call tostop().
Instance methods
setCodecPreferences()-
Configures the transceiver's preferred list of codecs, overriding user agent settings.
stop()-
Permanently stops the
RTCRtpTransceiver. The associated sender stops sending data, and the associated receiver likewise stops receiving and decoding incoming data.
Specifications
| Specification |
|---|
| WebRTC: Real-Time Communication in Browsers # rtcrtptransceiver-interface |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
RTCRtpTransceiver
|
|
|
|
|
|
|
|
|
|
|
|
|
currentDirection
|
|
|
|
|
|
|
|
|
|
|
|
|
"stopped" value
|
|
|
|
|
|
|
|
|
|
|
|
|
direction
|
|
|
|
|
|
|
|
|
|
|
|
|
"stopped" value
|
|
|
|
|
|
|
|
|
|
|
|
|
getHeaderExtensionsToNegotiate
|
|
|
|
|
|
|
|
|
|
|
|
|
getNegotiatedHeaderExtensions
|
|
|
|
|
|
|
|
|
|
|
|
|
mid
|
|
|
|
|
|
|
|
|
|
|
|
|
receiver
|
|
|
|
|
|
|
|
|
|
|
|
|
sender
|
|
|
|
|
|
|
|
|
|
|
|
|
setCodecPreferences()
|
|
|
|
|
|
|
|
|
|
|
|
|
setHeaderExtensionsToNegotiate
|
|
|
|
|
|
|
|
|
|
|
|
|
stop()
|
|
|
|
|
|
|
|
|
|
|
|
|
stopped
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Deprecated. Not for use in new websites.
See also
- WebRTC API
- Introduction to the Real-time Transport Protocol (RTP)
RTCPeerConnection.addTrack()andRTCPeerConnection.addTransceiver()both create transceiversRTCRtpReceiverandRTCRtpSender