The RTCRtpTransceiverDirection type is an enumerated set of strings which are used to describe the directionality of a RTCRtpTransceiver instance. Both the preferred direction and the currentDirection properties are of this type.
Values
The RTCRtpTransceiverDirection type is an enumeration of string values. Each describes how the transceiver's associated RTCRtpSender and RTCRtpReceiver behave as shown in the table below.
| Value | RTCRtpSender behavior
|
RTCRtpReceiver behavior
|
|---|---|---|
"sendrecv"
|
Offers to send RTP data, and will do so if the other peer accepts the connection and at least one of the sender's encodings is active1. | Offers to receive RTP data, and does so if the other peer accepts. |
"sendonly"
|
Offers to send RTP data, and will do so if the other peer accepts the connection and at least one of the sender's encodings is active1. | Does not offer to receive RTP data and will not do so. |
"recvonly"
|
Does not offer to send RTP data, and will not do so. | Offers to receive RTP data, and will do so if the other peer offers. |
"inactive"
|
Does not offer to send RTP data, and will not do so. | Does not offer to receive RTP data and will not do so. |
[1] To determine if a sender has at least one active encoding, the user agent gets its parameters using RTCRtpSender.getParameters(), then looks at the parameters' encodings property; if any of the listed encodings has its active property set to true, the sender has an active encoding.
Specifications
| Specification | Status | Comment |
| WebRTC 1.0: Real-time Communication Between BrowsersThe definition of 'RTCRtpTransceiverDirection' in that specification. | Candidate Recommendation |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
RTCRtpTransceiverDirection
|
Chrome
Full support 69 |
Edge
Full support ≤18 |
Firefox
Full support 59 |
IE
No support No |
Opera
? |
Safari
? |
WebView Android
Full support 69 |
Chrome Android
Full support 69 |
Firefox Android
Full support 59 |
Opera Android
? |
Safari iOS
? |
Samsung Internet Android
Full support 10.0 |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
See also
- WebRTC API
- Introduction to the Real-time Transport Protocol (RTP)
RTCRtpTransceiver.directionandRTCRtpTransceiver.currentDirectionRTCRtpReceiverandRTCRtpSender
RTCRtpTransceiverDirection by Mozilla Contributors is licensed under CC-BY-SA 2.5.
