GI.GstAudio.Objects.AudioBaseSink

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.

Exported types

newtype AudioBaseSink

Constructors

AudioBaseSink (ManagedPtr AudioBaseSink)

Instances

GObject AudioBaseSink

Methods

gobjectType :: AudioBaseSink -> IO GType

IsObject AudioBaseSink

IsElement AudioBaseSink

IsObject AudioBaseSink

IsBaseSink AudioBaseSink

IsAudioBaseSink AudioBaseSink

class GObject o => IsAudioBaseSink o

Instances

(GObject a, UnknownAncestorError Constraint AudioBaseSink a) => IsAudioBaseSink a

IsAudioBaseSink AudioBaseSink

IsAudioBaseSink AudioSink

toAudioBaseSink :: (MonadIO m, IsAudioBaseSink o) => o -> m AudioBaseSink

noAudioBaseSink :: Maybe AudioBaseSink

Methods

createRingbuffer

audioBaseSinkCreateRingbuffer

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink.

-> m AudioRingBuffer

Returns: The new ringbuffer of sink.

Create and return the AudioRingBuffer for sink. This function will call the ::create_ringbuffer vmethod and will set sink as the parent of the returned buffer (see objectSetParent).

getAlignmentThreshold

audioBaseSinkGetAlignmentThreshold

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink

-> m Word64

Returns: The current alignment threshold used by sink.

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

getDiscontWait

audioBaseSinkGetDiscontWait

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink

-> m Word64

Returns: The current discont wait used by sink.

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

getDriftTolerance

audioBaseSinkGetDriftTolerance

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink

-> m Int64

Returns: The current drift tolerance used by sink.

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

getProvideClock

audioBaseSinkGetProvideClock

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink

-> m Bool

Returns: True if sink will provide a clock.

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

getSlaveMethod

audioBaseSinkGetSlaveMethod

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink

-> m AudioBaseSinkSlaveMethod

Returns: The current slave method used by sink.

Get the current slave method used by sink.

reportDeviceFailure

audioBaseSinkReportDeviceFailure

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink

-> m ()

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

audioBaseSinkSetAlignmentThreshold

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink

-> Word64

alignmentThreshold: the new alignment threshold in nanoseconds

-> m ()

Controls the sink's alignment threshold.

setCustomSlavingCallback

audioBaseSinkSetCustomSlavingCallback

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink

-> AudioBaseSinkCustomSlavingCallback

callback: a AudioBaseSinkCustomSlavingCallback

-> m ()

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.

Since: 1.6

setDiscontWait

audioBaseSinkSetDiscontWait

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink

-> Word64

discontWait: the new discont wait in nanoseconds

-> m ()

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

setDriftTolerance

audioBaseSinkSetDriftTolerance

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink

-> Int64

driftTolerance: the new drift tolerance in microseconds

-> m ()

Controls the sink's drift tolerance.

setProvideClock

audioBaseSinkSetProvideClock

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink

-> Bool

provide: new state

-> m ()

Controls whether sink will provide a clock or not. If provide is True, elementProvideClock will return a clock that reflects the datarate of sink. If provide is False, elementProvideClock will return NULL.

setSlaveMethod

audioBaseSinkSetSlaveMethod

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> a

sink: a AudioBaseSink

-> AudioBaseSinkSlaveMethod

method: the new slave method

-> m ()

Controls how clock slaving will be performed in sink.

Properties

alignmentThreshold

constructAudioBaseSinkAlignmentThreshold :: IsAudioBaseSink o => Word64 -> IO (GValueConstruct o)

getAudioBaseSinkAlignmentThreshold :: (MonadIO m, IsAudioBaseSink o) => o -> m Word64

setAudioBaseSinkAlignmentThreshold :: (MonadIO m, IsAudioBaseSink o) => o -> Word64 -> m ()

bufferTime

constructAudioBaseSinkBufferTime :: IsAudioBaseSink o => Int64 -> IO (GValueConstruct o)

getAudioBaseSinkBufferTime :: (MonadIO m, IsAudioBaseSink o) => o -> m Int64

setAudioBaseSinkBufferTime :: (MonadIO m, IsAudioBaseSink o) => o -> Int64 -> m ()

canActivatePull

constructAudioBaseSinkCanActivatePull :: IsAudioBaseSink o => Bool -> IO (GValueConstruct o)

getAudioBaseSinkCanActivatePull :: (MonadIO m, IsAudioBaseSink o) => o -> m Bool

setAudioBaseSinkCanActivatePull :: (MonadIO m, IsAudioBaseSink o) => o -> Bool -> m ()

discontWait

constructAudioBaseSinkDiscontWait :: IsAudioBaseSink o => Word64 -> IO (GValueConstruct o)

getAudioBaseSinkDiscontWait :: (MonadIO m, IsAudioBaseSink o) => o -> m Word64

setAudioBaseSinkDiscontWait :: (MonadIO m, IsAudioBaseSink o) => o -> Word64 -> m ()

driftTolerance

constructAudioBaseSinkDriftTolerance :: IsAudioBaseSink o => Int64 -> IO (GValueConstruct o)

getAudioBaseSinkDriftTolerance :: (MonadIO m, IsAudioBaseSink o) => o -> m Int64

setAudioBaseSinkDriftTolerance :: (MonadIO m, IsAudioBaseSink o) => o -> Int64 -> m ()

latencyTime

constructAudioBaseSinkLatencyTime :: IsAudioBaseSink o => Int64 -> IO (GValueConstruct o)

getAudioBaseSinkLatencyTime :: (MonadIO m, IsAudioBaseSink o) => o -> m Int64

setAudioBaseSinkLatencyTime :: (MonadIO m, IsAudioBaseSink o) => o -> Int64 -> m ()

provideClock

constructAudioBaseSinkProvideClock :: IsAudioBaseSink o => Bool -> IO (GValueConstruct o)

getAudioBaseSinkProvideClock :: (MonadIO m, IsAudioBaseSink o) => o -> m Bool

setAudioBaseSinkProvideClock :: (MonadIO m, IsAudioBaseSink o) => o -> Bool -> m ()

slaveMethod

constructAudioBaseSinkSlaveMethod :: IsAudioBaseSink o => AudioBaseSinkSlaveMethod -> IO (GValueConstruct o)

getAudioBaseSinkSlaveMethod :: (MonadIO m, IsAudioBaseSink o) => o -> m AudioBaseSinkSlaveMethod

setAudioBaseSinkSlaveMethod :: (MonadIO m, IsAudioBaseSink o) => o -> AudioBaseSinkSlaveMethod -> m ()