com.amazonaws.kinesisvideo.client.mediasource

Enum MediaSourceState

java.lang.Object

java.lang.Enum<MediaSourceState>

com.amazonaws.kinesisvideo.client.mediasource.MediaSourceState

All Implemented Interfaces:

Serializable, Comparable<MediaSourceState>

public enum MediaSourceState
extends Enum<MediaSourceState>

Represents the media source states. NOTE: Simple states for the media source. Initially, the media source is in the Initialized state. Later, if we need, we could add more state transitions to mimic lower-level encoders/hardware states for more granularity if we need. Initialized -> Ready (allocate the buffers and configure the source) Ready -> Running (start streaming) Running -> Ready (pause stream. Doesn't de-allocate the buffers) Running -> Stopped (stop the stream) Ready -> Stopped (stop the stream) Stopped -> NULL (need to re-initialize)

Enum Constant Summary

Enum Constants

Enum Constant and Description
INITIALIZED Created/initialized
READY Ready state.
RUNNING Running state.
STOPPED Stopped state.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INITIALIZED

public static final MediaSourceState INITIALIZED

Created/initialized

READY

public static final MediaSourceState READY

Ready state. The buffers are allocated and configured.

RUNNING

public static final MediaSourceState RUNNING

Running state.

STOPPED

public static final MediaSourceState STOPPED

Stopped state. Not initialized.

Method Detail

values

public static MediaSourceState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MediaSourceState c : MediaSourceState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MediaSourceState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null