Package org.freedesktop.gstreamer.base

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("io.github.jwharm.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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AggregatorPad.AggregatorPadClass
static interface	AggregatorPad.BufferConsumedCallback	Functional interface declaration of the BufferConsumedCallback callback.
static class	AggregatorPad.Builder<B extends AggregatorPad.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.gst.Pad

Pad.LinkedCallback, Pad.PadClass, Pad.UnlinkedCallback

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.gst.GstObject

GstObject.DeepNotifyCallback, GstObject.Object$Impl, GstObject.ObjectClass

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback

Constructor Summary

Constructors

Constructor	Description
AggregatorPad()	Creates a new AggregatorPad.
AggregatorPad(MemorySegment address)	Create a AggregatorPad proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected AggregatorPad	asParent()	Returns this instance as if it were its parent type.
static AggregatorPad.Builder<? extends AggregatorPad.Builder>	builder()	A AggregatorPad.Builder object constructs a AggregatorPad with the specified properties.
boolean	dropBuffer()	Drop the buffer currently queued in pad.
void	emitBufferConsumed(@Nullable Buffer object)
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.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the AggregatorPad class
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().
boolean	isEos()
boolean	isInactive()	It is only valid to call this method from GstAggregatorClass::aggregate()
SignalConnection<AggregatorPad.BufferConsumedCallback>	onBufferConsumed(AggregatorPad.BufferConsumedCallback handler)
@Nullable Buffer	peekBuffer()
@Nullable Buffer	popBuffer()	Steal the ref to the buffer currently queued in pad.
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.

Methods inherited from class org.freedesktop.gstreamer.gst.Pad

activateMode, addProbe, addProbe, canLink, chain, chainList, checkReconfigure, createStreamId, createStreamIdPrintf, emitLinked, emitUnlinked, eventDefault, forward, fromStaticTemplate, fromTemplate, getAllowedCaps, getCurrentCaps, getDirection, getElementPrivate, getLastFlowReturn, getOffset, getPadTemplate, getPadTemplateCaps, getParentElement, getPeer, getRange, getSingleInternalLink, getStickyEvent, getStream, getStreamId, getTaskState, hasCurrentCaps, isActive, isBlocked, isBlocking, isLinked, iterateInternalLinks, iterateInternalLinksDefault, link, linked, linkFull, linkFull, linkGetName, linkMaybeGhosting, linkMaybeGhostingFull, linkMaybeGhostingFull, markReconfigure, needsReconfigure, onLinked, onUnlinked, pauseTask, peerQuery, peerQueryAcceptCaps, peerQueryCaps, peerQueryConvert, peerQueryDuration, peerQueryPosition, proxyQueryAcceptCaps, proxyQueryCaps, pullRange, push, pushEvent, pushList, query, queryAcceptCaps, queryCaps, queryConvert, queryDefault, queryDuration, queryPosition, removeProbe, sendEvent, setActivateFunctionFull, setActivatemodeFunctionFull, setActive, setChainFunctionFull, setChainListFunctionFull, setElementPrivate, setEventFullFunctionFull, setEventFunctionFull, setGetrangeFunctionFull, setIterateInternalLinksFunctionFull, setLinkFunctionFull, setOffset, setQueryFunctionFull, setUnlinkFunctionFull, startTask, stickyEventsForeach, stopTask, storeStickyEvent, unlink, unlinked, useFixedCaps

Methods inherited from class org.freedesktop.gstreamer.gst.GstObject

addControlBinding, checkUniqueness, deepNotify, defaultDeepNotify, defaultError, emitDeepNotify, getControlBinding, getControlRate, getGValueArray, getName, getParent, getPathString, getValue, getValueArray, hasActiveControlBindings, hasAncestor, hasAsAncestor, hasAsParent, onDeepNotify, ref, refSink, removeControlBinding, replace, setControlBindingDisabled, setControlBindingsDisabled, setControlRate, setName, setParent, suggestNextSync, syncValues, unparent, unref

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

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

AggregatorPad

public AggregatorPad(MemorySegment address)

Create a AggregatorPad proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

AggregatorPad

public AggregatorPad()

Creates 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()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class Pad

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:

• AggregatorPad.BufferConsumedCallback.run(org.freedesktop.gstreamer.gst.Buffer)

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