Package com.caplin.streamlink

Enum Class ThrottleCommand

java.lang.Object

java.lang.Enum<ThrottleCommand>

com.caplin.streamlink.ThrottleCommand

All Implemented Interfaces:

Serializable, Comparable<ThrottleCommand>, Constable

public enum ThrottleCommand
extends Enum<ThrottleCommand>

Enumeration that defines the available throttle levels and throttle commands.

A ThrottleCommand is passed as a parameter to the throttleSubject() and throttleEverything() methods of StreamLink.

For an explanation of throttling, refer the Throttling section of the document StreamLink Overview.

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
DEF	Set the throttle level to the default level.
DOWN	Decrease the throttle level.
MAX	Set the throttle level to the maximum amount of throttling.
MIN	Set the throttle level to the minimum amount of throttling.
START	Start sending updates to the client again.
STOP	Stop sending updates to the client.
UP	Increase the throttle level.

Method Summary

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

UP

public static final ThrottleCommand UP

Increase the throttle level.

DOWN

public static final ThrottleCommand DOWN

Decrease the throttle level.

MIN

public static final ThrottleCommand MIN

Set the throttle level to the minimum amount of throttling.

MAX

public static final ThrottleCommand MAX

Set the throttle level to the maximum amount of throttling.

STOP

public static final ThrottleCommand STOP

Stop sending updates to the client.

START

public static final ThrottleCommand START

Start sending updates to the client again.

DEF

public static final ThrottleCommand DEF

Set the throttle level to the default level.

Method Details

values

public static ThrottleCommand[] 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 ThrottleCommand 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