Package org.freedesktop.gstreamer.base

Class PushSrc

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.Element

org.freedesktop.gstreamer.base.BaseSrc

org.freedesktop.gstreamer.base.PushSrc

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

AudioBaseSrc, AudioCdSrc

@Generated("io.github.jwharm.JavaGI")
public class PushSrc
extends BaseSrc

This class is mostly useful for elements that cannot do random access, or at least very slowly. The source usually prefers to push out a fixed size buffer.

Subclasses usually operate in a format that is different from the default GST_FORMAT_BYTES format of GstBaseSrc.

Classes extending this base class will usually be scheduled in a push based mode. If the peer accepts to operate without offsets and within the limits of the allowed block size, this class can operate in getrange based mode automatically. To make this possible, the subclass should implement and override the SCHEDULING query.

The subclass should extend the methods from the baseclass in addition to the ::create method.

Seeking, flushing, scheduling and sync is all handled by this base class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PushSrc.Builder<B extends PushSrc.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	PushSrc.PushSrcClass	Subclasses can override any of the available virtual methods or not, as needed.

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

BaseSrc.BaseSrc$Impl, BaseSrc.BaseSrcClass

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

Element.Element$Impl, Element.ElementClass, Element.NoMorePadsCallback, Element.PadAddedCallback, Element.PadRemovedCallback

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

Method Summary

Modifier and Type	Method	Description
protected FlowReturn	alloc(@Nullable Out<Buffer> buf)	Allocate memory for a buffer.
protected PushSrc	asParent()	Returns this instance as if it were its parent type.
static PushSrc.Builder<? extends PushSrc.Builder>	builder()	A PushSrc.Builder object constructs a PushSrc with the specified properties.
protected FlowReturn	create(@Nullable Out<Buffer> buf)	Ask the subclass to create a buffer, the default implementation will call alloc if no allocated buf is provided and then call fill.
protected FlowReturn	fill(Buffer buf)	Ask the subclass to fill the buffer with data.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the PushSrc class

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

alloc, create, decideAllocation, doSeek, event, fill, fixate, getAllocator, getBlocksize, getBufferPool, getCaps, getDoTimestamp, getSize, getTimes, isAsync, isLive, isSeekable, negotiate, newSeamlessSegment, newSegment, prepareSeekSegment, pushSegment, query, queryLatency, setAsync, setAutomaticEos, setBlocksize, setCaps, setDoTimestamp, setDynamicSize, setFormat, setLive, start, startComplete, startWait, stop, submitBufferList, unlock, unlockStop, waitPlaying

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

abortState, addPad, addPropertyDeepNotifyWatch, addPropertyNotifyWatch, callAsync, changeState, continueState, createAllPads, decorateStreamId, decorateStreamIdPrintf, emitNoMorePads, emitPadAdded, emitPadRemoved, foreachPad, foreachSinkPad, foreachSrcPad, getBaseTime, getBus, getClock, getCompatiblePad, getCompatiblePadTemplate, getContext, getContexts, getContextUnlocked, getCurrentClockTime, getCurrentRunningTime, getFactory, getMetadata, getPadTemplate, getPadTemplateList, getRequestPad, getStartTime, getState, getStaticPad, isLockedState, iteratePads, iterateSinkPads, iterateSrcPads, link, linkFiltered, linkMany, linkPads, linkPadsFiltered, linkPadsFull, linkPadsFull, lostState, makeFromUri, messageFull, messageFull, messageFullWithDetails, messageFullWithDetails, noMorePads, onNoMorePads, onPadAdded, onPadRemoved, padAdded, padRemoved, postMessage, provideClock, queryConvert, queryDuration, queryPosition, register, releasePad, releaseRequestPad, removePad, removePropertyNotifyWatch, requestPad, requestPadSimple, seek, seek, seekSimple, seekSimple, sendEvent, setBaseTime, setBus, setClock, setContext, setLockedState, setStartTime, setState, stateChanged, stateChangeReturnGetName, stateGetName, syncStateWithParent, typeSetSkipDocumentation, unlink, unlinkMany, unlinkPads

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

PushSrc

public PushSrc(MemorySegment address)

Create a PushSrc proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

PushSrc

public PushSrc()

Creates a new PushSrc.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the PushSrc class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected PushSrc 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 BaseSrc

alloc

protected FlowReturn alloc(@Nullable Out<Buffer> buf)

Allocate memory for a buffer.

create

protected FlowReturn create(@Nullable Out<Buffer> buf)

Ask the subclass to create a buffer, the default implementation will call alloc if no allocated buf is provided and then call fill.

fill

protected FlowReturn fill(Buffer buf)

Ask the subclass to fill the buffer with data.

builder

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

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

Returns:

the builder object