Package io.agora.rtc2.video

Enum Class VideoEncoderConfiguration.ENCODING_PREFERENCE

java.lang.Object

java.lang.Enum<VideoEncoderConfiguration.ENCODING_PREFERENCE>

io.agora.rtc2.video.VideoEncoderConfiguration.ENCODING_PREFERENCE

All Implemented Interfaces:

Serializable, Comparable<VideoEncoderConfiguration.ENCODING_PREFERENCE>, Constable

Enclosing class:

VideoEncoderConfiguration

public static enum VideoEncoderConfiguration.ENCODING_PREFERENCE
extends Enum<VideoEncoderConfiguration.ENCODING_PREFERENCE>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PREFER_AUTO	-1: Adaptive preference.
PREFER_HARDWARE	1: Hardware encoding preference.
PREFER_SOFTWARE	0: Software coding preference.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PREFER_AUTO

public static final VideoEncoderConfiguration.ENCODING_PREFERENCE PREFER_AUTO

-1: Adaptive preference. The SDK automatically selects the optimal encoding type for encoding based on factors such as platform and device type.

PREFER_SOFTWARE

public static final VideoEncoderConfiguration.ENCODING_PREFERENCE PREFER_SOFTWARE

0: Software coding preference. The SDK prefers software encoders for video encoding.

PREFER_HARDWARE

public static final VideoEncoderConfiguration.ENCODING_PREFERENCE PREFER_HARDWARE

1: Hardware encoding preference. The SDK prefers a hardware encoder for video encoding. When the device does not support hardware encoding, the SDK automatically uses software encoding and reports the currently used video encoder type through `hwEncoderAccelerating` in the `onLocalVideoStats` callback.

Method Details

values

public static VideoEncoderConfiguration.ENCODING_PREFERENCE[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static VideoEncoderConfiguration.ENCODING_PREFERENCE valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()