Package org.freedesktop.gstreamer.audio

Class AudioBaseSrc

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

org.freedesktop.gstreamer.audio.AudioBaseSrc

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

AudioSrc

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

This is the base class for audio sources. Subclasses need to implement the ::create_ringbuffer vmethod. This base class will then take care of reading samples from the ringbuffer, synchronisation and flushing.

Nested Class Summary

Nested Classes

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

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

PushSrc.PushSrcClass

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

Method Summary

Modifier and Type	Method	Description
protected AudioBaseSrc	asParent()	Returns this instance as if it were its parent type.
static AudioBaseSrc.Builder<? extends AudioBaseSrc.Builder>	builder()	A AudioBaseSrc.Builder object constructs a AudioBaseSrc with the specified properties.
@Nullable AudioRingBuffer	createRingbuffer()	Create and return the GstAudioRingBuffer for src. This function will call the ::create_ringbuffer vmethod and will set this AudioBaseSrc as the parent of the returned buffer (see gst_object_set_parent()).
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
boolean	getProvideClock()	Queries whether this AudioBaseSrc will provide a clock or not.
AudioBaseSrcSlaveMethod	getSlaveMethod()	Get the current slave method used by src.
static @Nullable Type	getType()	Get the GType of the AudioBaseSrc class
void	setProvideClock(boolean provide)	Controls whether this AudioBaseSrc will provide a clock or not.
void	setSlaveMethod(AudioBaseSrcSlaveMethod method)	Controls how clock slaving will be performed in src.

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

alloc, create, fill

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

AudioBaseSrc

public AudioBaseSrc(MemorySegment address)

Create a AudioBaseSrc proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

AudioBaseSrc

public AudioBaseSrc()

Creates a new AudioBaseSrc.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the AudioBaseSrc class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

createRingbuffer

public @Nullable AudioRingBuffer createRingbuffer()

Create and return the GstAudioRingBuffer for src. This function will call the ::create_ringbuffer vmethod and will set this AudioBaseSrc as the parent of the returned buffer (see gst_object_set_parent()).

Returns:

The new ringbuffer of src.

getProvideClock

public boolean getProvideClock()

Queries whether this AudioBaseSrc will provide a clock or not. See also gst_audio_base_src_set_provide_clock.

Returns:

true if this AudioBaseSrc will provide a clock.

getSlaveMethod

public AudioBaseSrcSlaveMethod getSlaveMethod()

Get the current slave method used by src.

Returns:

The current slave method used by src.

setProvideClock

public void setProvideClock(boolean provide)

Controls whether this AudioBaseSrc will provide a clock or not. If provide is true, gst_element_provide_clock() will return a clock that reflects the datarate of src. If provide is false, gst_element_provide_clock() will return NULL.

Parameters:

provide - new state

setSlaveMethod

public void setSlaveMethod(AudioBaseSrcSlaveMethod method)

Controls how clock slaving will be performed in src.

Parameters:

method - the new slave method

builder

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

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

Returns:

the builder object