GI.GstAudio.Structs.AudioInfo

Information describing audio properties. This information can be filled in from GstCaps with audioInfoFromCaps.

Use the provided macros to access the info in this structure.

Exported types

newtype AudioInfo

Constructors

AudioInfo (ManagedPtr AudioInfo)

Instances

BoxedObject AudioInfo

Methods

boxedType :: AudioInfo -> IO GType

(~) AttrOpTag tag AttrSet => Constructible AudioInfo tag

Methods

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

newZeroAudioInfo :: MonadIO m => m AudioInfo

Construct a AudioInfo struct initialized to zero.

noAudioInfo :: Maybe AudioInfo

Methods

convert

audioInfoConvert

Arguments

:: (HasCallStack, MonadIO m)

=> AudioInfo

info: a AudioInfo

-> Format

srcFmt: Format of the srcVal

-> Int64

srcVal: value to convert

-> Format

destFmt: Format of the destVal

-> Int64

destVal: pointer to destination value

-> m Bool

Returns: TRUE if the conversion was successful.

Converts among various Format types. This function handles GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For raw audio, GST_FORMAT_DEFAULT corresponds to audio frames. This function can be used to handle pad queries of the type GST_QUERY_CONVERT.

copy

audioInfoCopy

Arguments

:: (HasCallStack, MonadIO m)

=> AudioInfo

info: a AudioInfo

-> m AudioInfo

Returns: a new AudioInfo. free with gst_audio_info_free.

Copy a GstAudioInfo structure.

free

audioInfoFree

Arguments

:: (HasCallStack, MonadIO m)

=> AudioInfo

info: a AudioInfo

-> m ()

Free a GstAudioInfo structure previously allocated with audioInfoNew or audioInfoCopy.

fromCaps

audioInfoFromCaps

Arguments

:: (HasCallStack, MonadIO m)

=> AudioInfo

info: a AudioInfo

-> Caps

caps: a Caps

-> m Bool

Returns: TRUE if caps could be parsed

Parse caps and update info.

init

audioInfoInit

Arguments

:: (HasCallStack, MonadIO m)

=> AudioInfo

info: a AudioInfo

-> m ()

Initialize info with default values.

isEqual

audioInfoIsEqual

Arguments

:: (HasCallStack, MonadIO m)

=> AudioInfo

info: a AudioInfo

-> AudioInfo

other: a AudioInfo

-> m Bool

Returns: True if info and other are equal, else False.

Compares two AudioInfo and returns whether they are equal or not

Since: 1.2

new

audioInfoNew

Arguments

:: (HasCallStack, MonadIO m)

=> m AudioInfo

Returns: a new AudioInfo. free with audioInfoFree.

Allocate a new AudioInfo that is also initialized with audioInfoInit.

setFormat

audioInfoSetFormat

Arguments

:: (HasCallStack, MonadIO m)

=> AudioInfo

info: a AudioInfo

-> AudioFormat

format: the format

-> Int32

rate: the samplerate

-> Int32

channels: the number of channels

-> AudioChannelPosition

position: the channel positions

-> m ()

Set the default info for the audio info of format and rate and channels.

Note: This initializes info first, no values are preserved.

toCaps

audioInfoToCaps

Arguments

:: (HasCallStack, MonadIO m)

=> AudioInfo

info: a AudioInfo

-> m Caps

Returns: the new Caps containing the info of info.

Convert the values of info into a Caps.

Properties

bpf

getAudioInfoBpf :: MonadIO m => AudioInfo -> m Int32

setAudioInfoBpf :: MonadIO m => AudioInfo -> Int32 -> m ()

channels

getAudioInfoChannels :: MonadIO m => AudioInfo -> m Int32

setAudioInfoChannels :: MonadIO m => AudioInfo -> Int32 -> m ()

finfo

clearAudioInfoFinfo :: MonadIO m => AudioInfo -> m ()

getAudioInfoFinfo :: MonadIO m => AudioInfo -> m (Maybe AudioFormatInfo)

setAudioInfoFinfo :: MonadIO m => AudioInfo -> Ptr AudioFormatInfo -> m ()

flags

getAudioInfoFlags :: MonadIO m => AudioInfo -> m [AudioFlags]

setAudioInfoFlags :: MonadIO m => AudioInfo -> [AudioFlags] -> m ()

layout

getAudioInfoLayout :: MonadIO m => AudioInfo -> m AudioLayout

setAudioInfoLayout :: MonadIO m => AudioInfo -> AudioLayout -> m ()

rate

getAudioInfoRate :: MonadIO m => AudioInfo -> m Int32

setAudioInfoRate :: MonadIO m => AudioInfo -> Int32 -> m ()