org.freedesktop.gstreamer

Enum PadProbeReturn

java.lang.Object

java.lang.Enum<PadProbeReturn>

org.freedesktop.gstreamer.PadProbeReturn

All Implemented Interfaces:

Serializable, Comparable<PadProbeReturn>

public enum PadProbeReturn
extends Enum<PadProbeReturn>

Different return values for Pad probe callbacks

Enum Constant Summary

Enum Constants

Enum Constant and 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 the probe

Method Summary

Modifier and Type	Method and Description
static PadProbeReturn	valueOf(String name) Returns the enum constant of this type with the specified name.
static PadProbeReturn[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 %GST_FLOW_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 the probe

PASS

public static final PadProbeReturn PASS

Pass the data item in the block probe and block on the next item.

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 %GST_PAD_PROBE_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 Detail

values

public static PadProbeReturn[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PadProbeReturn c : PadProbeReturn.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PadProbeReturn valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null