Class AggregatorPad

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.gobject.InitiallyUnowned
org.freedesktop.gstreamer.gst.GstObject
org.freedesktop.gstreamer.gst.Pad
org.freedesktop.gstreamer.base.AggregatorPad
All Implemented Interfaces:
Proxy
Direct Known Subclasses:
AudioAggregatorPad, VideoAggregatorPad
@Generated("org.javagi.JavaGI") public class AggregatorPad extends Pad

Pads managed by a GstAggregator subclass.

This class used to live in gst-plugins-bad and was moved to core.

Since:
1.14

  • Constructor Details

    • AggregatorPad

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

    • AggregatorPad

      public AggregatorPad()
      Create a new AggregatorPad.

  • Method Details

    • getType

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

    • getMemoryLayout

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

    • asParent

      protected AggregatorPad asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class Pad
      Returns:
      the instance as if it were its parent type

    • dropBuffer

      public boolean dropBuffer()
      Drop the buffer currently queued in pad.
      Returns:
      TRUE if there was a buffer queued in pad, or FALSE if not.

    • hasBuffer

      public boolean hasBuffer()
      This checks if a pad has a buffer available that will be returned by a call to gst_aggregator_pad_peek_buffer() or gst_aggregator_pad_pop_buffer().
      Returns:
      true if the pad has a buffer available as the next thing.
      Since:
      1.14.1

    • isEos

      public boolean isEos()

    • isInactive

      public boolean isInactive()
      It is only valid to call this method from GstAggregatorClass::aggregate()
      Returns:
      true if the pad is inactive, false otherwise. See gst_aggregator_ignore_inactive_pads() for more info.
      Since:
      1.20

    • peekBuffer

      public @Nullable Buffer peekBuffer()

    • popBuffer

      public @Nullable Buffer popBuffer()
      Steal the ref to the buffer currently queued in pad.
      Returns:
      The buffer in this AggregatorPad or NULL if no buffer was queued. You should unref the buffer after usage.

    • flush

      protected FlowReturn flush(Aggregator aggregator)
      Optional Called when the pad has received a flush stop, this is the place to flush any information specific to the pad, it allows for individual pads to be flushed while others might not be.

    • skipBuffer

      protected boolean skipBuffer(Aggregator aggregator, Buffer buffer)
      Optional Called before input buffers are queued in the pad, return true if the buffer should be skipped.

    • onBufferConsumed

      public SignalConnection<AggregatorPad.BufferConsumedCallback> onBufferConsumed(AggregatorPad.BufferConsumedCallback handler)
      See Also:

    • emitBufferConsumed

      public void emitBufferConsumed(@Nullable Buffer object)

    • builder

      public static AggregatorPad.Builder<? extends AggregatorPad.Builder> builder()
      A AggregatorPad.Builder object constructs a AggregatorPad with the specified properties. Use the various set...() methods to set properties, and finish construction with AggregatorPad.Builder.build().
      Returns:
      the builder object