Package org.freedesktop.gstreamer.gst

Enum Class State

java.lang.Object

java.lang.Enum<State>

org.freedesktop.gstreamer.gst.State

All Implemented Interfaces:

Enumeration, Serializable, Comparable<State>, Constable

@Generated("io.github.jwharm.JavaGI")
public enum State
extends Enum<State>
implements Enumeration

The possible states an element can be in. States can be changed using gst_element_set_state() and checked using gst_element_get_state().

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
NULL	the NULL state or initial state of an element.
PAUSED	the element is PAUSED, it is ready to accept and process data.
PLAYING	the element is PLAYING, the GstClock is running and the data is flowing.
READY	the element is ready to go to PAUSED.
VOID_PENDING	no pending state.

Method Summary

Modifier and Type	Method	Description
static Type	getType()	Get the GType of the State class
int	getValue()	Get the numeric value of this enum
static State	of(int value)	Create a new State for the provided value
static State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static State[]	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

VOID_PENDING

public static final State VOID_PENDING

no pending state.

NULL

public static final State NULL

the NULL state or initial state of an element.

READY

public static final State READY

the element is ready to go to PAUSED.

PAUSED

public static final State PAUSED

the element is PAUSED, it is ready to accept and process data. Sink elements however only accept one buffer and then block.

PLAYING

public static final State PLAYING

the element is PLAYING, the GstClock is running and the data is flowing.

Method Details

values

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

of

public static State of(int value)

Create a new State for the provided value

Parameters:

value - the enum value

Returns:

the enum for the provided value

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

getType

public static Type getType()

Get the GType of the State class

Returns:

the GType