Package org.freedesktop.gstreamer.gst

Enum Class FlowReturn

java.lang.Object

java.lang.Enum<FlowReturn>

org.freedesktop.gstreamer.gst.FlowReturn

All Implemented Interfaces:

Enumeration, Serializable, Comparable<FlowReturn>, Constable

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

The result of passing data to a pad.

Note that the custom return values should not be exposed outside of the element scope.

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
CUSTOM_ERROR	Elements can use values starting from this (and lower) to define custom error codes.
CUSTOM_ERROR_1	Pre-defined custom error code (define your custom error code to this to avoid compiler warnings).
CUSTOM_ERROR_2	Pre-defined custom error code.
CUSTOM_SUCCESS	Elements can use values starting from this (and higher) to define custom success codes.
CUSTOM_SUCCESS_1	Pre-defined custom success code (define your custom success code to this to avoid compiler warnings).
CUSTOM_SUCCESS_2	Pre-defined custom success code.
EOS	Pad is EOS.
ERROR	Some (fatal) error occurred.
FLUSHING	Pad is flushing.
NOT_LINKED	Pad is not linked.
NOT_NEGOTIATED	Pad is not negotiated.
NOT_SUPPORTED	This operation is not supported.
OK	Data passing was ok.

Method Summary

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

CUSTOM_SUCCESS_2

public static final FlowReturn CUSTOM_SUCCESS_2

Pre-defined custom success code.

CUSTOM_SUCCESS_1

public static final FlowReturn CUSTOM_SUCCESS_1

Pre-defined custom success code (define your custom success code to this to avoid compiler warnings).

CUSTOM_SUCCESS

public static final FlowReturn CUSTOM_SUCCESS

Elements can use values starting from this (and higher) to define custom success codes.

OK

public static final FlowReturn OK

Data passing was ok.

NOT_LINKED

public static final FlowReturn NOT_LINKED

Pad is not linked.

FLUSHING

public static final FlowReturn FLUSHING

Pad is flushing.

EOS

public static final FlowReturn EOS

Pad is EOS.

NOT_NEGOTIATED

public static final FlowReturn NOT_NEGOTIATED

Pad is not negotiated.

ERROR

public static final FlowReturn ERROR

Some (fatal) error occurred. Element generating this error should post an error message using GST_ELEMENT_ERROR() with more details.

NOT_SUPPORTED

public static final FlowReturn NOT_SUPPORTED

This operation is not supported.

CUSTOM_ERROR

public static final FlowReturn CUSTOM_ERROR

Elements can use values starting from this (and lower) to define custom error codes.

CUSTOM_ERROR_1

public static final FlowReturn CUSTOM_ERROR_1

Pre-defined custom error code (define your custom error code to this to avoid compiler warnings).

CUSTOM_ERROR_2

public static final FlowReturn CUSTOM_ERROR_2

Pre-defined custom error code.

Method Details

values

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

Create a new FlowReturn 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 FlowReturn class

Returns:

the GType