dom / latest / rtcpeerconnection / addtransceiver.html /

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.

Exceptions

TypeError

A string was specified as trackOrKind which is not valid. The string must be either "audio" or "video".

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
addTransceiver
69
79
59
No
No
11
69
69
59
No
11
10.0
init_direction_parameter
69
79
59
No
No
11
69
69
59
No
11
10.0
init_sendEncodings_parameter
69
79
No
sendEncodings is not yet implemented in Firefox. See bug 1396918.
No
No
14.1
69
69
No
sendEncodings is not yet implemented in Firefox. See bug 1396918.
No
14.5
10.0
init_streams_parameter
69
79
59
No
No
12.1
69
69
59
No
12.2
10.0

See also

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/addTransceiver