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 |
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.
- newtype AudioInfo = AudioInfo (ManagedPtr AudioInfo)
- newZeroAudioInfo :: MonadIO m => m AudioInfo
- noAudioInfo :: Maybe AudioInfo
- data AudioInfoConvertMethodInfo
- audioInfoConvert :: (HasCallStack, MonadIO m) => AudioInfo -> Format -> Int64 -> Format -> Int64 -> m Bool
- data AudioInfoCopyMethodInfo
- audioInfoCopy :: (HasCallStack, MonadIO m) => AudioInfo -> m AudioInfo
- data AudioInfoFreeMethodInfo
- audioInfoFree :: (HasCallStack, MonadIO m) => AudioInfo -> m ()
- data AudioInfoFromCapsMethodInfo
- audioInfoFromCaps :: (HasCallStack, MonadIO m) => AudioInfo -> Caps -> m Bool
- data AudioInfoInitMethodInfo
- audioInfoInit :: (HasCallStack, MonadIO m) => AudioInfo -> m ()
- data AudioInfoIsEqualMethodInfo
- audioInfoIsEqual :: (HasCallStack, MonadIO m) => AudioInfo -> AudioInfo -> m Bool
- audioInfoNew :: (HasCallStack, MonadIO m) => m AudioInfo
- data AudioInfoSetFormatMethodInfo
- audioInfoSetFormat :: (HasCallStack, MonadIO m) => AudioInfo -> AudioFormat -> Int32 -> Int32 -> AudioChannelPosition -> m ()
- data AudioInfoToCapsMethodInfo
- audioInfoToCaps :: (HasCallStack, MonadIO m) => AudioInfo -> m Caps
- audioInfo_bpf :: AttrLabelProxy "bpf"
- getAudioInfoBpf :: MonadIO m => AudioInfo -> m Int32
- setAudioInfoBpf :: MonadIO m => AudioInfo -> Int32 -> m ()
- audioInfo_channels :: AttrLabelProxy "channels"
- getAudioInfoChannels :: MonadIO m => AudioInfo -> m Int32
- setAudioInfoChannels :: MonadIO m => AudioInfo -> Int32 -> m ()
- audioInfo_finfo :: AttrLabelProxy "finfo"
- clearAudioInfoFinfo :: MonadIO m => AudioInfo -> m ()
- getAudioInfoFinfo :: MonadIO m => AudioInfo -> m (Maybe AudioFormatInfo)
- setAudioInfoFinfo :: MonadIO m => AudioInfo -> Ptr AudioFormatInfo -> m ()
- audioInfo_flags :: AttrLabelProxy "flags"
- getAudioInfoFlags :: MonadIO m => AudioInfo -> m [AudioFlags]
- setAudioInfoFlags :: MonadIO m => AudioInfo -> [AudioFlags] -> m ()
- audioInfo_layout :: AttrLabelProxy "layout"
- getAudioInfoLayout :: MonadIO m => AudioInfo -> m AudioLayout
- setAudioInfoLayout :: MonadIO m => AudioInfo -> AudioLayout -> m ()
- audioInfo_rate :: AttrLabelProxy "rate"
- getAudioInfoRate :: MonadIO m => AudioInfo -> m Int32
- setAudioInfoRate :: MonadIO m => AudioInfo -> Int32 -> m ()
Exported types
newZeroAudioInfo :: MonadIO m => m AudioInfo Source #
Construct a AudioInfo
struct initialized to zero.
Methods
convert
:: (HasCallStack, MonadIO m) | |
=> AudioInfo |
|
-> Format |
|
-> Int64 |
|
-> Format |
|
-> Int64 |
|
-> 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
data AudioInfoCopyMethodInfo Source #
((~) * signature (m AudioInfo), MonadIO m) => MethodInfo * AudioInfoCopyMethodInfo AudioInfo signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> AudioInfo |
|
-> m AudioInfo | Returns: a new |
Copy a GstAudioInfo structure.
free
data AudioInfoFreeMethodInfo Source #
((~) * signature (m ()), MonadIO m) => MethodInfo * AudioInfoFreeMethodInfo AudioInfo signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> AudioInfo |
|
-> m () |
Free a GstAudioInfo structure previously allocated with audioInfoNew
or audioInfoCopy
.
fromCaps
data AudioInfoFromCapsMethodInfo Source #
((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * AudioInfoFromCapsMethodInfo AudioInfo signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> AudioInfo |
|
-> Caps |
|
-> m Bool | Returns: TRUE if |
Parse caps
and update info
.
init
data AudioInfoInitMethodInfo Source #
((~) * signature (m ()), MonadIO m) => MethodInfo * AudioInfoInitMethodInfo AudioInfo signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> AudioInfo |
|
-> m () |
Initialize info
with default values.
isEqual
data AudioInfoIsEqualMethodInfo Source #
((~) * signature (AudioInfo -> m Bool), MonadIO m) => MethodInfo * AudioInfoIsEqualMethodInfo AudioInfo signature Source # | |
Compares two AudioInfo
and returns whether they are equal or not
Since: 1.2
new
:: (HasCallStack, MonadIO m) | |
=> m AudioInfo | Returns: a new |
Allocate a new AudioInfo
that is also initialized with
audioInfoInit
.
setFormat
data AudioInfoSetFormatMethodInfo Source #
((~) * signature (AudioFormat -> Int32 -> Int32 -> AudioChannelPosition -> m ()), MonadIO m) => MethodInfo * AudioInfoSetFormatMethodInfo AudioInfo signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> AudioInfo |
|
-> AudioFormat |
|
-> Int32 |
|
-> Int32 |
|
-> AudioChannelPosition |
|
-> 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
data AudioInfoToCapsMethodInfo Source #
((~) * signature (m Caps), MonadIO m) => MethodInfo * AudioInfoToCapsMethodInfo AudioInfo signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> AudioInfo |
|
-> m Caps | Returns: the new |
Convert the values of info
into a Caps
.
Properties
bpf
audioInfo_bpf :: AttrLabelProxy "bpf" Source #
channels
audioInfo_channels :: AttrLabelProxy "channels" Source #
finfo
audioInfo_finfo :: AttrLabelProxy "finfo" Source #
clearAudioInfoFinfo :: MonadIO m => AudioInfo -> m () Source #
getAudioInfoFinfo :: MonadIO m => AudioInfo -> m (Maybe AudioFormatInfo) Source #
setAudioInfoFinfo :: MonadIO m => AudioInfo -> Ptr AudioFormatInfo -> m () Source #
flags
audioInfo_flags :: AttrLabelProxy "flags" Source #
getAudioInfoFlags :: MonadIO m => AudioInfo -> m [AudioFlags] Source #
setAudioInfoFlags :: MonadIO m => AudioInfo -> [AudioFlags] -> m () Source #
layout
audioInfo_layout :: AttrLabelProxy "layout" Source #
getAudioInfoLayout :: MonadIO m => AudioInfo -> m AudioLayout Source #
setAudioInfoLayout :: MonadIO m => AudioInfo -> AudioLayout -> m () Source #
rate
audioInfo_rate :: AttrLabelProxy "rate" Source #