Package org.freedesktop.gstreamer.video

Enum Class VideoInterlaceMode

java.lang.Object

java.lang.Enum<VideoInterlaceMode>

org.freedesktop.gstreamer.video.VideoInterlaceMode

All Implemented Interfaces:

Serializable, Comparable<VideoInterlaceMode>, Constable, Enumeration

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

The possible values of the GstVideoInterlaceMode describing the interlace mode of the stream.

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
ALTERNATE	1 field is stored in one buffer, GSTVIDEOBUFFERFLAGTF or GSTVIDEOBUFFERFLAGBF indicates if the buffer is carrying the top or bottom field, respectively.
FIELDS	2 fields are stored in one buffer, use the frame ID to get access to the required field.
INTERLEAVED	2 fields are interleaved in one video frame.
MIXED	frames contains both interlaced and progressive video, the buffer flags describe the frame and fields.
PROGRESSIVE	all frames are progressive

Method Summary

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

PROGRESSIVE

public static final VideoInterlaceMode PROGRESSIVE

all frames are progressive

INTERLEAVED

public static final VideoInterlaceMode INTERLEAVED

2 fields are interleaved in one video frame. Extra buffer flags describe the field order.

MIXED

public static final VideoInterlaceMode MIXED

frames contains both interlaced and progressive video, the buffer flags describe the frame and fields.

FIELDS

public static final VideoInterlaceMode FIELDS

2 fields are stored in one buffer, use the frame ID to get access to the required field. For multiview (the 'views' property > 1) the fields of view N can be found at frame ID (N * 2) and (N * 2) + 1. Each field has only half the amount of lines as noted in the height property. This mode requires multiple GstVideoMeta metadata to describe the fields.

ALTERNATE

public static final VideoInterlaceMode ALTERNATE

1 field is stored in one buffer, GSTVIDEOBUFFERFLAGTF or GSTVIDEOBUFFERFLAGBF indicates if the buffer is carrying the top or bottom field, respectively. The top and bottom buffers must alternate in the pipeline, with this mode (Since: 1.16).

Method Details

values

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

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

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

Returns:

the GType

fromString

public static VideoInterlaceMode fromString(String mode)

Convert mode to a GstVideoInterlaceMode

Parameters:

mode - a mode

Returns:

the GstVideoInterlaceMode of mode or GST_VIDEO_INTERLACE_MODE_PROGRESSIVE when mode is not a valid string representation for a GstVideoInterlaceMode.

Since:

1.6

toString

public String toString()

Convert this VideoInterlaceMode to its string representation.

Overrides:

toString in class Enum<VideoInterlaceMode>

Returns:

this VideoInterlaceMode as a string.

Since:

1.6