RTCRtpTransceiver.direction

The RTCRtpTransceiver property direction is a string which indicates the transceiver's preferred directionality.

Its value must be one of the strings defined by the RTCRtpTransceiverDirection enumeration.

The transceiver's current direction is indicated by the currentDirection property.

Syntax

var direction = RTCRtpTransceiver.direction

Value

A DOMString whose value is one of the strings which are a member of the RTCRtpTransceiverDirection enumerated type, indicating the transceiver's preferred direction.

The RTCRtpTransceiverDirection type is an enumeration of string values. Each describes how the transceiver's associated RTCRtpSender and RTCRtpReceiver behave as shown in the table below.

To determine if a sender has at least one active encoding, the user agent gets its parameters using RTCRtpSender.getParameters(), then looks at the parameters' encodings property; if any of the listed encodings has its active property set to true, the sender has an active encoding.

Exceptions

When setting the value of direction, the following exceptions can occur:

InvalidStateError

Either the receiver's RTCPeerConnection is closed or the RTCRtpReceiver is stopped.

Usage notes

Setting the direction

When you change the value of direction, an InvalidStateError exception will occur if the connection is closed or the receiver is stopped.

If the new value of direction is in fact different from the existing value, renegotiation of the connection is required, so a negotiationneeded event is sent to the RTCPeerConnection.

Effect on offers and answers

The value of direction is used by RTCPeerConnection.createOffer() or RTCPeerConnection.createAnswer() in order to generate the SDP generated by each of those methods. The SDP contains an a-line which specifies the directionality. For example, if the direction is specified as "sendrecv", the corresponding SDP a-line is:

a=sendrecv

Specifications

Browser compatibility

See also

• RTCRtpTransceiver.currentDirection