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

Constructors

AudioClock (ManagedPtr AudioClock)

Instances

GObject AudioClock

Methods

gobjectType :: AudioClock -> IO GType

IsObject AudioClock

IsSystemClock AudioClock

IsClock AudioClock

IsObject AudioClock

IsAudioClock AudioClock

((~) * info (ResolveAudioClockMethod t AudioClock), MethodInfo * info AudioClock p) => IsLabel t (AudioClock -> p)

Methods

fromLabel :: Proxy# Symbol t -> AudioClock -> p

((~) * info (ResolveAudioClockMethod t AudioClock), MethodInfo * info AudioClock p) => IsLabelProxy t (AudioClock -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> AudioClock -> p

HasAttributeList * AudioClock

type AttributeList AudioClock

type AttributeList AudioClock

type SignalList AudioClock

type SignalList AudioClock

class GObject o => IsAudioClock o

Instances

(GObject a, UnknownAncestorError Constraint AudioClock a) => IsAudioClock a

IsAudioClock AudioClock

toAudioClock :: IsAudioClock o => o -> IO AudioClock

noAudioClock :: Maybe AudioClock

Methods

adjust

audioClockAdjust

Arguments

:: (HasCallStack, MonadIO m, IsClock 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, IsClock 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, IsClock 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

data AudioClockResetMethodInfo

Instances

((~) * signature (Word64 -> m ()), MonadIO m, IsAudioClock a) => MethodInfo * AudioClockResetMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AudioClockResetMethodInfo a -> signature -> s

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.