Package org.freedesktop.gstreamer.video

Enum Class VideoBufferFlags

java.lang.Object

java.lang.Enum<VideoBufferFlags>

org.freedesktop.gstreamer.video.VideoBufferFlags

All Implemented Interfaces:

Serializable, Comparable<VideoBufferFlags>, Constable, Enumeration

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

Additional video buffer flags. These flags can potentially be used on any buffers carrying closed caption data, or video data - even encoded data.

Note that these are only valid for GstCaps of type: video/... and caption/... They can conflict with other extended buffer 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	When conveying stereo/multiview content with frame-by-frame methods, this flag marks the first buffer in a bundle of frames that belong together.
INTERLACED	If the GstBuffer is interlaced.
LAST	Offset to define more flags
MARKER	The GstBuffer contains the end of a video field or frame boundary such as the last subframe or packet (Since: 1.18).
MULTIPLE_VIEW	The GstBuffer contains one or more specific views, such as left or right eye view.
ONEFIELD	If the GstBuffer is interlaced, then only the first field (as defined by the TFF flag setting) is to be displayed (Since: 1.16).
RFF	If the GstBuffer is interlaced, then the first field (as defined by the TFF flag setting) is repeated.
TFF	If the GstBuffer is interlaced, then the first field in the video frame is the top field.
TOP_FIELD	The video frame has the top field only.

Field Summary

Fields

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

INTERLACED

public static final VideoBufferFlags INTERLACED

If the GstBuffer is interlaced. In mixed interlace-mode, this flags specifies if the frame is interlaced or progressive.

TFF

public static final VideoBufferFlags TFF

If the GstBuffer is interlaced, then the first field in the video frame is the top field. If unset, the bottom field is first.

RFF

public static final VideoBufferFlags RFF

If the GstBuffer is interlaced, then the first field (as defined by the TFF flag setting) is repeated.

ONEFIELD

public static final VideoBufferFlags ONEFIELD

If the GstBuffer is interlaced, then only the first field (as defined by the TFF flag setting) is to be displayed (Since: 1.16).

MULTIPLE_VIEW

public static final VideoBufferFlags MULTIPLE_VIEW

The GstBuffer contains one or more specific views, such as left or right eye view. This flags is set on any buffer that contains non-mono content - even for streams that contain only a single viewpoint. In mixed mono / non-mono streams, the absence of the flag marks mono buffers.

FIRST_IN_BUNDLE

public static final VideoBufferFlags FIRST_IN_BUNDLE

When conveying stereo/multiview content with frame-by-frame methods, this flag marks the first buffer in a bundle of frames that belong together.

TOP_FIELD

public static final VideoBufferFlags TOP_FIELD

The video frame has the top field only. This is the same as GST_VIDEO_BUFFER_FLAG_TFF | GST_VIDEO_BUFFER_FLAG_ONEFIELD (Since: 1.16). Use GST_VIDEO_BUFFER_IS_TOP_FIELD() to check for this flag.

MARKER

public static final VideoBufferFlags MARKER

The GstBuffer contains the end of a video field or frame boundary such as the last subframe or packet (Since: 1.18).

LAST

public static final VideoBufferFlags LAST

Offset to define more flags

Field Details

BOTTOM_FIELD

public static final VideoBufferFlags BOTTOM_FIELD

The video frame has the bottom field only. This is the same as GST_VIDEO_BUFFER_FLAG_ONEFIELD (GST_VIDEO_BUFFER_FLAG_TFF flag unset) (Since: 1.16). Use GST_VIDEO_BUFFER_IS_BOTTOM_FIELD() to check for this flag.

Method Details

values

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

Create a new EnumSet<VideoBufferFlags> for the provided bitfield

Parameters:

flags - the VideoBufferFlags bitfield

Returns:

the EnumSet for the provided bitfield

of

public static Set<VideoBufferFlags> of(MemorySegment address)

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

Returns:

the GType