Package io.agora.rtc2.video

Enum Class VideoEncoderConfiguration.ORIENTATION_MODE

java.lang.Object

java.lang.Enum<VideoEncoderConfiguration.ORIENTATION_MODE>

io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE

All Implemented Interfaces:

Serializable, Comparable<VideoEncoderConfiguration.ORIENTATION_MODE>, Constable

Enclosing class:

VideoEncoderConfiguration

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

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
ORIENTATION_MODE_ADAPTIVE	0: (Default) The output video always follows the orientation of the captured video.
ORIENTATION_MODE_FIXED_LANDSCAPE	1: In this mode, the SDK always outputs videos in landscape (horizontal) mode.
ORIENTATION_MODE_FIXED_PORTRAIT	2: In this mode, the SDK always outputs video in portrait (portrait) mode.

Method Summary

Modifier and Type	Method	Description
int	getValue()
static VideoEncoderConfiguration.ORIENTATION_MODE	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VideoEncoderConfiguration.ORIENTATION_MODE[]	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

ORIENTATION_MODE_ADAPTIVE

public static final VideoEncoderConfiguration.ORIENTATION_MODE ORIENTATION_MODE_ADAPTIVE

0: (Default) The output video always follows the orientation of the captured video. The receiver takes the rotational information passed on from the video encoder. This mode applies to scenarios where video orientation can be adjusted on the receiver. - If the captured video is in landscape mode, the output video is in landscape mode. - If the captured video is in portrait mode, the output video is in portrait mode.

ORIENTATION_MODE_FIXED_LANDSCAPE

public static final VideoEncoderConfiguration.ORIENTATION_MODE ORIENTATION_MODE_FIXED_LANDSCAPE

1: In this mode, the SDK always outputs videos in landscape (horizontal) mode. If the captured video is in portrait mode, the video encoder crops it to fit the output. Applies to situations where the receiving end cannot process the rotational information. For example, CDN live streaming.

ORIENTATION_MODE_FIXED_PORTRAIT

public static final VideoEncoderConfiguration.ORIENTATION_MODE ORIENTATION_MODE_FIXED_PORTRAIT

2: In this mode, the SDK always outputs video in portrait (portrait) mode. If the captured video is in landscape mode, the video encoder crops it to fit the output. Applies to situations where the receiving end cannot process the rotational information. For example, CDN live streaming.

Method Details

values

public static VideoEncoderConfiguration.ORIENTATION_MODE[] 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.ORIENTATION_MODE 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()