Package org.freedesktop.gstreamer.audio

Class AudioClock

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

org.freedesktop.gstreamer.gst.SystemClock

org.freedesktop.gstreamer.audio.AudioClock

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class AudioClock
extends SystemClock

GstAudioClock makes it easy for elements to implement a GstClock, they simply need to provide a function that returns the current clock time.

This object is internally used to implement the clock in GstAudioBaseSink.

Nested Class Summary

Nested Classes

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

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

SystemClock.SystemClockClass

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

Clock.Clock$Impl, Clock.ClockClass, Clock.SyncedCallback

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
AudioClock()	Creates a new AudioClock.
AudioClock(MemorySegment address)	Create a AudioClock proxy instance for the provided memory address.
AudioClock(String name, @Nullable AudioClockGetTimeFunc func)	Create a new GstAudioClock instance.

Method Summary

Modifier and Type	Method	Description
ClockTime	adjust(ClockTime time)	Adjust time with the internal offset of the audio clock.
protected AudioClock	asParent()	Returns this instance as if it were its parent type.
static AudioClock.Builder<? extends AudioClock.Builder>	builder()	A AudioClock.Builder object constructs a AudioClock with the specified properties.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
ClockTime	getTime()	Report the time as returned by the GstAudioClockGetTimeFunc without applying any offsets.
static @Nullable Type	getType()	Get the GType of the AudioClock class
void	invalidate()	Invalidate the clock function.
void	reset(ClockTime time)	Inform this AudioClock that future calls to GstAudioClockGetTimeFunc will return values starting from time. The clock will update an internal offset to make sure that future calls to internal_time will return an increasing result as required by the GstClock object.

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

obtain, setDefault

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

addObservation, addObservationUnapplied, adjustUnlocked, adjustWithCalibration, changeResolution, emitSynced, getCalibration, getInternalTime, getMaster, getResolution, getTimeout, idCompareFunc, idGetClock, idGetTime, idRef, idUnref, idUnschedule, idUsesClock, idWait, idWaitAsync, isSynced, newPeriodicId, newSingleShotId, onSynced, periodicIdReinit, setCalibration, setMaster, setResolution, setSynced, setTimeout, singleShotIdReinit, unadjustUnlocked, unadjustWithCalibration, unschedule, wait_, waitAsync, waitForSync

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

AudioClock

public AudioClock(MemorySegment address)

Create a AudioClock proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

AudioClock

public AudioClock(String name,
 @Nullable AudioClockGetTimeFunc func)

Create a new GstAudioClock instance. Whenever the clock time should be calculated it will call func with userData. When func returns GST_CLOCK_TIME_NONE, the clock will return the last reported time.

Parameters:

name - the name of the clock

func - a function

AudioClock

public AudioClock()

Creates a new AudioClock.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the AudioClock class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected AudioClock 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 SystemClock

adjust

public ClockTime adjust(ClockTime time)

Adjust time with the internal offset of the audio clock.

Parameters:

time - a GstClockTime

Returns:

time adjusted with the internal offset.

getTime

public ClockTime getTime()

Report the time as returned by the GstAudioClockGetTimeFunc without applying any offsets.

Overrides:

getTime in class Clock

Returns:

the time as reported by the time function of the audio clock

invalidate

public void invalidate()

Invalidate the clock function. Call this function when the provided GstAudioClockGetTimeFunc cannot be called anymore, for example, when the user_data becomes invalid.

After calling this function, this AudioClock will return the last returned time for the rest of its lifetime.

reset

public void reset(ClockTime time)

Inform this AudioClock that future calls to GstAudioClockGetTimeFunc will return values starting from time. The clock will update an internal offset to make sure that future calls to internal_time will return an increasing result as required by the GstClock object.

Parameters:

time - a GstClockTime

builder

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

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

Returns:

the builder object