Package com.amazonaws.ivs.broadcast

Enum Class SubscribeSimulcastConfiguration.InitialLayerPreference

java.lang.Object

java.lang.Enum<SubscribeSimulcastConfiguration.InitialLayerPreference>

com.amazonaws.ivs.broadcast.SubscribeSimulcastConfiguration.InitialLayerPreference

All Implemented Interfaces:

Serializable, Comparable<SubscribeSimulcastConfiguration.InitialLayerPreference>, Constable

Enclosing class:

SubscribeSimulcastConfiguration

public static enum SubscribeSimulcastConfiguration.InitialLayerPreference
extends Enum<SubscribeSimulcastConfiguration.InitialLayerPreference>

A value representing which layer developer would like to receive as the first frame of video delivered to the stream.

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
HIGHEST_QUALITY	The SFU will deliver the highest bitrate layer of video first which optimizes quality, but may increase the time to media.
LOWEST_QUALITY	The SFU will deliver the lowest bitrate layer of video first optimizing bandwidth consumption, as well as time to media.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value

Method Summary

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

LOWEST_QUALITY

public static final SubscribeSimulcastConfiguration.InitialLayerPreference LOWEST_QUALITY

The SFU will deliver the lowest bitrate layer of video first optimizing bandwidth consumption, as well as time to media.

HIGHEST_QUALITY

public static final SubscribeSimulcastConfiguration.InitialLayerPreference HIGHEST_QUALITY

The SFU will deliver the highest bitrate layer of video first which optimizes quality, but may increase the time to media.

Field Details

value

public final int value

Method Details

values

public static SubscribeSimulcastConfiguration.InitialLayerPreference[] 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 SubscribeSimulcastConfiguration.InitialLayerPreference 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