RTCPeerConnection: addTransceiver() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨January 2020⁩.

TheaddTransceiver() method of theRTCPeerConnection interface creates a newRTCRtpTransceiver and adds it to the set of transceivers associated with theRTCPeerConnection.Each transceiver represents a bidirectional stream, with both anRTCRtpSender and anRTCRtpReceiver associated with it.

Syntax

addTransceiver(trackOrKind)addTransceiver(trackOrKind, init)

Parameters

trackOrKind

AMediaStreamTrack to associate with the transceiver, or a string which is used as thekind of the receiver'strack, and by extension of theRTCRtpReceiver itself.

initOptional

An object for specifying any options when creating the new transceiver.Possible values are:

directionOptional: The new transceiver's preferred directionality. This value is used to initialize the newRTCRtpTransceiver object'sRTCRtpTransceiver.direction property.
sendEncodingsOptional: An array of encodings to allow when sending RTP media from theRTCRtpSender.This is the same as theparameter.encodings array passed toRTCRtpSender.setParameters().
streamsOptional: A list ofMediaStream 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.

Return value

TheRTCRtpTransceiver object which will be used to exchange the media data.

Exceptions

TypeError

Thrown iftrackOrKind was not either"audio" or"video".

If thesendEncodings argument is used, this error may also be thrown if there is a badly formattedrid member, some but not all encodings contain arid member, or different encodings have the samerid value.

RangeError