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 a DOMString which is used as the kind of the receiver's track, and by extension of the RTCRtpReceiver itself.

init Optional

An object that conforms to the RTCRtpTransceiverInit dictionary which provides any options that you may wish to specify 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'sRTCRtpReceiver; when the remote peer's RTCPeerConnection's track 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

Browser compatibility

See also

• WebRTC API
• Introduction to the Real-time Transport Protocol (RTP)
• RTCPeerConnection.addTrack() also creates transceivers
• RTCRtpReceiver and RTCRtpSender