Package com.amazonaws.ivs.broadcast

Enum Class BroadcastConfiguration.AspectMode

java.lang.Object

java.lang.Enum<BroadcastConfiguration.AspectMode>

com.amazonaws.ivs.broadcast.BroadcastConfiguration.AspectMode

All Implemented Interfaces:

Serializable, Comparable<BroadcastConfiguration.AspectMode>, Constable

Enclosing class:

BroadcastConfiguration

public static enum BroadcastConfiguration.AspectMode
extends Enum<BroadcastConfiguration.AspectMode>

The AspectMode determines how an image's aspect ratio will be maintained. NONE will simply fill the bounding area with the image, disregarding the aspect ratio. FIT will fit the entire image within the bounding area while maintaining the correct aspect ratio. in practice this means that there will be letterboxing or pillarboxing. FILL will fill the bounding area with the image while maintaining the aspect ratio. in practice this means that the image will likely be cropped.

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
FILL
FIT
NONE

Field Summary

Fields

Modifier and Type	Field	Description
final int	value

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final BroadcastConfiguration.AspectMode NONE

FIT

public static final BroadcastConfiguration.AspectMode FIT

FILL

public static final BroadcastConfiguration.AspectMode FILL

Field Details

value

public final int value

Method Details

values

public static BroadcastConfiguration.AspectMode[] 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 BroadcastConfiguration.AspectMode 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