Package org.freedesktop.gstreamer.video

Enum Class VideoFieldOrder

java.lang.Object

java.lang.Enum<VideoFieldOrder>

org.freedesktop.gstreamer.video.VideoFieldOrder

All Implemented Interfaces:

Serializable, Comparable<VideoFieldOrder>, Constable, Enumeration

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

Field order of interlaced content. This is only valid for interlace-mode=interleaved and not interlace-mode=mixed. In the case of mixed or GST_VIDEO_FIELD_ORDER_UNKOWN, the field order is signalled via buffer flags.

Since:

1.12

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
BOTTOM_FIELD_FIRST	bottom field is first
TOP_FIELD_FIRST	top field is first
UNKNOWN	unknown field order for interlaced content.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final VideoFieldOrder UNKNOWN

unknown field order for interlaced content. The actual field order is signalled via buffer flags.

TOP_FIELD_FIRST

public static final VideoFieldOrder TOP_FIELD_FIRST

top field is first

BOTTOM_FIELD_FIRST

public static final VideoFieldOrder BOTTOM_FIELD_FIRST

bottom field is first

Method Details

values

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

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

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

Returns:

the GType

fromString

public static VideoFieldOrder fromString(String order)

Convert order to a GstVideoFieldOrder

Parameters:

order - a field order

Returns:

the GstVideoFieldOrder of order or GST_VIDEO_FIELD_ORDER_UNKNOWN when order is not a valid string representation for a GstVideoFieldOrder.

Since:

1.12

toString

public String toString()

Convert this VideoFieldOrder to its string representation.

Overrides:

toString in class Enum<VideoFieldOrder>

Returns:

this VideoFieldOrder as a string.

Since:

1.12