org.freedesktop.gstreamer

Enum PadProbeType

java.lang.Object

java.lang.Enum<PadProbeType>

org.freedesktop.gstreamer.PadProbeType

All Implemented Interfaces:

Serializable, Comparable<PadProbeType>, NativeEnum<PadProbeType>, NativeFlags<PadProbeType>

public enum PadProbeType
extends Enum<PadProbeType>
implements NativeFlags<PadProbeType>

The different probing types that can occur. When either one of IDLE or BLOCK is used, the probe will be a blocking probe.

For convenience, the various flag combinations are provided as immutable Sets.

See upstream documentation at https://gstreamer.freedesktop.org/documentation/gstreamer/gstpad.html#GstPadProbeType

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCK Probe and block pads.
BUFFER Probe buffers.
BUFFER_LIST Probe buffer lists.
EVENT_DOWNSTREAM Probe downstream events.
EVENT_FLUSH Probe flush events.
EVENT_UPSTREAM Probe upstream events.
IDLE Probe idle pads and block while the callback is called.
PULL Probe pull.
PUSH Probe push.
QUERY_DOWNSTREAM Probe downstream queries.
QUERY_UPSTREAM Probe upstream queries.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<PadProbeType>	ALL_BOTH Probe upstream events and queries and downstream buffers, buffer lists, events and queries.
static Set<PadProbeType>	BLOCK_DOWNSTREAM Probe and block downstream data (buffers, buffer lists and events).
static Set<PadProbeType>	BLOCK_UPSTREAM Probe and block upstream data (events).
static Set<PadProbeType>	BLOCKING Probe and block at the next opportunity, at data flow or when idle.
static Set<PadProbeType>	DATA_BOTH Probe upstream and downstream data (buffers, buffer lists and events).
static Set<PadProbeType>	DATA_DOWNSTREAM Probe downstream data (buffers, buffer lists and events).
static Set<PadProbeType>	DATA_UPSTREAM Probe upstream data (events).
static Set<PadProbeType>	EVENT_BOTH Probe upstream and downstream events.
static Set<PadProbeType>	QUERY_BOTH Probe upstream and downstream queries.
static Set<PadProbeType>	SCHEDULING Probe push and pull.

Method Summary

Modifier and Type	Method and Description
int	intValue()
static PadProbeType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PadProbeType[]	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

Methods inherited from interface org.freedesktop.gstreamer.glib.NativeFlags

fromInt, toInt, toInt

Methods inherited from interface org.freedesktop.gstreamer.glib.NativeEnum

fromInt, fromInt

Enum Constant Detail

IDLE

public static final PadProbeType IDLE

Probe idle pads and block while the callback is called.

BLOCK

public static final PadProbeType BLOCK

Probe and block pads.

BUFFER

public static final PadProbeType BUFFER

Probe buffers.

BUFFER_LIST

public static final PadProbeType BUFFER_LIST

Probe buffer lists.

EVENT_DOWNSTREAM

public static final PadProbeType EVENT_DOWNSTREAM

Probe downstream events.

EVENT_UPSTREAM

public static final PadProbeType EVENT_UPSTREAM

Probe upstream events.

EVENT_FLUSH

public static final PadProbeType EVENT_FLUSH

Probe flush events. This probe has to be explicitly enabled and is not included in the DOWNSTREAM or UPSTREAM probe types.

QUERY_DOWNSTREAM

public static final PadProbeType QUERY_DOWNSTREAM

Probe downstream queries.

QUERY_UPSTREAM

public static final PadProbeType QUERY_UPSTREAM

Probe upstream queries.

PUSH

public static final PadProbeType PUSH

Probe push.

PULL

public static final PadProbeType PULL

Probe pull.

Field Detail

BLOCKING

public static final Set<PadProbeType> BLOCKING

Probe and block at the next opportunity, at data flow or when idle.

DATA_DOWNSTREAM

public static final Set<PadProbeType> DATA_DOWNSTREAM

Probe downstream data (buffers, buffer lists and events).

DATA_UPSTREAM

public static final Set<PadProbeType> DATA_UPSTREAM

Probe upstream data (events).

DATA_BOTH

public static final Set<PadProbeType> DATA_BOTH

Probe upstream and downstream data (buffers, buffer lists and events).

BLOCK_DOWNSTREAM

public static final Set<PadProbeType> BLOCK_DOWNSTREAM

Probe and block downstream data (buffers, buffer lists and events).

BLOCK_UPSTREAM

public static final Set<PadProbeType> BLOCK_UPSTREAM

Probe and block upstream data (events).

EVENT_BOTH

public static final Set<PadProbeType> EVENT_BOTH

Probe upstream and downstream events.

QUERY_BOTH

public static final Set<PadProbeType> QUERY_BOTH

Probe upstream and downstream queries.

ALL_BOTH

public static final Set<PadProbeType> ALL_BOTH

Probe upstream events and queries and downstream buffers, buffer lists, events and queries.

SCHEDULING

public static final Set<PadProbeType> SCHEDULING

Probe push and pull.

Method Detail

values

public static PadProbeType[] 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 (PadProbeType c : PadProbeType.values())
    System.out.println(c);

Returns:

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

valueOf

public static PadProbeType 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

intValue

public int intValue()

Specified by:

intValue in interface NativeEnum<PadProbeType>