Package org.freedesktop.gstreamer.video

Class VideoAncillary

java.lang.Object

org.javagi.base.ProxyInstance

org.freedesktop.gstreamer.video.VideoAncillary

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class VideoAncillary
extends ProxyInstance

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

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

Since:

1.16

Constructor Summary

Constructors

Constructor	Description
VideoAncillary()	Allocate a new VideoAncillary.
VideoAncillary(byte DID, byte SDIDBlockNumber, byte dataCount, byte[] data)	Allocate a new VideoAncillary with the fields set to the provided values.
VideoAncillary(byte DID, byte SDIDBlockNumber, byte dataCount, byte[] data, Arena arena)	Allocate a new VideoAncillary with the fields set to the provided values.
VideoAncillary(Arena arena)	Allocate a new VideoAncillary.
VideoAncillary(MemorySegment address)	Create a VideoAncillary proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
@org.jspecify.annotations.Nullable byte @Nullable []	readData()	Read the value of the field data.
byte	readDataCount()	Read the value of the field data_count.
byte	readDID()	Read the value of the field DID.
byte	readSDIDBlockNumber()	Read the value of the field SDID_block_number.
void	writeData(@org.jspecify.annotations.Nullable byte @Nullable [] data, Arena _arena)	Write a value in the field data.
void	writeDataCount(byte dataCount)	Write a value in the field data_count.
void	writeDID(byte DID)	Write a value in the field DID.
void	writeSDIDBlockNumber(byte SDIDBlockNumber)	Write a value in the field SDID_block_number.

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

VideoAncillary

public VideoAncillary(MemorySegment address)

Create a VideoAncillary proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

VideoAncillary

public VideoAncillary(Arena arena)

Allocate a new VideoAncillary.

Parameters:

arena - to control the memory allocation scope

VideoAncillary

public VideoAncillary()

Allocate a new VideoAncillary. The memory is allocated with Arena.ofAuto().

VideoAncillary

public VideoAncillary(byte DID,
 byte SDIDBlockNumber,
 byte dataCount,
 byte[] data,
 Arena arena)

Allocate a new VideoAncillary with the fields set to the provided values.

Parameters:

DID - value for the field DID

SDIDBlockNumber - value for the field SDIDBlockNumber

dataCount - value for the field dataCount

data - value for the field data

arena - to control the memory allocation scope

VideoAncillary

public VideoAncillary(byte DID,
 byte SDIDBlockNumber,
 byte dataCount,
 byte[] data)

Allocate a new VideoAncillary with the fields set to the provided values. The memory is allocated with Arena.ofAuto().

Parameters:

DID - value for the field DID

SDIDBlockNumber - value for the field SDIDBlockNumber

dataCount - value for the field dataCount

data - value for the field data

Method Details

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readDID

public byte readDID()

Read the value of the field DID.

Returns:

The value of the field DID

writeDID

public void writeDID(byte DID)

Write a value in the field DID.

Parameters:

DID - The new value for the field DID

readSDIDBlockNumber

public byte readSDIDBlockNumber()

Read the value of the field SDID_block_number.

Returns:

The value of the field SDID_block_number

writeSDIDBlockNumber

public void writeSDIDBlockNumber(byte SDIDBlockNumber)

Write a value in the field SDID_block_number.

Parameters:

SDIDBlockNumber - The new value for the field SDID_block_number

readDataCount

public byte readDataCount()

Read the value of the field data_count.

Returns:

The value of the field data_count

writeDataCount

public void writeDataCount(byte dataCount)

Write a value in the field data_count.

Parameters:

dataCount - The new value for the field data_count

readData

public @org.jspecify.annotations.Nullable byte @Nullable [] readData()

Read the value of the field data.

Returns:

The value of the field data

writeData

public void writeData(@org.jspecify.annotations.Nullable byte @Nullable [] data,
 Arena _arena)

Write a value in the field data.

Parameters:

data - The new value for the field data

_arena - to control the memory allocation scope