| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.GstAudio.Objects.AudioBaseSrc
Contents
Description
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.
- newtype AudioBaseSrc = AudioBaseSrc (ManagedPtr AudioBaseSrc)
- class GObject o => IsAudioBaseSrc o
- toAudioBaseSrc :: (MonadIO m, IsAudioBaseSrc o) => o -> m AudioBaseSrc
- noAudioBaseSrc :: Maybe AudioBaseSrc
- audioBaseSrcCreateRingbuffer :: (HasCallStack, MonadIO m, IsAudioBaseSrc a) => a -> m AudioRingBuffer
- audioBaseSrcGetProvideClock :: (HasCallStack, MonadIO m, IsAudioBaseSrc a) => a -> m Bool
- audioBaseSrcGetSlaveMethod :: (HasCallStack, MonadIO m, IsAudioBaseSrc a) => a -> m AudioBaseSrcSlaveMethod
- audioBaseSrcSetProvideClock :: (HasCallStack, MonadIO m, IsAudioBaseSrc a) => a -> Bool -> m ()
- audioBaseSrcSetSlaveMethod :: (HasCallStack, MonadIO m, IsAudioBaseSrc a) => a -> AudioBaseSrcSlaveMethod -> m ()
- getAudioBaseSrcActualBufferTime :: (MonadIO m, IsAudioBaseSrc o) => o -> m Int64
- getAudioBaseSrcActualLatencyTime :: (MonadIO m, IsAudioBaseSrc o) => o -> m Int64
- constructAudioBaseSrcBufferTime :: IsAudioBaseSrc o => Int64 -> IO (GValueConstruct o)
- getAudioBaseSrcBufferTime :: (MonadIO m, IsAudioBaseSrc o) => o -> m Int64
- setAudioBaseSrcBufferTime :: (MonadIO m, IsAudioBaseSrc o) => o -> Int64 -> m ()
- constructAudioBaseSrcLatencyTime :: IsAudioBaseSrc o => Int64 -> IO (GValueConstruct o)
- getAudioBaseSrcLatencyTime :: (MonadIO m, IsAudioBaseSrc o) => o -> m Int64
- setAudioBaseSrcLatencyTime :: (MonadIO m, IsAudioBaseSrc o) => o -> Int64 -> m ()
- constructAudioBaseSrcProvideClock :: IsAudioBaseSrc o => Bool -> IO (GValueConstruct o)
- getAudioBaseSrcProvideClock :: (MonadIO m, IsAudioBaseSrc o) => o -> m Bool
- setAudioBaseSrcProvideClock :: (MonadIO m, IsAudioBaseSrc o) => o -> Bool -> m ()
- constructAudioBaseSrcSlaveMethod :: IsAudioBaseSrc o => AudioBaseSrcSlaveMethod -> IO (GValueConstruct o)
- getAudioBaseSrcSlaveMethod :: (MonadIO m, IsAudioBaseSrc o) => o -> m AudioBaseSrcSlaveMethod
- setAudioBaseSrcSlaveMethod :: (MonadIO m, IsAudioBaseSrc o) => o -> AudioBaseSrcSlaveMethod -> m ()
Exported types
newtype AudioBaseSrc Source #
Constructors
| AudioBaseSrc (ManagedPtr AudioBaseSrc) |
class GObject o => IsAudioBaseSrc o Source #
Instances
toAudioBaseSrc :: (MonadIO m, IsAudioBaseSrc o) => o -> m AudioBaseSrc Source #
Methods
createRingbuffer
audioBaseSrcCreateRingbuffer Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAudioBaseSrc a) | |
| => a |
|
| -> m AudioRingBuffer | Returns: The new ringbuffer of |
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 Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAudioBaseSrc a) | |
| => a |
|
| -> m Bool | Returns: |
Queries whether src will provide a clock or not. See also
gst_audio_base_src_set_provide_clock.
getSlaveMethod
audioBaseSrcGetSlaveMethod Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAudioBaseSrc a) | |
| => a |
|
| -> m AudioBaseSrcSlaveMethod | Returns: The current slave method used by |
Get the current slave method used by src.
setProvideClock
audioBaseSrcSetProvideClock Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAudioBaseSrc a) | |
| => a |
|
| -> Bool |
|
| -> 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 Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAudioBaseSrc a) | |
| => a |
|
| -> AudioBaseSrcSlaveMethod |
|
| -> m () |
Controls how clock slaving will be performed in src.
Properties
actualBufferTime
getAudioBaseSrcActualBufferTime :: (MonadIO m, IsAudioBaseSrc o) => o -> m Int64 Source #
actualLatencyTime
getAudioBaseSrcActualLatencyTime :: (MonadIO m, IsAudioBaseSrc o) => o -> m Int64 Source #
bufferTime
constructAudioBaseSrcBufferTime :: IsAudioBaseSrc o => Int64 -> IO (GValueConstruct o) Source #
getAudioBaseSrcBufferTime :: (MonadIO m, IsAudioBaseSrc o) => o -> m Int64 Source #
setAudioBaseSrcBufferTime :: (MonadIO m, IsAudioBaseSrc o) => o -> Int64 -> m () Source #
latencyTime
constructAudioBaseSrcLatencyTime :: IsAudioBaseSrc o => Int64 -> IO (GValueConstruct o) Source #
getAudioBaseSrcLatencyTime :: (MonadIO m, IsAudioBaseSrc o) => o -> m Int64 Source #
setAudioBaseSrcLatencyTime :: (MonadIO m, IsAudioBaseSrc o) => o -> Int64 -> m () Source #
provideClock
constructAudioBaseSrcProvideClock :: IsAudioBaseSrc o => Bool -> IO (GValueConstruct o) Source #
getAudioBaseSrcProvideClock :: (MonadIO m, IsAudioBaseSrc o) => o -> m Bool Source #
setAudioBaseSrcProvideClock :: (MonadIO m, IsAudioBaseSrc o) => o -> Bool -> m () Source #
slaveMethod
constructAudioBaseSrcSlaveMethod :: IsAudioBaseSrc o => AudioBaseSrcSlaveMethod -> IO (GValueConstruct o) Source #
getAudioBaseSrcSlaveMethod :: (MonadIO m, IsAudioBaseSrc o) => o -> m AudioBaseSrcSlaveMethod Source #
setAudioBaseSrcSlaveMethod :: (MonadIO m, IsAudioBaseSrc o) => o -> AudioBaseSrcSlaveMethod -> m () Source #