Module webrtc.java

Package dev.onvoid.webrtc

Enum RTCRtpTransceiverDirection

java.lang.Object

java.lang.Enum<RTCRtpTransceiverDirection>

dev.onvoid.webrtc.RTCRtpTransceiverDirection

All Implemented Interfaces:

Serializable, Comparable<RTCRtpTransceiverDirection>

public enum RTCRtpTransceiverDirection
extends Enum<RTCRtpTransceiverDirection>

Indicates the RTCRtpTransceiver's preferred directionality.

Author:

Alex Andres

Enum Constant Summary

Enum Constants

Enum Constant	Description
INACTIVE	The RTCRtpTransceiver's RTCRtpSender will not offer to send RTP, and will not send RTP.
RECV_ONLY	The RTCRtpTransceiver's RTCRtpSender will not offer to send RTP, and will not send RTP.
SEND_ONLY	The RTCRtpTransceiver's RTCRtpSender sender will offer to send RTP, and will send RTP if the remote peer accepts and sender.getParameters().encodings[i].active is true for any value of i.
SEND_RECV	The RTCRtpTransceiver's RTCRtpSender will offer to send RTP, and will send RTP if the remote peer accepts and sender.getParameters().encodings[i].active is true for any value of i.
STOPPED	The RTCRtpTransceiver will neither send nor receive RTP.

Method Summary

Modifier and Type	Method	Description
static RTCRtpTransceiverDirection	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RTCRtpTransceiverDirection[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SEND_RECV

public static final RTCRtpTransceiverDirection SEND_RECV

The RTCRtpTransceiver's RTCRtpSender will offer to send RTP, and will send RTP if the remote peer accepts and sender.getParameters().encodings[i].active is true for any value of i.

The RTCRtpTransceiver's RTCRtpReceiver will offer to receive RTP, and will receive RTP if the remote peer accepts.

SEND_ONLY

public static final RTCRtpTransceiverDirection SEND_ONLY

The RTCRtpTransceiver's RTCRtpSender sender will offer to send RTP, and will send RTP if the remote peer accepts and sender.getParameters().encodings[i].active is true for any value of i.

The RTCRtpTransceiver's RTCRtpReceiver will not offer to receive RTP, and will not receive RTP.

RECV_ONLY

public static final RTCRtpTransceiverDirection RECV_ONLY

The RTCRtpTransceiver's RTCRtpSender will not offer to send RTP, and will not send RTP.

The RTCRtpTransceiver's RTCRtpReceiver will offer to receive RTP, and will receive RTP if the remote peer accepts.

INACTIVE

public static final RTCRtpTransceiverDirection INACTIVE

The RTCRtpTransceiver's RTCRtpSender will not offer to send RTP, and will not send RTP.

The RTCRtpTransceiver's RTCRtpReceiver will not offer to receive RTP, and will not receive RTP.

STOPPED

public static final RTCRtpTransceiverDirection STOPPED

The RTCRtpTransceiver will neither send nor receive RTP. It will generate a zero port in the offer. In answers, its RTCRtpSender will not offer to send RTP, and its RTCRtpReceiver will not offer to receive RTP. This is a terminal state.

Method Detail

values

public static RTCRtpTransceiverDirection[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RTCRtpTransceiverDirection c : RTCRtpTransceiverDirection.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RTCRtpTransceiverDirection valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null