Class BaseParseFrame

java.lang.Object
org.javagi.base.ProxyInstance
org.freedesktop.gstreamer.base.BaseParseFrame
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class BaseParseFrame extends ProxyInstance
Frame (context) data passed to each frame parsing virtual methods. In addition to providing the data to be checked for a valid frame or an already identified frame, it conveys additional metadata or control information from and to the subclass w.r.t. the particular frame in question (rather than global parameters). Some of these may apply to each parsing stage, others only to some a particular one. These parameters are effectively zeroed at start of each frame's processing, i.e. parsing virtual method invocation sequence.

  • Constructor Details

    • BaseParseFrame

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

    • BaseParseFrame

      public BaseParseFrame(Buffer buffer, Set<BaseParseFrameFlags> flags, int overhead)
      Allocates a new GstBaseParseFrame. This function is mainly for bindings, elements written in C should usually allocate the frame on the stack and then use gst_base_parse_frame_init() to initialise it.
      Parameters:
      buffer - a GstBuffer
      flags - the flags
      overhead - number of bytes in this frame which should be counted as metadata overhead, ie. not used to calculate the average bitrate. Set to -1 to mark the entire frame as metadata. If in doubt, set to 0.

    • BaseParseFrame

      public BaseParseFrame(Buffer buffer, BaseParseFrameFlags flags, int overhead)
      Allocates a new GstBaseParseFrame. This function is mainly for bindings, elements written in C should usually allocate the frame on the stack and then use gst_base_parse_frame_init() to initialise it.
      Parameters:
      buffer - a GstBuffer
      flags - the flags
      overhead - number of bytes in this frame which should be counted as metadata overhead, ie. not used to calculate the average bitrate. Set to -1 to mark the entire frame as metadata. If in doubt, set to 0.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the BaseParseFrame class.
      Returns:
      the GType

    • getMemoryLayout

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

    • readBuffer

      public Buffer readBuffer()
      Read the value of the field buffer.
      Returns:
      The value of the field buffer

    • writeBuffer

      public void writeBuffer(Buffer buffer)
      Write a value in the field buffer.
      Parameters:
      buffer - The new value for the field buffer

    • readOutBuffer

      public Buffer readOutBuffer()
      Read the value of the field out_buffer.
      Returns:
      The value of the field out_buffer

    • writeOutBuffer

      public void writeOutBuffer(Buffer outBuffer)
      Write a value in the field out_buffer.
      Parameters:
      outBuffer - The new value for the field out_buffer

    • readFlags

      public int readFlags()
      Read the value of the field flags.
      Returns:
      The value of the field flags

    • writeFlags

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

    • readOffset

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

    • writeOffset

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

    • readOverhead

      public int readOverhead()
      Read the value of the field overhead.
      Returns:
      The value of the field overhead

    • writeOverhead

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

    • readSize

      public int readSize()
      Read the value of the field size.
      Returns:
      The value of the field size

    • writeSize

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

    • read_privateFlags

      public int read_privateFlags()
      Read the value of the field _private_flags.
      Returns:
      The value of the field _private_flags

    • write_privateFlags

      public void write_privateFlags(int _privateFlags)
      Write a value in the field _private_flags.
      Parameters:
      _privateFlags - The new value for the field _private_flags

    • copy

      public BaseParseFrame copy()
      Copies a GstBaseParseFrame.
      Returns:
      A copy of this BaseParseFrame
      Since:
      1.12.1

    • free

      public void free()
      Frees the provided frame.

    • init

      public void init()
      Sets a GstBaseParseFrame to initial state. Currently this means all public fields are zero-ed and a private flag is set to make sure gst_base_parse_frame_free() only frees the contents but not the actual frame. Use this function to initialise a GstBaseParseFrame allocated on the stack.