web api instance method

RTCPeerConnection: addTransceiver() method

The addTransceiver() method of the RTCPeerConnection interface 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

addTransceiver(trackOrKind)
addTransceiver(trackOrKind, init)

Parameters

trackOrKind
- : A MediaStreamTrack to associate with the transceiver, or a string which is used as the kind of the receiver’s track, and by extension of the RTCRtpReceiver 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’s direction property.
  - sendEncodings Optional
    - : An array of encodings to allow when sending RTP media from the RTCRtpSender. This is the same as the parameter.encodings array passed to setParameters().
  - streams Optional
    - : A list of MediaStream objects to add to the transceiver’s RTCRtpReceiver; when the remote peer’s RTCPeerConnection’s track event occurs, these are the streams that will be specified by that event.

Return value

The RTCRtpTransceiver object which will be used to exchange the media data.

Exceptions

TypeError
- : Thrown if trackOrKind was not either "audio" or "video".
  
  If the sendEncodings argument is used, this error may also be thrown if there is a badly formatted rid member, some but not all encodings contain a rid member, or different encodings have the same rid value.
RangeError
- : Thrown if any of the sendEncodings encodings have a maxFramerate value less than 0.0, or a scaleResolutionDownBy value of less than 1.0.
InvalidStateError DOMException
- : Thrown if the method is called when the associated connection is closed.
InvalidAccessError DOMException
- : Thrown if the sendEncodings argument is used, and contains a read-only parameter other than rid.

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.