Package org.freedesktop.gstreamer.video

Class VideoAggregatorPad

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

org.freedesktop.gstreamer.video.VideoAggregatorPad

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

VideoAggregatorConvertPad

@Generated("io.github.jwharm.JavaGI")
public class VideoAggregatorPad
extends AggregatorPad

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VideoAggregatorPad.Builder<B extends VideoAggregatorPad.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	VideoAggregatorPad.VideoAggregatorPadClass

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.base.AggregatorPad

AggregatorPad.AggregatorPadClass, AggregatorPad.BufferConsumedCallback

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
VideoAggregatorPad()	Creates a new VideoAggregatorPad.
VideoAggregatorPad(MemorySegment address)	Create a VideoAggregatorPad proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected VideoAggregatorPad	asParent()	Returns this instance as if it were its parent type.
static VideoAggregatorPad.Builder<? extends VideoAggregatorPad.Builder>	builder()	A VideoAggregatorPad.Builder object constructs a VideoAggregatorPad with the specified properties.
protected void	cleanFrame(VideoAggregator videoaggregator, VideoFrame preparedFrame)	clean the frame previously prepared in prepare_frame
Buffer	getCurrentBuffer()	Returns the currently queued buffer that is going to be used for the current output frame.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
VideoFrame	getPreparedFrame()	Returns the currently prepared video frame that has to be aggregated into the current output frame.
static @Nullable Type	getType()	Get the GType of the VideoAggregatorPad class
boolean	hasCurrentBuffer()	Checks if the pad currently has a buffer queued that is going to be used for the current output frame.
protected boolean	prepareFrame(VideoAggregator videoaggregator, Buffer buffer, VideoFrame preparedFrame)	Prepare the frame from the pad buffer and sets it to prepared_frame.
protected void	prepareFrameFinish(VideoAggregator videoaggregator, VideoFrame preparedFrame)	Finish preparing preparedFrame.
protected void	prepareFrameStart(VideoAggregator videoaggregator, Buffer buffer, VideoFrame preparedFrame)	Begin preparing the frame from the pad buffer and sets it to prepared_frame.
void	setNeedsAlpha(boolean needsAlpha)	Allows selecting that this pad requires an output format with alpha
protected void	updateConversionInfo()	Called when either the input or output formats have changed.

Methods inherited from class org.freedesktop.gstreamer.base.AggregatorPad

dropBuffer, emitBufferConsumed, flush, hasBuffer, isEos, isInactive, onBufferConsumed, peekBuffer, popBuffer, skipBuffer

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

VideoAggregatorPad

public VideoAggregatorPad(MemorySegment address)

Create a VideoAggregatorPad proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

VideoAggregatorPad

public VideoAggregatorPad()

Creates a new VideoAggregatorPad.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the VideoAggregatorPad class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected VideoAggregatorPad 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 AggregatorPad

getCurrentBuffer

public Buffer getCurrentBuffer()

Returns the currently queued buffer that is going to be used for the current output frame.

This must only be called from the GstVideoAggregatorClass::aggregate_frames virtual method, or from the GstVideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.

The return value is only valid until GstVideoAggregatorClass::aggregate_frames or GstVideoAggregatorPadClass::prepare_frame returns.

Returns:

The currently queued buffer

getPreparedFrame

public VideoFrame getPreparedFrame()

Returns the currently prepared video frame that has to be aggregated into the current output frame.

This must only be called from the GstVideoAggregatorClass::aggregate_frames virtual method, or from the GstVideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.

The return value is only valid until GstVideoAggregatorClass::aggregate_frames or GstVideoAggregatorPadClass::prepare_frame returns.

Returns:

The currently prepared video frame

hasCurrentBuffer

public boolean hasCurrentBuffer()

Checks if the pad currently has a buffer queued that is going to be used for the current output frame.

This must only be called from the GstVideoAggregatorClass::aggregate_frames virtual method, or from the GstVideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.

Returns:

true if the pad has currently a buffer queued

setNeedsAlpha

public void setNeedsAlpha(boolean needsAlpha)

Allows selecting that this pad requires an output format with alpha

Parameters:

needsAlpha - true if this pad requires alpha output

cleanFrame

protected void cleanFrame(VideoAggregator videoaggregator,
 VideoFrame preparedFrame)

clean the frame previously prepared in prepare_frame

prepareFrame

protected boolean prepareFrame(VideoAggregator videoaggregator,
 Buffer buffer,
 VideoFrame preparedFrame)

Prepare the frame from the pad buffer and sets it to prepared_frame. Implementations should always return TRUE. Returning FALSE will cease iteration over subsequent pads.

prepareFrameFinish

protected void prepareFrameFinish(VideoAggregator videoaggregator,
 VideoFrame preparedFrame)

Finish preparing preparedFrame.

If overriden, prepare_frame_start must also be overriden.

Parameters:

videoaggregator - the parent GstVideoAggregator

preparedFrame - the GstVideoFrame to prepare into

Since:

1.20

prepareFrameStart

protected void prepareFrameStart(VideoAggregator videoaggregator,
 Buffer buffer,
 VideoFrame preparedFrame)

Begin preparing the frame from the pad buffer and sets it to prepared_frame.

If overriden, prepare_frame_finish must also be overriden.

Parameters:

videoaggregator - the parent GstVideoAggregator

buffer - the input GstBuffer to prepare

preparedFrame - the GstVideoFrame to prepare into

Since:

1.20

updateConversionInfo

protected void updateConversionInfo()

Called when either the input or output formats have changed.

builder

public static VideoAggregatorPad.Builder<? extends VideoAggregatorPad.Builder> builder()

A VideoAggregatorPad.Builder object constructs a VideoAggregatorPad with the specified properties. Use the various set...() methods to set properties, and finish construction with VideoAggregatorPad.Builder.build().

Returns:

the builder object