Class VideoVBIEncoder

java.lang.Object

org.javagi.base.ProxyInstance

org.freedesktop.gstreamer.video.VideoVBIEncoder

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class VideoVBIEncoder
extends ProxyInstance

An encoder for writing ancillary data to the Vertical Blanking Interval lines of component signals.

Since:

1.16

Constructor Summary

Constructors

Constructor	Description
VideoVBIEncoder(MemorySegment address)	Create a VideoVBIEncoder proxy instance for the provided memory address.
VideoVBIEncoder(VideoFormat format, int pixelWidth)	Create a new GstVideoVBIEncoder for the specified format and pixelWidth.

Method Summary

Modifier and Type	Method	Description
boolean	addAncillary(boolean composite, byte DID, byte SDIDBlockNumber, @Nullable byte @Nullable [] data)	Stores Video Ancillary data, according to SMPTE-291M specification.
VideoVBIEncoder	copy()
void	free()	Frees the encoder.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the VideoVBIEncoder class.
void	writeLine(MemorySegment data)

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VideoVBIEncoder

public VideoVBIEncoder(MemorySegment address)

Create a VideoVBIEncoder proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

VideoVBIEncoder

public VideoVBIEncoder(VideoFormat format,
 int pixelWidth)

Create a new GstVideoVBIEncoder for the specified format and pixelWidth.

Parameters:

format - a GstVideoFormat

pixelWidth - The width in pixel to use

Since:

1.16

Method Details

getType

public static @Nullable Type getType()

Get the GType of the VideoVBIEncoder class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

addAncillary

public boolean addAncillary(boolean composite,
 byte DID,
 byte SDIDBlockNumber,
 @Nullable byte @Nullable [] data)

Stores Video Ancillary data, according to SMPTE-291M specification.

Note that the contents of the data are always read as 8bit data (i.e. do not contain the parity check bits).

Parameters:

composite - true if composite ADF should be created, component otherwise

DID - The Data Identifier

SDIDBlockNumber - The Secondary Data Identifier (if type 2) or the Data Block Number (if type 1)

data - The user data content of the Ancillary packet. Does not contain the ADF, DID, SDID nor CS.

Returns:

true if enough space was left in the current line, false otherwise.

Since:

1.16

copy

public VideoVBIEncoder copy()

free

public void free()

Frees the encoder.

Since:

1.16

writeLine

public void writeLine(MemorySegment data)