Class AncillaryMeta

java.lang.Object
org.javagi.base.ProxyInstance
org.freedesktop.gstreamer.video.AncillaryMeta
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class AncillaryMeta extends ProxyInstance
GstMeta for carrying SMPTE-291M Ancillary data. Note that all the ADF fields (DID to checksum) are 10bit values with parity/non-parity high-bits set.
Since:
1.24

  • Constructor Details

    • AncillaryMeta

      public AncillaryMeta(MemorySegment address)
      Create a AncillaryMeta proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • AncillaryMeta

      public AncillaryMeta(Arena arena)
      Allocate a new AncillaryMeta.
      Parameters:
      arena - to control the memory allocation scope

    • AncillaryMeta

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

    • AncillaryMeta

      public AncillaryMeta(@Nullable Meta meta, AncillaryMetaField field, boolean cNotYChannel, short line, short offset, short DID, short SDIDBlockNumber, short dataCount, MemorySegment data, short checksum, Arena arena)
      Allocate a new AncillaryMeta with the fields set to the provided values.
      Parameters:
      meta - value for the field meta
      field - value for the field field
      cNotYChannel - value for the field cNotYChannel
      line - value for the field line
      offset - value for the field offset
      DID - value for the field DID
      SDIDBlockNumber - value for the field SDIDBlockNumber
      dataCount - value for the field dataCount
      data - value for the field data
      checksum - value for the field checksum
      arena - to control the memory allocation scope

    • AncillaryMeta

      public AncillaryMeta(@Nullable Meta meta, AncillaryMetaField field, boolean cNotYChannel, short line, short offset, short DID, short SDIDBlockNumber, short dataCount, MemorySegment data, short checksum)
      Allocate a new AncillaryMeta with the fields set to the provided values. The memory is allocated with Arena.ofAuto().
      Parameters:
      meta - value for the field meta
      field - value for the field field
      cNotYChannel - value for the field cNotYChannel
      line - value for the field line
      offset - value for the field offset
      DID - value for the field DID
      SDIDBlockNumber - value for the field SDIDBlockNumber
      dataCount - value for the field dataCount
      data - value for the field data
      checksum - value for the field checksum

  • Method Details

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • readMeta

      public @Nullable Meta readMeta()
      Read the value of the field meta.
      Returns:
      The value of the field meta

    • writeMeta

      public void writeMeta(@Nullable Meta meta)
      Write a value in the field meta.
      Parameters:
      meta - The new value for the field meta

    • readField

      public AncillaryMetaField readField()
      Read the value of the field field.
      Returns:
      The value of the field field

    • writeField

      public void writeField(AncillaryMetaField field)
      Write a value in the field field.
      Parameters:
      field - The new value for the field field

    • readCNotYChannel

      public boolean readCNotYChannel()
      Read the value of the field c_not_y_channel.
      Returns:
      The value of the field c_not_y_channel

    • writeCNotYChannel

      public void writeCNotYChannel(boolean cNotYChannel)
      Write a value in the field c_not_y_channel.
      Parameters:
      cNotYChannel - The new value for the field c_not_y_channel

    • readLine

      public short readLine()
      Read the value of the field line.
      Returns:
      The value of the field line

    • writeLine

      public void writeLine(short line)
      Write a value in the field line.
      Parameters:
      line - The new value for the field line

    • readOffset

      public short readOffset()
      Read the value of the field offset.
      Returns:
      The value of the field offset

    • writeOffset

      public void writeOffset(short offset)
      Write a value in the field offset.
      Parameters:
      offset - The new value for the field offset

    • readDID

      public short readDID()
      Read the value of the field DID.
      Returns:
      The value of the field DID

    • writeDID

      public void writeDID(short DID)
      Write a value in the field DID.
      Parameters:
      DID - The new value for the field DID

    • readSDIDBlockNumber

      public short readSDIDBlockNumber()
      Read the value of the field SDID_block_number.
      Returns:
      The value of the field SDID_block_number

    • writeSDIDBlockNumber

      public void writeSDIDBlockNumber(short SDIDBlockNumber)
      Write a value in the field SDID_block_number.
      Parameters:
      SDIDBlockNumber - The new value for the field SDID_block_number

    • readDataCount

      public short readDataCount()
      Read the value of the field data_count.
      Returns:
      The value of the field data_count

    • writeDataCount

      public void writeDataCount(short dataCount)
      Write a value in the field data_count.
      Parameters:
      dataCount - The new value for the field data_count

    • readData

      public MemorySegment readData()
      Read the value of the field data.
      Returns:
      The value of the field data

    • writeData

      public void writeData(MemorySegment data)
      Write a value in the field data.
      Parameters:
      data - The new value for the field data

    • readChecksum

      public short readChecksum()
      Read the value of the field checksum.
      Returns:
      The value of the field checksum

    • writeChecksum

      public void writeChecksum(short checksum)
      Write a value in the field checksum.
      Parameters:
      checksum - The new value for the field checksum

    • getInfo

      public static MetaInfo getInfo()