GI.GstAudio.Structs.AudioRingBufferSpec

The structure containing the format specification of the ringbuffer.

When type is GST_AUDIO_RING_BUFFER_FORMAT_TYPE_DSD, the dsdFormat is valid (otherwise it is unused). Also, when DSD is the sample type, only the rate, channels, position, and bpf fields in info are populated.

Exported types

newtype AudioRingBufferSpec

Memory-managed wrapper type.

Constructors

AudioRingBufferSpec (ManagedPtr AudioRingBufferSpec)

Instances

Eq AudioRingBufferSpec

Defined in GI.GstAudio.Structs.AudioRingBufferSpec

Methods

(==) :: AudioRingBufferSpec -> AudioRingBufferSpec -> Bool

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

BoxedPtr AudioRingBufferSpec

Defined in GI.GstAudio.Structs.AudioRingBufferSpec

Methods

boxedPtrCopy :: AudioRingBufferSpec -> IO AudioRingBufferSpec

boxedPtrFree :: AudioRingBufferSpec -> IO ()

CallocPtr AudioRingBufferSpec

Defined in GI.GstAudio.Structs.AudioRingBufferSpec

Methods

boxedPtrCalloc :: IO (Ptr AudioRingBufferSpec)

ManagedPtrNewtype AudioRingBufferSpec

Defined in GI.GstAudio.Structs.AudioRingBufferSpec

Methods

toManagedPtr :: AudioRingBufferSpec -> ManagedPtr AudioRingBufferSpec

tag ~ 'AttrSet => Constructible AudioRingBufferSpec tag

Defined in GI.GstAudio.Structs.AudioRingBufferSpec

Methods

new :: MonadIO m => (ManagedPtr AudioRingBufferSpec -> AudioRingBufferSpec) -> [AttrOp AudioRingBufferSpec tag] -> m AudioRingBufferSpec

newZeroAudioRingBufferSpec :: MonadIO m => m AudioRingBufferSpec

Construct a AudioRingBufferSpec struct initialized to zero.

Methods

Properties

bufferTime

the total buffer size in microseconds

getAudioRingBufferSpecBufferTime :: MonadIO m => AudioRingBufferSpec -> m Word64

Get the value of the “buffer_time” field. When overloading is enabled, this is equivalent to

get audioRingBufferSpec #bufferTime

setAudioRingBufferSpecBufferTime :: MonadIO m => AudioRingBufferSpec -> Word64 -> m ()

Set the value of the “buffer_time” field. When overloading is enabled, this is equivalent to

set audioRingBufferSpec [ #bufferTime := value ]

caps

The caps that generated the Spec.

clearAudioRingBufferSpecCaps :: MonadIO m => AudioRingBufferSpec -> m ()

Set the value of the “caps” field to Nothing. When overloading is enabled, this is equivalent to

clear #caps

getAudioRingBufferSpecCaps :: MonadIO m => AudioRingBufferSpec -> m (Maybe Caps)

Get the value of the “caps” field. When overloading is enabled, this is equivalent to

get audioRingBufferSpec #caps

setAudioRingBufferSpecCaps :: MonadIO m => AudioRingBufferSpec -> Ptr Caps -> m ()

Set the value of the “caps” field. When overloading is enabled, this is equivalent to

set audioRingBufferSpec [ #caps := value ]

info

the AudioInfo

getAudioRingBufferSpecInfo :: MonadIO m => AudioRingBufferSpec -> m AudioInfo

Get the value of the “info” field. When overloading is enabled, this is equivalent to

get audioRingBufferSpec #info

latencyTime

the latency in microseconds

getAudioRingBufferSpecLatencyTime :: MonadIO m => AudioRingBufferSpec -> m Word64

Get the value of the “latency_time” field. When overloading is enabled, this is equivalent to

get audioRingBufferSpec #latencyTime

setAudioRingBufferSpecLatencyTime :: MonadIO m => AudioRingBufferSpec -> Word64 -> m ()

Set the value of the “latency_time” field. When overloading is enabled, this is equivalent to

set audioRingBufferSpec [ #latencyTime := value ]

seglatency

number of segments queued in the lower level device, defaults to segtotal

getAudioRingBufferSpecSeglatency :: MonadIO m => AudioRingBufferSpec -> m Int32

Get the value of the “seglatency” field. When overloading is enabled, this is equivalent to

get audioRingBufferSpec #seglatency

setAudioRingBufferSpecSeglatency :: MonadIO m => AudioRingBufferSpec -> Int32 -> m ()

Set the value of the “seglatency” field. When overloading is enabled, this is equivalent to

set audioRingBufferSpec [ #seglatency := value ]

segsize

the size of one segment in bytes

getAudioRingBufferSpecSegsize :: MonadIO m => AudioRingBufferSpec -> m Int32

Get the value of the “segsize” field. When overloading is enabled, this is equivalent to

get audioRingBufferSpec #segsize

setAudioRingBufferSpecSegsize :: MonadIO m => AudioRingBufferSpec -> Int32 -> m ()

Set the value of the “segsize” field. When overloading is enabled, this is equivalent to

set audioRingBufferSpec [ #segsize := value ]

segtotal

the total number of segments

getAudioRingBufferSpecSegtotal :: MonadIO m => AudioRingBufferSpec -> m Int32

Get the value of the “segtotal” field. When overloading is enabled, this is equivalent to

get audioRingBufferSpec #segtotal

setAudioRingBufferSpecSegtotal :: MonadIO m => AudioRingBufferSpec -> Int32 -> m ()

Set the value of the “segtotal” field. When overloading is enabled, this is equivalent to

set audioRingBufferSpec [ #segtotal := value ]

type

the sample type

getAudioRingBufferSpecType :: MonadIO m => AudioRingBufferSpec -> m AudioRingBufferFormatType

Get the value of the “type” field. When overloading is enabled, this is equivalent to

get audioRingBufferSpec #type

setAudioRingBufferSpecType :: MonadIO m => AudioRingBufferSpec -> AudioRingBufferFormatType -> m ()

Set the value of the “type” field. When overloading is enabled, this is equivalent to

set audioRingBufferSpec [ #type := value ]