RTCPeerConnection.addTransceiver()
The RTCPeerConnection
method
addTransceiver()
creates a new
RTCRtpTransceiver
and adds it to the set of transceivers associated
with the RTCPeerConnection
. Each transceiver represents a
bidirectional stream, with both an RTCRtpSender
and an
RTCRtpReceiver
associated with it.
Syntax
rtpTransceiver = RTCPeerConnection.addTransceiver(trackOrKind, init);
Parameters
trackOrKind
-
A
MediaStreamTrack
to associate with the transceiver, or aDOMString
which is used as thekind
of the receiver'strack
, and by extension of theRTCRtpReceiver
itself. init
Optional-
An object for specifying any options when creating the new transceiver. Possible values are:
direction
Optional-
The new transceiver's preferred directionality. This value is used to initialize the new
RTCRtpTransceiver
object'sRTCRtpTransceiver.direction
property. sendEncodings
Optional-
A list of encodings to allow when sending RTP media from the
RTCRtpSender
. Each entry is of typeRTCRtpEncodingParameters
. streams
Optional-
A list of
MediaStream
objects to add to the transceiver'sRTCRtpReceiver
; when the remote peer'sRTCPeerConnection
'strack
event occurs, these are the streams that will be specified by that event.
Exceptions
TypeError
-
A string was specified as
trackOrKind
which is not valid. The string must be either"audio"
or"video"
.
Specifications
Specification |
---|
WebRTC 1.0: Real-Time Communication Between Browsers # dom-rtcpeerconnection-addtransceiver |
Browser compatibility
BCD tables only load in the browser
See also
- WebRTC API
- Introduction to the Real-time Transport Protocol (RTP)
RTCPeerConnection.addTrack()
also creates transceiversRTCRtpReceiver
andRTCRtpSender