Enum Class Rank

java.lang.Object

java.lang.Enum<Rank>

org.freedesktop.gstreamer.gst.Rank

All Implemented Interfaces:

Serializable, Comparable<Rank>, Constable, Enumeration

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

Element priority ranks. Defines the order in which the autoplugger (or similar rank-picking mechanisms, such as e.g. gst_element_make_from_uri()) will choose this element over an alternative one with the same function.

These constants serve as a rough guidance for defining the rank of a GstPluginFeature. Any value is valid, including values bigger than GSTRANKPRIMARY.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MARGINAL	unlikely to be chosen
NONE	will be chosen last or not at all
PRIMARY	will be chosen first
SECONDARY	likely to be chosen

Method Summary

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

will be chosen last or not at all

MARGINAL

public static final Rank MARGINAL

unlikely to be chosen

SECONDARY

public static final Rank SECONDARY

likely to be chosen

PRIMARY

public static final Rank PRIMARY

will be chosen first

Method Details

values

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

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

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

Returns:

the GType