Class VideoRegionOfInterestMeta

java.lang.Object
org.javagi.base.ProxyInstance
org.freedesktop.gstreamer.video.VideoRegionOfInterestMeta
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class VideoRegionOfInterestMeta extends ProxyInstance
Extra buffer metadata describing an image region of interest

  • Constructor Details

    • VideoRegionOfInterestMeta

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

    • VideoRegionOfInterestMeta

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

    • VideoRegionOfInterestMeta

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

    • VideoRegionOfInterestMeta

      public VideoRegionOfInterestMeta(Meta meta, Quark roiType, int id, int parentId, int x, int y, int w, int h, List<MemorySegment> params, Arena arena)
      Allocate a new VideoRegionOfInterestMeta with the fields set to the provided values.
      Parameters:
      meta - value for the field meta
      roiType - value for the field roiType
      id - value for the field id
      parentId - value for the field parentId
      x - value for the field x
      y - value for the field y
      w - value for the field w
      h - value for the field h
      params - value for the field params
      arena - to control the memory allocation scope

    • VideoRegionOfInterestMeta

      public VideoRegionOfInterestMeta(Meta meta, Quark roiType, int id, int parentId, int x, int y, int w, int h, List<MemorySegment> params)
      Allocate a new VideoRegionOfInterestMeta with the fields set to the provided values. The memory is allocated with Arena.ofAuto().
      Parameters:
      meta - value for the field meta
      roiType - value for the field roiType
      id - value for the field id
      parentId - value for the field parentId
      x - value for the field x
      y - value for the field y
      w - value for the field w
      h - value for the field h
      params - value for the field params

  • 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

    • readRoiType

      public Quark readRoiType()
      Read the value of the field roi_type.
      Returns:
      The value of the field roi_type

    • writeRoiType

      public void writeRoiType(Quark roiType)
      Write a value in the field roi_type.
      Parameters:
      roiType - The new value for the field roi_type

    • readId

      public int readId()
      Read the value of the field id.
      Returns:
      The value of the field id

    • writeId

      public void writeId(int id)
      Write a value in the field id.
      Parameters:
      id - The new value for the field id

    • readParentId

      public int readParentId()
      Read the value of the field parent_id.
      Returns:
      The value of the field parent_id

    • writeParentId

      public void writeParentId(int parentId)
      Write a value in the field parent_id.
      Parameters:
      parentId - The new value for the field parent_id

    • readX

      public int readX()
      Read the value of the field x.
      Returns:
      The value of the field x

    • writeX

      public void writeX(int x)
      Write a value in the field x.
      Parameters:
      x - The new value for the field x

    • readY

      public int readY()
      Read the value of the field y.
      Returns:
      The value of the field y

    • writeY

      public void writeY(int y)
      Write a value in the field y.
      Parameters:
      y - The new value for the field y

    • readW

      public int readW()
      Read the value of the field w.
      Returns:
      The value of the field w

    • writeW

      public void writeW(int w)
      Write a value in the field w.
      Parameters:
      w - The new value for the field w

    • readH

      public int readH()
      Read the value of the field h.
      Returns:
      The value of the field h

    • writeH

      public void writeH(int h)
      Write a value in the field h.
      Parameters:
      h - The new value for the field h

    • readParams

      public List<MemorySegment> readParams()
      Read the value of the field params.
      Returns:
      The value of the field params

    • writeParams

      public void writeParams(List<MemorySegment> params)
      Write a value in the field params.
      Parameters:
      params - The new value for the field params

    • getInfo

      public static MetaInfo getInfo()

    • addParam

      public void addParam(Structure s)

      Attach element-specific parameters to this VideoRegionOfInterestMeta meant to be used by downstream elements which may handle this ROI. The name of s is used to identify the element these parameters are meant for.

      This is typically used to tell encoders how they should encode this specific region. For example, a structure named "roi/x264enc" could be used to give the QP offsets this encoder should use when encoding the region described in meta. Multiple parameters can be defined for the same meta so different encoders can be supported by cross platform applications).

      Parameters:
      s - a GstStructure
      Since:
      1.14

    • getParam

      public @Nullable Structure getParam(String name)
      Retrieve the parameter for this VideoRegionOfInterestMeta having name as structure name, or null if there is none.
      Parameters:
      name - a name.
      Returns:
      a GstStructure
      Since:
      1.14