RTCRtpTransceiver
The WebRTC interface RTCRtpTransceiver
describes a permanent pairing of an RTCRtpSender
(en-US) and an RTCRtpReceiver
(en-US), along with some shared state.
Each SDP (en-US) media section describes one bidirectional SRTP ("Secure Real Time Protocol") stream (excepting the media section for RTCDataChannel
(en-US), 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
(en-US) 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.
Properties
currentDirection
(en-US) Schreibgeschützt- A string from the enum
RTCRtpTransceiverDirection
(en-US) which indicates the transceiver's current directionality, ornull
if the transceiver is stopped or has never participated in an exchange of offers and answers. direction
- A string from the enum
RTCRtpTransceiverDirection
(en-US) which is used to set the transceiver's desired direction. mid
(en-US) Schreibgeschützt- 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
null
if 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. receiver
(en-US) Schreibgeschützt- The
RTCRtpReceiver
(en-US) object that handles receiving and decoding incoming media. sender
(en-US) Schreibgeschützt- The
RTCRtpSender
(en-US) object responsible for encoding and sending data to the remote peer. stopped
(en-US)- Indicates whether or not sending and receiving using the paired
RTCRtpSender
andRTCRtpReceiver
has been permanently disabled, either due to SDP offer/answer, or due to a call tostop()
(en-US).
Methods
setCodecPreferences()
(en-US)- A list of
RTCRtpCodecParameters
(en-US) objects which override the default preferences used by the user agent for the transceiver's codecs. stop()
(en-US)- Permanently stops the
RTCRtpTransceiver
. The associated sender stops sending data, and the associated receiver likewise stops receiving and decoding incoming data.
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers Die Definition von 'RTCRtpTransceiver' in dieser Spezifikation. |
Anwärter Empfehlung |
Browser compatibility
BCD tables only load in the browser