Package org.freedesktop.gstreamer.audio

Class AudioBaseSink

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

org.freedesktop.gstreamer.audio.AudioBaseSink

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

AudioSink

@Generated("io.github.jwharm.JavaGI")
public class AudioBaseSink
extends BaseSink

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

Nested Class Summary

Nested Classes

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

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

BaseSink.BaseSink$Impl, BaseSink.BaseSinkClass

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

Method Summary

Modifier and Type	Method	Description
protected AudioBaseSink	asParent()	Returns this instance as if it were its parent type.
static AudioBaseSink.Builder<? extends AudioBaseSink.Builder>	builder()	A AudioBaseSink.Builder object constructs a AudioBaseSink with the specified properties.
@Nullable AudioRingBuffer	createRingbuffer()	Create and return the GstAudioRingBuffer for sink. This function will call the ::create_ringbuffer vmethod and will set this AudioBaseSink as the parent of the returned buffer (see gst_object_set_parent()).
ClockTime	getAlignmentThreshold()	Get the current alignment threshold, in nanoseconds, used by sink.
ClockTime	getDiscontWait()	Get the current discont wait, in nanoseconds, used by sink.
long	getDriftTolerance()	Get the current drift tolerance, in microseconds, used by sink.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
boolean	getProvideClock()	Queries whether this AudioBaseSink will provide a clock or not.
AudioBaseSinkSlaveMethod	getSlaveMethod()	Get the current slave method used by sink.
static @Nullable Type	getType()	Get the GType of the AudioBaseSink class
protected Buffer	payload(Buffer buffer)	payload data in a format suitable to write to the sink.
void	reportDeviceFailure()	Informs this base class that the audio output device has failed for some reason, causing a discontinuity (for example, because the device recovered from the error, but lost all contents of its ring buffer).
void	setAlignmentThreshold(ClockTime alignmentThreshold)	Controls the sink's alignment threshold.
void	setCustomSlavingCallback(@Nullable AudioBaseSinkCustomSlavingCallback callback)	Sets the custom slaving callback.
void	setDiscontWait(ClockTime discontWait)	Controls how long the sink will wait before creating a discontinuity.
void	setDriftTolerance(long driftTolerance)	Controls the sink's drift tolerance.
void	setProvideClock(boolean provide)	Controls whether this AudioBaseSink will provide a clock or not.
void	setSlaveMethod(AudioBaseSinkSlaveMethod method)	Controls how clock slaving will be performed in sink.

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

activatePull, doPreroll, event, fixate, getBlocksize, getCaps, getDropOutOfSegment, getLastSample, getLatency, getMaxBitrate, getMaxLateness, getProcessingDeadline, getRenderDelay, getStats, getSync, getThrottleTime, getTimes, getTsOffset, isAsyncEnabled, isLastSampleEnabled, isQosEnabled, prepare, prepareList, preroll, proposeAllocation, query, queryLatency, render, renderList, setAsyncEnabled, setBlocksize, setCaps, setDropOutOfSegment, setLastSampleEnabled, setMaxBitrate, setMaxLateness, setProcessingDeadline, setQosEnabled, setRenderDelay, setSync, setThrottleTime, setTsOffset, start, stop, unlock, unlockStop, wait_, waitClock, waitEvent, waitPreroll

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

AudioBaseSink

public AudioBaseSink(MemorySegment address)

Create a AudioBaseSink proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

AudioBaseSink

public AudioBaseSink()

Creates a new AudioBaseSink.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the AudioBaseSink class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected AudioBaseSink 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 BaseSink

createRingbuffer

public @Nullable AudioRingBuffer createRingbuffer()

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

Returns:

The new ringbuffer of sink.

getAlignmentThreshold

public ClockTime getAlignmentThreshold()

Get the current alignment threshold, in nanoseconds, used by sink.

Returns:

The current alignment threshold used by sink.

getDiscontWait

public ClockTime getDiscontWait()

Get the current discont wait, in nanoseconds, used by sink.

Returns:

The current discont wait used by sink.

getDriftTolerance

public long getDriftTolerance()

Get the current drift tolerance, in microseconds, used by sink.

Returns:

The current drift tolerance used by sink.

getProvideClock

public boolean getProvideClock()

Queries whether this AudioBaseSink will provide a clock or not. See also gst_audio_base_sink_set_provide_clock.

Returns:

true if this AudioBaseSink will provide a clock.

getSlaveMethod

public AudioBaseSinkSlaveMethod getSlaveMethod()

Get the current slave method used by sink.

Returns:

The current slave method used by sink.

reportDeviceFailure

public void reportDeviceFailure()

Informs this base class that the audio output device has failed for some reason, causing a discontinuity (for example, because the device recovered from the error, but lost all contents of its ring buffer). This function is typically called by derived classes, and is useful for the custom slave method.

Since:

1.6

setAlignmentThreshold

public void setAlignmentThreshold(ClockTime alignmentThreshold)

Controls the sink's alignment threshold.

Parameters:

alignmentThreshold - the new alignment threshold in nanoseconds

setCustomSlavingCallback

public void setCustomSlavingCallback(@Nullable AudioBaseSinkCustomSlavingCallback callback)

Sets the custom slaving callback. This callback will be invoked if the slave-method property is set to GST_AUDIO_BASE_SINK_SLAVE_CUSTOM and the audio sink receives and plays samples.

Setting the callback to NULL causes the sink to behave as if the GST_AUDIO_BASE_SINK_SLAVE_NONE method were used.

Parameters:

callback - a GstAudioBaseSinkCustomSlavingCallback

Since:

1.6

setDiscontWait

public void setDiscontWait(ClockTime discontWait)

Controls how long the sink will wait before creating a discontinuity.

Parameters:

discontWait - the new discont wait in nanoseconds

setDriftTolerance

public void setDriftTolerance(long driftTolerance)

Controls the sink's drift tolerance.

Parameters:

driftTolerance - the new drift tolerance in microseconds

setProvideClock

public void setProvideClock(boolean provide)

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

Parameters:

provide - new state

setSlaveMethod

public void setSlaveMethod(AudioBaseSinkSlaveMethod method)

Controls how clock slaving will be performed in sink.

Parameters:

method - the new slave method

payload

protected Buffer payload(Buffer buffer)

payload data in a format suitable to write to the sink. If no payloading is required, returns a reffed copy of the original buffer, else returns the payloaded buffer with all other metadata copied.

builder

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

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

Returns:

the builder object