Package org.freedesktop.gstreamer.video

Enum Class VideoCaptionType

java.lang.Object

java.lang.Enum<VideoCaptionType>

org.freedesktop.gstreamer.video.VideoCaptionType

All Implemented Interfaces:

Serializable, Comparable<VideoCaptionType>, Constable, Enumeration

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

The various known types of Closed Caption (CC).

Since:

1.16

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
CEA608_RAW	CEA-608 as byte pairs.
CEA608_S334_1A	CEA-608 as byte triplets as defined in SMPTE S334-1 Annex A.
CEA708_CDP	CEA-708 (and optionally CEA-608) in a CDP (Caption Distribution Packet) defined by SMPTE S-334-2.
CEA708_RAW	CEA-708 as cc_data byte triplets.
UNKNOWN	Unknown type of CC

Method Summary

Modifier and Type	Method	Description
static VideoCaptionType	fromCaps(Caps caps)	Parses fixed Closed Caption GstCaps and returns the corresponding caption type, or UNKNOWN.
static @Nullable Type	getType()	Get the GType of the VideoCaptionType class
int	getValue()	Get the numeric value of this enum
static VideoCaptionType	of(int value)	Create a new VideoCaptionType for the provided value
static VideoCaptionType	of(MemorySegment address)	Create a new VideoCaptionType for the value in the provided memory address.
Caps	toCaps()	Creates new caps corresponding to type.
static VideoCaptionType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VideoCaptionType[]	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

UNKNOWN

public static final VideoCaptionType UNKNOWN

Unknown type of CC

CEA608_RAW

public static final VideoCaptionType CEA608_RAW

CEA-608 as byte pairs. Note that this format is not recommended since is does not specify to which field the caption comes from and therefore assumes it comes from the first field (and that there is no information on the second field). Use GSTVIDEOCAPTIONTYPECEA708RAW if you wish to store CEA-608 from two fields and prefix each byte pair with 0xFC for the first field and 0xFD for the second field.

CEA608_S334_1A

public static final VideoCaptionType CEA608_S334_1A

CEA-608 as byte triplets as defined in SMPTE S334-1 Annex A. The second and third byte of the byte triplet is the raw CEA608 data, the first byte is a bitfield: The top/7th bit is 0 for the second field, 1 for the first field, bit 6 and 5 are 0 and bits 4 to 0 are a 5 bit unsigned integer that represents the line offset relative to the base-line of the original image format (line 9 for 525-line field 1, line 272 for 525-line field 2, line 5 for 625-line field 1 and line 318 for 625-line field 2).

CEA708_RAW

public static final VideoCaptionType CEA708_RAW

CEA-708 as cc_data byte triplets. They can also contain 608-in-708 and the first byte of each triplet has to be inspected for detecting the type.

CEA708_CDP

public static final VideoCaptionType CEA708_CDP

CEA-708 (and optionally CEA-608) in a CDP (Caption Distribution Packet) defined by SMPTE S-334-2. Contains the whole CDP (starting with 0x9669).

Method Details

values

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

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

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

Returns:

the GType

fromCaps

public static VideoCaptionType fromCaps(Caps caps)

Parses fixed Closed Caption GstCaps and returns the corresponding caption type, or UNKNOWN.

Parameters:

caps - Fixed GstCaps to parse

Returns:

GstVideoCaptionType.

Since:

1.16

toCaps

public Caps toCaps()

Creates new caps corresponding to type.

Returns:

new GstCaps

Since:

1.16