WebRTC
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 MediaStreamTrack.kind of the receiver's RTCRtpReceiver.track, and by extension of the RTCRtpReceiver itself.
init- : An object for specifying any options when creating the new transceiver.
Possible values are:
direction- : The new transceiver's preferred directionality. This value is used to initialize the new RTCRtpTransceiver object's RTCRtpTransceiver.direction property.
sendEncodings- : An array of encodings to allow when sending RTP media from the RTCRtpSender.
This is the same as the
parameter.encodingsarray passed to RTCRtpSender.setParameters().
- : An array of encodings to allow when sending RTP media from the RTCRtpSender.
This is the same as the
streams- : A list of MediaStream objects to add to the transceiver's RTCRtpReceiver; when the remote peer's RTCPeerConnection's RTCPeerConnection.track_event event occurs, these are the streams that will be specified by that event.
- : An object for specifying any options when creating the new transceiver.
Possible values are:
Return value
The RTCRtpTransceiver object which will be used to exchange the media data.
Exceptions
-
TypeError
-
: Thrown if
trackOrKindwas not either"audio"or"video".If the
sendEncodingsargument is used, this error may also be thrown if there is a badly formattedridmember, some but not all encodings contain aridmember, or different encodings have the sameridvalue.
-
-
RangeError
- : Thrown if any of the
sendEncodingsencodings have amaxFrameratevalue less than 0.0, or ascaleResolutionDownByvalue of less than 1.0.
- : Thrown if any of the
-
InvalidStateErrorDOMException- : Thrown if the method is called when the associated connection is closed.
-
InvalidAccessErrorDOMException- : Thrown if the
sendEncodingsargument is used, and contains a read-only parameter other thanrid.
- : Thrown if the
Specifications
Browser compatibility
See also
- WebRTC API
- Introduction to the Real-time Transport Protocol (RTP)
- RTCPeerConnection.addTrack() also creates transceivers
- RTCRtpReceiver and RTCRtpSender
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
