GI.GstAudio.Objects.AudioBaseSrc

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

Exported types

newtype AudioBaseSrc

Memory-managed wrapper type.

Constructors

AudioBaseSrc (ManagedPtr AudioBaseSrc)

Instances

GObject AudioBaseSrc

Defined in GI.GstAudio.Objects.AudioBaseSrc

Methods

gobjectType :: AudioBaseSrc -> IO GType

IsObject AudioBaseSrc

Defined in GI.GstAudio.Objects.AudioBaseSrc

IsObject AudioBaseSrc

Defined in GI.GstAudio.Objects.AudioBaseSrc

IsElement AudioBaseSrc

Defined in GI.GstAudio.Objects.AudioBaseSrc

IsPushSrc AudioBaseSrc

Defined in GI.GstAudio.Objects.AudioBaseSrc

IsBaseSrc AudioBaseSrc

Defined in GI.GstAudio.Objects.AudioBaseSrc

IsAudioBaseSrc AudioBaseSrc

Defined in GI.GstAudio.Objects.AudioBaseSrc

class GObject o => IsAudioBaseSrc o

Type class for types which can be safely cast to AudioBaseSrc, for instance with toAudioBaseSrc.

Instances

(GObject a, (UnknownAncestorError AudioBaseSrc a :: Constraint)) => IsAudioBaseSrc a

Defined in GI.GstAudio.Objects.AudioBaseSrc

IsAudioBaseSrc AudioBaseSrc

Defined in GI.GstAudio.Objects.AudioBaseSrc

IsAudioBaseSrc AudioSrc

Defined in GI.GstAudio.Objects.AudioSrc

toAudioBaseSrc :: (MonadIO m, IsAudioBaseSrc o) => o -> m AudioBaseSrc

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

noAudioBaseSrc :: Maybe AudioBaseSrc

A convenience alias for Nothing :: Maybe AudioBaseSrc.

Methods

createRingbuffer

audioBaseSrcCreateRingbuffer

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSrc a)

=> a

src: a AudioBaseSrc.

-> m AudioRingBuffer

Returns: The new ringbuffer of src.

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

getProvideClock

audioBaseSrcGetProvideClock

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSrc a)

=> a

src: a AudioBaseSrc

-> m Bool

Returns: True if src will provide a clock.

Queries whether src will provide a clock or not. See also gst_audio_base_src_set_provide_clock.

getSlaveMethod

audioBaseSrcGetSlaveMethod

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSrc a)

=> a

src: a AudioBaseSrc

-> m AudioBaseSrcSlaveMethod

Returns: The current slave method used by src.

Get the current slave method used by src.

setProvideClock

audioBaseSrcSetProvideClock

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSrc a)

=> a

src: a AudioBaseSrc

-> Bool

provide: new state

-> m ()

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

setSlaveMethod

audioBaseSrcSetSlaveMethod

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSrc a)

=> a

src: a AudioBaseSrc

-> AudioBaseSrcSlaveMethod

method: the new slave method

-> m ()

Controls how clock slaving will be performed in src.

Properties

actualBufferTime

Actual configured size of audio buffer in microseconds.

getAudioBaseSrcActualBufferTime :: (MonadIO m, IsAudioBaseSrc o) => o -> m Int64

Get the value of the “actual-buffer-time” property. When overloading is enabled, this is equivalent to

get audioBaseSrc #actualBufferTime

actualLatencyTime

Actual configured audio latency in microseconds.

getAudioBaseSrcActualLatencyTime :: (MonadIO m, IsAudioBaseSrc o) => o -> m Int64

Get the value of the “actual-latency-time” property. When overloading is enabled, this is equivalent to

get audioBaseSrc #actualLatencyTime

bufferTime

No description available in the introspection data.

constructAudioBaseSrcBufferTime :: IsAudioBaseSrc o => Int64 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “buffer-time” property. This is rarely needed directly, but it is used by new.

getAudioBaseSrcBufferTime :: (MonadIO m, IsAudioBaseSrc o) => o -> m Int64

Get the value of the “buffer-time” property. When overloading is enabled, this is equivalent to

get audioBaseSrc #bufferTime

setAudioBaseSrcBufferTime :: (MonadIO m, IsAudioBaseSrc o) => o -> Int64 -> m ()

Set the value of the “buffer-time” property. When overloading is enabled, this is equivalent to

set audioBaseSrc [ #bufferTime := value ]

latencyTime

No description available in the introspection data.

constructAudioBaseSrcLatencyTime :: IsAudioBaseSrc o => Int64 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “latency-time” property. This is rarely needed directly, but it is used by new.

getAudioBaseSrcLatencyTime :: (MonadIO m, IsAudioBaseSrc o) => o -> m Int64

Get the value of the “latency-time” property. When overloading is enabled, this is equivalent to

get audioBaseSrc #latencyTime

setAudioBaseSrcLatencyTime :: (MonadIO m, IsAudioBaseSrc o) => o -> Int64 -> m ()

Set the value of the “latency-time” property. When overloading is enabled, this is equivalent to

set audioBaseSrc [ #latencyTime := value ]

provideClock

No description available in the introspection data.

constructAudioBaseSrcProvideClock :: IsAudioBaseSrc o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “provide-clock” property. This is rarely needed directly, but it is used by new.

getAudioBaseSrcProvideClock :: (MonadIO m, IsAudioBaseSrc o) => o -> m Bool

Get the value of the “provide-clock” property. When overloading is enabled, this is equivalent to

get audioBaseSrc #provideClock

setAudioBaseSrcProvideClock :: (MonadIO m, IsAudioBaseSrc o) => o -> Bool -> m ()

Set the value of the “provide-clock” property. When overloading is enabled, this is equivalent to

set audioBaseSrc [ #provideClock := value ]

slaveMethod

No description available in the introspection data.

constructAudioBaseSrcSlaveMethod :: IsAudioBaseSrc o => AudioBaseSrcSlaveMethod -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “slave-method” property. This is rarely needed directly, but it is used by new.

getAudioBaseSrcSlaveMethod :: (MonadIO m, IsAudioBaseSrc o) => o -> m AudioBaseSrcSlaveMethod

Get the value of the “slave-method” property. When overloading is enabled, this is equivalent to

get audioBaseSrc #slaveMethod

setAudioBaseSrcSlaveMethod :: (MonadIO m, IsAudioBaseSrc o) => o -> AudioBaseSrcSlaveMethod -> m ()

Set the value of the “slave-method” property. When overloading is enabled, this is equivalent to

set audioBaseSrc [ #slaveMethod := value ]