Enum Class PadMode

java.lang.Object

java.lang.Enum<PadMode>

org.freedesktop.gstreamer.gst.PadMode

All Implemented Interfaces:

Serializable, Comparable<PadMode>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum PadMode
extends Enum<PadMode>
implements Enumeration

The status of a GstPad. After activating a pad, which usually happens when the parent element goes from READY to PAUSED, the GstPadMode defines if the pad operates in push or pull mode.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	Pad will not handle dataflow
PULL	Pad handles dataflow in upstream pull mode
PUSH	Pad handles dataflow in downstream push mode

Method Summary

Modifier and Type	Method	Description
String	getName()	Return the name of a pad mode, for use in debug messages mostly.
static @Nullable Type	getType()	Get the GType of the PadMode class.
int	getValue()	Get the numeric value of this enum
static PadMode	of(int value)	Create a new PadMode for the provided value
static PadMode	of(MemorySegment address)	Create a new PadMode for the value in the provided memory address.
static PadMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PadMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final PadMode NONE

Pad will not handle dataflow

PUSH

public static final PadMode PUSH

Pad handles dataflow in downstream push mode

PULL

public static final PadMode PULL

Pad handles dataflow in upstream pull mode

Method Details

values

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

Create a new PadMode 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 PadMode of(MemorySegment address)

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

Returns:

the GType

getName

public String getName()

Return the name of a pad mode, for use in debug messages mostly.

Returns:

short mnemonic for pad mode this PadMode