Enum Class CapsIntersectMode

java.lang.Object

java.lang.Enum<CapsIntersectMode>

org.freedesktop.gstreamer.gst.CapsIntersectMode

All Implemented Interfaces:

Serializable, Comparable<CapsIntersectMode>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum CapsIntersectMode
extends Enum<CapsIntersectMode>
implements Enumeration

Modes of caps intersection

ZIG_ZAG tries to preserve overall order of both caps by iterating on the caps' structures as the following matrix shows:

         caps1
      +-------------
      | 1  2  4  7
caps2 | 3  5  8 10
      | 6  9 11 12

Used when there is no explicit precedence of one caps over the other. e.g. tee's sink pad getcaps function, it will probe its src pad peers' for their caps and intersect them with this mode.

FIRST is useful when an element wants to preserve another element's caps priority order when intersecting with its own caps. Example: If caps1 is [A, B, C] and caps2 is [E, B, D, A], the result would be [A, B], maintaining the first caps priority on the intersection.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIRST	Keeps the first caps order.
ZIG_ZAG	Zig-zags over both caps.

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the CapsIntersectMode class.
int	getValue()	Get the numeric value of this enum
static CapsIntersectMode	of(int value)	Create a new CapsIntersectMode for the provided value
static CapsIntersectMode	of(MemorySegment address)	Create a new CapsIntersectMode for the value in the provided memory address.
static CapsIntersectMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CapsIntersectMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ZIG_ZAG

public static final CapsIntersectMode ZIG_ZAG

Zig-zags over both caps.

FIRST

public static final CapsIntersectMode FIRST

Keeps the first caps order.

Method Details

values

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

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

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

Returns:

the GType