Enum Class PadProbeReturn

java.lang.Object

java.lang.Enum<PadProbeReturn>

org.freedesktop.gstreamer.gst.PadProbeReturn

All Implemented Interfaces:

Serializable, Comparable<PadProbeReturn>, Constable, Enumeration

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

Different return values for the GstPadProbeCallback.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DROP	drop data in data probes.
HANDLED	Data has been handled in the probe and will not be forwarded further.
OK	normal probe return value.
PASS	pass the data item in the block probe and block on the next item.
REMOVE	remove this probe, passing the data.

Method Summary

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

DROP

public static final PadProbeReturn DROP

drop data in data probes. For push mode this means that the data item is not sent downstream. For pull mode, it means that the data item is not passed upstream. In both cases, no other probes are called for this item and FlowReturn.OK or true is returned to the caller.

OK

public static final PadProbeReturn OK

normal probe return value. This leaves the probe in place, and defers decisions about dropping or passing data to other probes, if any. If there are no other probes, the default behaviour for the probe type applies ('block' for blocking probes, and 'pass' for non-blocking probes).

REMOVE

public static final PadProbeReturn REMOVE

remove this probe, passing the data. For blocking probes this will cause data flow to unblock, unless there are also other blocking probes installed.

PASS

public static final PadProbeReturn PASS

pass the data item in the block probe and block on the next item. Note, that if there are multiple pad probes installed and any probe returns PASS, the data will be passed.

HANDLED

public static final PadProbeReturn HANDLED

Data has been handled in the probe and will not be forwarded further. For events and buffers this is the same behaviour as DROP (except that in this case you need to unref the buffer or event yourself). For queries it will also return true to the caller. The probe can also modify the GstFlowReturn value by using the GST_PAD_PROBE_INFO_FLOW_RETURN() accessor. Note that the resulting query must contain valid entries. Since: 1.6

Method Details

values

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

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

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

Returns:

the GType