GI.GstAudio.Objects.AudioClock

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

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

Exported types

newtype AudioClock

Memory-managed wrapper type.

Constructors

AudioClock (ManagedPtr AudioClock)

Instances

Eq AudioClock

Defined in GI.GstAudio.Objects.AudioClock

Methods

(==) :: AudioClock -> AudioClock -> Bool

(/=) :: AudioClock -> AudioClock -> Bool

GObject AudioClock

Defined in GI.GstAudio.Objects.AudioClock

ManagedPtrNewtype AudioClock

Defined in GI.GstAudio.Objects.AudioClock

Methods

toManagedPtr :: AudioClock -> ManagedPtr AudioClock

TypedObject AudioClock

Defined in GI.GstAudio.Objects.AudioClock

Methods

glibType :: IO GType

HasParentTypes AudioClock

Defined in GI.GstAudio.Objects.AudioClock

IsGValue (Maybe AudioClock)

Convert AudioClock to and from GValue. See toGValue and fromGValue.

Defined in GI.GstAudio.Objects.AudioClock

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe AudioClock -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe AudioClock)

type ParentTypes AudioClock

Defined in GI.GstAudio.Objects.AudioClock

type ParentTypes AudioClock = '[SystemClock, Clock, Object, Object]

class (GObject o, IsDescendantOf AudioClock o) => IsAudioClock o

Type class for types which can be safely cast to AudioClock, for instance with toAudioClock.

Instances

(GObject o, IsDescendantOf AudioClock o) => IsAudioClock o

Defined in GI.GstAudio.Objects.AudioClock

toAudioClock :: (MonadIO m, IsAudioClock o) => o -> m AudioClock

Cast to AudioClock, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

addControlBinding, addObservation, addObservationUnapplied, adjust, adjustUnlocked, adjustWithCalibration, bindProperty, bindPropertyFull, defaultError, forceFloating, freezeNotify, getv, hasActiveControlBindings, hasAncestor, hasAsAncestor, hasAsParent, invalidate, isFloating, isSynced, newPeriodicId, newSingleShotId, notify, notifyByPspec, periodicIdReinit, ref, refSink, removeControlBinding, reset, runDispose, singleShotIdReinit, stealData, stealQdata, suggestNextSync, syncValues, thawNotify, unadjustUnlocked, unadjustWithCalibration, unparent, unref, waitForSync, watchClosure.

Getters

getCalibration, getControlBinding, getControlRate, getData, getGValueArray, getInternalTime, getMaster, getName, getParent, getPathString, getProperty, getQdata, getResolution, getTime, getTimeout, getValue.

Setters

setCalibration, setControlBindingDisabled, setControlBindingsDisabled, setControlRate, setData, setDataFull, setMaster, setName, setParent, setProperty, setResolution, setSynced, setTimeout.

adjust

audioClockAdjust

Arguments

:: (HasCallStack, MonadIO m, IsAudioClock a)

=> a

clock: a AudioClock

-> Word64

time: a GstClockTime

-> m Word64

Returns: time adjusted with the internal offset.

Adjust time with the internal offset of the audio clock.

getTime

audioClockGetTime

Arguments

:: (HasCallStack, MonadIO m, IsAudioClock a)

=> a

clock: a AudioClock

-> m Word64

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

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

invalidate

audioClockInvalidate

Arguments

:: (HasCallStack, MonadIO m, IsAudioClock a)

=> a

clock: a AudioClock

-> m ()

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

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

new

audioClockNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: the name of the clock

-> AudioClockGetTimeFunc

func: a function

-> m AudioClock

Returns: a new AudioClock casted to a Clock.

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

reset

audioClockReset

Arguments

:: (HasCallStack, MonadIO m, IsAudioClock a)

=> a

clock: a AudioClock

-> Word64

time: a GstClockTime

-> m ()

Inform clock that future calls to AudioClockGetTimeFunc 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 Clock object.