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

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 RTCRtpTransceiver.direction property.

sendEncodings Optional

A list of encodings to allow when sending RTP media from the RTCRtpSender. Each entry is of type RTCRtpEncodingParameters.

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

None (undefined).

Exceptions

TypeError

Thrown if trackOrKind was not either "audio" or "video".

RangeError

Thrown if any of the sendEncodings encodings have a maxFramerate value less than 0.0.

Specifications

Specification
WebRTC 1.0: Real-Time Communication Between Browsers
# dom-rtcpeerconnection-addtransceiver

Browser compatibility

BCD tables only load in the browser

See also