Package org.freedesktop.gstreamer.gst

Enum Class PadProbeType

java.lang.Object

java.lang.Enum<PadProbeType>

org.freedesktop.gstreamer.gst.PadProbeType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<PadProbeType>, Constable

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

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

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
ALL_BOTH	probe upstream events and queries and downstream buffers, buffer lists, events and queries
BLOCK	probe and block pads
BLOCK_DOWNSTREAM	probe and block downstream data (buffers, buffer lists, and events)
BLOCK_UPSTREAM	probe and block upstream data (events)
BLOCKING	probe and block at the next opportunity, at data flow or when idle
BUFFER	probe buffers
BUFFER_LIST	probe buffer lists
DATA_BOTH	probe upstream and downstream data (buffers, buffer lists, and events)
DATA_DOWNSTREAM	probe downstream data (buffers, buffer lists, and events)
EVENT_BOTH	probe upstream and downstream events
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
INVALID	invalid probe type
PULL	probe pull
PUSH	probe push
QUERY_BOTH	probe upstream and downstream queries
QUERY_DOWNSTREAM	probe downstream queries
QUERY_UPSTREAM	probe upstream queries
SCHEDULING	probe push and pull

Field Summary

Fields

Modifier and Type	Field	Description
static final PadProbeType	DATA_UPSTREAM	probe upstream data (events)

Method Summary

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

INVALID

public static final PadProbeType INVALID

invalid probe type

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 GSTPADPROBETYPEEVENTDOWNSTREAM or GSTPADPROBETYPEEVENTUPSTREAM 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

BLOCKING

public static final PadProbeType BLOCKING

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

DATA_DOWNSTREAM

public static final PadProbeType DATA_DOWNSTREAM

probe downstream data (buffers, buffer lists, and events)

DATA_BOTH

public static final PadProbeType DATA_BOTH

probe upstream and downstream data (buffers, buffer lists, and events)

BLOCK_DOWNSTREAM

public static final PadProbeType BLOCK_DOWNSTREAM

probe and block downstream data (buffers, buffer lists, and events)

BLOCK_UPSTREAM

public static final PadProbeType BLOCK_UPSTREAM

probe and block upstream data (events)

EVENT_BOTH

public static final PadProbeType EVENT_BOTH

probe upstream and downstream events

QUERY_BOTH

public static final PadProbeType QUERY_BOTH

probe upstream and downstream queries

ALL_BOTH

public static final PadProbeType ALL_BOTH

probe upstream events and queries and downstream buffers, buffer lists, events and queries

SCHEDULING

public static final PadProbeType SCHEDULING

probe push and pull

Field Details

DATA_UPSTREAM

public static final PadProbeType DATA_UPSTREAM

probe upstream data (events)

Method Details

values

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

Create a new PadProbeType for the provided value

Parameters:

value - the bitfield value

Returns:

the bitfield 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 PadProbeType class

Returns:

the GType