Package org.freedesktop.gstreamer.video

Enum Class VideoFrameFlags

java.lang.Object

java.lang.Enum<VideoFrameFlags>

org.freedesktop.gstreamer.video.VideoFrameFlags

All Implemented Interfaces:

Serializable, Comparable<VideoFrameFlags>, Constable, Enumeration

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

Extra video frame flags

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
FIRST_IN_BUNDLE	The video frame is the first in a set of corresponding views provided as sequential frames.
INTERLACED	The video frame is interlaced.
MULTIPLE_VIEW	The video contains one or more non-mono views
NONE	no flags
ONEFIELD	The video frame has one field
RFF	The video frame has the repeat flag
TFF	The video frame has the top field first
TOP_FIELD	The video frame has the top field only.

Field Summary

Fields

Modifier and Type	Field	Description
static final VideoFrameFlags	BOTTOM_FIELD	The video frame has the bottom field only.

Method Summary

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

NONE

public static final VideoFrameFlags NONE

no flags

INTERLACED

public static final VideoFrameFlags INTERLACED

The video frame is interlaced. In mixed interlace-mode, this flag specifies if the frame is interlaced or progressive.

TFF

public static final VideoFrameFlags TFF

The video frame has the top field first

RFF

public static final VideoFrameFlags RFF

The video frame has the repeat flag

ONEFIELD

public static final VideoFrameFlags ONEFIELD

The video frame has one field

MULTIPLE_VIEW

public static final VideoFrameFlags MULTIPLE_VIEW

The video contains one or more non-mono views

FIRST_IN_BUNDLE

public static final VideoFrameFlags FIRST_IN_BUNDLE

The video frame is the first in a set of corresponding views provided as sequential frames.

TOP_FIELD

public static final VideoFrameFlags TOP_FIELD

The video frame has the top field only. This is the same as GST_VIDEO_FRAME_FLAG_TFF | GST_VIDEO_FRAME_FLAG_ONEFIELD (Since: 1.16).

Field Details

BOTTOM_FIELD

public static final VideoFrameFlags BOTTOM_FIELD

The video frame has the bottom field only. This is the same as GST_VIDEO_FRAME_FLAG_ONEFIELD (GST_VIDEO_FRAME_FLAG_TFF flag unset) (Since: 1.16).

Method Details

values

public static VideoFrameFlags[] 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 VideoFrameFlags 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

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

of

public static Set<VideoFrameFlags> of(int flags)

Create a new EnumSet<VideoFrameFlags> for the provided bitfield

Parameters:

flags - the VideoFrameFlags bitfield

Returns:

the EnumSet for the provided bitfield

of

public static Set<VideoFrameFlags> of(MemorySegment address)

Create a new EnumSet<VideoFrameFlags> for the bitfield in the provided memory address.

Parameters:

address - the memory address holding a bitfield value

Returns:

the EnumSet for the bitfield in the provided memory address

getType

public static @Nullable Type getType()

Get the GType of the VideoFrameFlags class

Returns:

the GType