Package org.freedesktop.gstreamer.video

Enum Class VideoMultiviewMode

java.lang.Object

java.lang.Enum<VideoMultiviewMode>

org.freedesktop.gstreamer.video.VideoMultiviewMode

All Implemented Interfaces:

Enumeration, Serializable, Comparable<VideoMultiviewMode>, Constable

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

All possible stereoscopic 3D and multiview representations. In conjunction with GstVideoMultiviewFlags, describes how multiview content is being transported in 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
CHECKERBOARD	Pixels are arranged with alternating pixels representing left and right eye views in a checkerboard fashion.
COLUMN_INTERLEAVED	Alternating vertical columns of pixels represent the left and right eye view respectively.
FRAME_BY_FRAME	Left and right eye views are provided in separate frames alternately.
LEFT	All frames represent a left-eye view.
MONO	All frames are monoscopic.
MULTIVIEW_FRAME_BY_FRAME	Multiple independent views are provided in separate frames in sequence.
NONE	A special value indicating no multiview information.
RIGHT	All frames represent a right-eye view.
ROW_INTERLEAVED	Alternating horizontal rows of pixels represent the left and right eye view respectively.
SEPARATED	Multiple views are provided as separate GstMemory framebuffers attached to each GstBuffer, described by the GstVideoMultiviewMeta and GstVideoMeta(s)
SIDE_BY_SIDE	Left and right eye views are provided in the left and right half of the frame respectively.
SIDE_BY_SIDE_QUINCUNX	Left and right eye views are provided in the left and right half of the frame, but have been sampled using quincunx method, with half-pixel offset between the 2 views.
TOP_BOTTOM	The top half of the frame contains the left eye, and the bottom half the right eye.

Method Summary

Modifier and Type	Method	Description
static VideoMultiviewMode	fromCapsString(String capsMviewMode)
static Type	getType()	Get the GType of the VideoMultiviewMode class
int	getValue()	Get the numeric value of this enum
static VideoMultiviewMode	of(int value)	Create a new VideoMultiviewMode for the provided value
String	toCapsString()	Given a GstVideoMultiviewMode returns the multiview-mode caps string for insertion into a caps structure
static VideoMultiviewMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VideoMultiviewMode[]	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 VideoMultiviewMode NONE

A special value indicating no multiview information. Used in GstVideoInfo and other places to indicate that no specific multiview handling has been requested or provided. This value is never carried on caps.

MONO

public static final VideoMultiviewMode MONO

All frames are monoscopic.

LEFT

public static final VideoMultiviewMode LEFT

All frames represent a left-eye view.

RIGHT

public static final VideoMultiviewMode RIGHT

All frames represent a right-eye view.

SIDE_BY_SIDE

public static final VideoMultiviewMode SIDE_BY_SIDE

Left and right eye views are provided in the left and right half of the frame respectively.

SIDE_BY_SIDE_QUINCUNX

public static final VideoMultiviewMode SIDE_BY_SIDE_QUINCUNX

Left and right eye views are provided in the left and right half of the frame, but have been sampled using quincunx method, with half-pixel offset between the 2 views.

COLUMN_INTERLEAVED

public static final VideoMultiviewMode COLUMN_INTERLEAVED

Alternating vertical columns of pixels represent the left and right eye view respectively.

ROW_INTERLEAVED

public static final VideoMultiviewMode ROW_INTERLEAVED

Alternating horizontal rows of pixels represent the left and right eye view respectively.

TOP_BOTTOM

public static final VideoMultiviewMode TOP_BOTTOM

The top half of the frame contains the left eye, and the bottom half the right eye.

CHECKERBOARD

public static final VideoMultiviewMode CHECKERBOARD

Pixels are arranged with alternating pixels representing left and right eye views in a checkerboard fashion.

FRAME_BY_FRAME

public static final VideoMultiviewMode FRAME_BY_FRAME

Left and right eye views are provided in separate frames alternately.

MULTIVIEW_FRAME_BY_FRAME

public static final VideoMultiviewMode MULTIVIEW_FRAME_BY_FRAME

Multiple independent views are provided in separate frames in sequence. This method only applies to raw video buffers at the moment. Specific view identification is via the GstVideoMultiviewMeta and GstVideoMeta(s) on raw video buffers.

SEPARATED

public static final VideoMultiviewMode SEPARATED

Multiple views are provided as separate GstMemory framebuffers attached to each GstBuffer, described by the GstVideoMultiviewMeta and GstVideoMeta(s)

Method Details

values

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

Create a new VideoMultiviewMode 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

getType

public static Type getType()

Get the GType of the VideoMultiviewMode class

Returns:

the GType

fromCapsString

public static VideoMultiviewMode fromCapsString(String capsMviewMode)

toCapsString

public String toCapsString()

Given a GstVideoMultiviewMode returns the multiview-mode caps string for insertion into a caps structure

Returns:

The caps string representation of the mode, or NULL if invalid.