Package com.amazonaws.ivs.broadcast

Enum Class TransmissionStats.NetworkHealth

java.lang.Object

java.lang.Enum<TransmissionStats.NetworkHealth>

com.amazonaws.ivs.broadcast.TransmissionStats.NetworkHealth

All Implemented Interfaces:

Serializable, Comparable<TransmissionStats.NetworkHealth>, Constable

Enclosing class:

TransmissionStats

public static enum TransmissionStats.NetworkHealth
extends Enum<TransmissionStats.NetworkHealth>

NetworkHealth represents the current health of the network. BAD means the network is struggling to keep up and the broadcast may be experiencing latency spikes. The SDK may also reduce the quality of the broadcast on low values in order to keep it stable, depending on the minimum allowed bitrate in the broadcast configuration. A value of EXCELLENT means the network is easily able to keep up with the current demand and the SDK will be trying to increase the broadcast quality over time, depending on the maximum allowed bitrate. Values like MEDIUM or LOW are not necessarily bad, it just means the network is being saturated, but it is still able to keep up. The broadcast is still likely stable.

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
BAD
EXCELLENT
HIGH
LOW
MEDIUM

Method Summary

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

EXCELLENT

public static final TransmissionStats.NetworkHealth EXCELLENT

HIGH

public static final TransmissionStats.NetworkHealth HIGH

MEDIUM

public static final TransmissionStats.NetworkHealth MEDIUM

LOW

public static final TransmissionStats.NetworkHealth LOW

BAD

public static final TransmissionStats.NetworkHealth BAD

Method Details

values

public static TransmissionStats.NetworkHealth[] 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 TransmissionStats.NetworkHealth 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