gi-gstaudio-1.0.12: GStreamerAudio bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

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.

Synopsis

Exported types

Methods

createRingbuffer

audioBaseSrcCreateRingbuffer Source #

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 Source #

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 Source #

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 Source #

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 Source #

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

data AudioBaseSrcActualBufferTimePropertyInfo Source #

Instances

AttrInfo AudioBaseSrcActualBufferTimePropertyInfo Source # 
type AttrOrigin AudioBaseSrcActualBufferTimePropertyInfo Source # 
type AttrLabel AudioBaseSrcActualBufferTimePropertyInfo Source # 
type AttrGetType AudioBaseSrcActualBufferTimePropertyInfo Source # 
type AttrBaseTypeConstraint AudioBaseSrcActualBufferTimePropertyInfo Source # 
type AttrSetTypeConstraint AudioBaseSrcActualBufferTimePropertyInfo Source # 
type AttrAllowedOps AudioBaseSrcActualBufferTimePropertyInfo Source # 

actualLatencyTime

data AudioBaseSrcActualLatencyTimePropertyInfo Source #

Instances

AttrInfo AudioBaseSrcActualLatencyTimePropertyInfo Source # 
type AttrOrigin AudioBaseSrcActualLatencyTimePropertyInfo Source # 
type AttrLabel AudioBaseSrcActualLatencyTimePropertyInfo Source # 
type AttrGetType AudioBaseSrcActualLatencyTimePropertyInfo Source # 
type AttrBaseTypeConstraint AudioBaseSrcActualLatencyTimePropertyInfo Source # 
type AttrSetTypeConstraint AudioBaseSrcActualLatencyTimePropertyInfo Source # 
type AttrAllowedOps AudioBaseSrcActualLatencyTimePropertyInfo Source # 

bufferTime

data AudioBaseSrcBufferTimePropertyInfo Source #

Instances

AttrInfo AudioBaseSrcBufferTimePropertyInfo Source # 
type AttrOrigin AudioBaseSrcBufferTimePropertyInfo Source # 
type AttrLabel AudioBaseSrcBufferTimePropertyInfo Source # 
type AttrGetType AudioBaseSrcBufferTimePropertyInfo Source # 
type AttrBaseTypeConstraint AudioBaseSrcBufferTimePropertyInfo Source # 
type AttrSetTypeConstraint AudioBaseSrcBufferTimePropertyInfo Source # 
type AttrAllowedOps AudioBaseSrcBufferTimePropertyInfo Source # 

latencyTime

data AudioBaseSrcLatencyTimePropertyInfo Source #

Instances

AttrInfo AudioBaseSrcLatencyTimePropertyInfo Source # 
type AttrOrigin AudioBaseSrcLatencyTimePropertyInfo Source # 
type AttrLabel AudioBaseSrcLatencyTimePropertyInfo Source # 
type AttrGetType AudioBaseSrcLatencyTimePropertyInfo Source # 
type AttrBaseTypeConstraint AudioBaseSrcLatencyTimePropertyInfo Source # 
type AttrSetTypeConstraint AudioBaseSrcLatencyTimePropertyInfo Source # 
type AttrAllowedOps AudioBaseSrcLatencyTimePropertyInfo Source # 

provideClock

data AudioBaseSrcProvideClockPropertyInfo Source #

Instances

AttrInfo AudioBaseSrcProvideClockPropertyInfo Source # 
type AttrOrigin AudioBaseSrcProvideClockPropertyInfo Source # 
type AttrLabel AudioBaseSrcProvideClockPropertyInfo Source # 
type AttrGetType AudioBaseSrcProvideClockPropertyInfo Source # 
type AttrBaseTypeConstraint AudioBaseSrcProvideClockPropertyInfo Source # 
type AttrSetTypeConstraint AudioBaseSrcProvideClockPropertyInfo Source # 
type AttrAllowedOps AudioBaseSrcProvideClockPropertyInfo Source # 

slaveMethod

data AudioBaseSrcSlaveMethodPropertyInfo Source #

Instances

AttrInfo AudioBaseSrcSlaveMethodPropertyInfo Source # 
type AttrOrigin AudioBaseSrcSlaveMethodPropertyInfo Source # 
type AttrLabel AudioBaseSrcSlaveMethodPropertyInfo Source # 
type AttrGetType AudioBaseSrcSlaveMethodPropertyInfo Source # 
type AttrBaseTypeConstraint AudioBaseSrcSlaveMethodPropertyInfo Source # 
type AttrSetTypeConstraint AudioBaseSrcSlaveMethodPropertyInfo Source # 
type AttrAllowedOps AudioBaseSrcSlaveMethodPropertyInfo Source #