Package org.freedesktop.gstreamer.gst

Enum Class StateChangeReturn

java.lang.Object

java.lang.Enum<StateChangeReturn>

org.freedesktop.gstreamer.gst.StateChangeReturn

All Implemented Interfaces:

Serializable, Comparable<StateChangeReturn>, Constable, Enumeration

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

The possible return values from a state change function such as gst_element_set_state(). Only GSTSTATECHANGEFAILURE is a real failure.

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
ASYNC	the state change will happen asynchronously
FAILURE	the state change failed
NO_PREROLL	the state change succeeded but the element cannot produce data in State.PAUSED.
SUCCESS	the state change succeeded

Method Summary

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

FAILURE

public static final StateChangeReturn FAILURE

the state change failed

SUCCESS

public static final StateChangeReturn SUCCESS

the state change succeeded

ASYNC

public static final StateChangeReturn ASYNC

the state change will happen asynchronously

NO_PREROLL

public static final StateChangeReturn NO_PREROLL

the state change succeeded but the element cannot produce data in State.PAUSED. This typically happens with live sources.

Method Details

values

public static StateChangeReturn[] 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 StateChangeReturn 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 StateChangeReturn of(int value)

Create a new StateChangeReturn 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

of

public static StateChangeReturn of(MemorySegment address)

Create a new StateChangeReturn for the value in the provided memory address.

Parameters:

address - the memory address holding a enum value

Returns:

the enum for the value in the provided memory address

getType

public static @Nullable Type getType()

Get the GType of the StateChangeReturn class

Returns:

the GType