GI.GstAudio.Structs.AudioFormatInfo

Information for an audio format.

Exported types

newtype AudioFormatInfo

Memory-managed wrapper type.

Constructors

AudioFormatInfo (ManagedPtr AudioFormatInfo)

Instances

Eq AudioFormatInfo

Defined in GI.GstAudio.Structs.AudioFormatInfo

Methods

(==) :: AudioFormatInfo -> AudioFormatInfo -> Bool

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

BoxedPtr AudioFormatInfo

Defined in GI.GstAudio.Structs.AudioFormatInfo

Methods

boxedPtrCopy :: AudioFormatInfo -> IO AudioFormatInfo

boxedPtrFree :: AudioFormatInfo -> IO ()

CallocPtr AudioFormatInfo

Defined in GI.GstAudio.Structs.AudioFormatInfo

Methods

boxedPtrCalloc :: IO (Ptr AudioFormatInfo)

ManagedPtrNewtype AudioFormatInfo

Defined in GI.GstAudio.Structs.AudioFormatInfo

Methods

toManagedPtr :: AudioFormatInfo -> ManagedPtr AudioFormatInfo

tag ~ 'AttrSet => Constructible AudioFormatInfo tag

Defined in GI.GstAudio.Structs.AudioFormatInfo

Methods

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

newZeroAudioFormatInfo :: MonadIO m => m AudioFormatInfo

Construct a AudioFormatInfo struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

fillSilence.

Getters

None.

Setters

None.

fillSilence

audioFormatInfoFillSilence

Arguments

:: (HasCallStack, MonadIO m)

=> AudioFormatInfo

info: a AudioFormatInfo

-> ByteString

dest: a destination to fill

-> m ()

Fill length bytes in dest with silence samples for info.

Since: 1.20

Properties

depth

amount of valid bits in width

getAudioFormatInfoDepth :: MonadIO m => AudioFormatInfo -> m Int32

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

get audioFormatInfo #depth

setAudioFormatInfoDepth :: MonadIO m => AudioFormatInfo -> Int32 -> m ()

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

set audioFormatInfo [ #depth := value ]

description

user readable description of the format

clearAudioFormatInfoDescription :: MonadIO m => AudioFormatInfo -> m ()

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

clear #description

getAudioFormatInfoDescription :: MonadIO m => AudioFormatInfo -> m (Maybe Text)

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

get audioFormatInfo #description

setAudioFormatInfoDescription :: MonadIO m => AudioFormatInfo -> CString -> m ()

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

set audioFormatInfo [ #description := value ]

endianness

the endianness

getAudioFormatInfoEndianness :: MonadIO m => AudioFormatInfo -> m Int32

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

get audioFormatInfo #endianness

setAudioFormatInfoEndianness :: MonadIO m => AudioFormatInfo -> Int32 -> m ()

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

set audioFormatInfo [ #endianness := value ]

flags

AudioFormatFlags

getAudioFormatInfoFlags :: MonadIO m => AudioFormatInfo -> m [AudioFormatFlags]

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

get audioFormatInfo #flags

setAudioFormatInfoFlags :: MonadIO m => AudioFormatInfo -> [AudioFormatFlags] -> m ()

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

set audioFormatInfo [ #flags := value ]

format

AudioFormat

getAudioFormatInfoFormat :: MonadIO m => AudioFormatInfo -> m AudioFormat

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

get audioFormatInfo #format

setAudioFormatInfoFormat :: MonadIO m => AudioFormatInfo -> AudioFormat -> m ()

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

set audioFormatInfo [ #format := value ]

name

string representation of the format

clearAudioFormatInfoName :: MonadIO m => AudioFormatInfo -> m ()

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

clear #name

getAudioFormatInfoName :: MonadIO m => AudioFormatInfo -> m (Maybe Text)

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

get audioFormatInfo #name

setAudioFormatInfoName :: MonadIO m => AudioFormatInfo -> CString -> m ()

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

set audioFormatInfo [ #name := value ]

packFunc

function to pack samples

clearAudioFormatInfoPackFunc :: MonadIO m => AudioFormatInfo -> m ()

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

clear #packFunc

getAudioFormatInfoPackFunc :: MonadIO m => AudioFormatInfo -> m (Maybe AudioFormatPack)

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

get audioFormatInfo #packFunc

setAudioFormatInfoPackFunc :: MonadIO m => AudioFormatInfo -> FunPtr C_AudioFormatPack -> m ()

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

set audioFormatInfo [ #packFunc := value ]

unpackFormat

the format of the unpacked samples

getAudioFormatInfoUnpackFormat :: MonadIO m => AudioFormatInfo -> m AudioFormat

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

get audioFormatInfo #unpackFormat

setAudioFormatInfoUnpackFormat :: MonadIO m => AudioFormatInfo -> AudioFormat -> m ()

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

set audioFormatInfo [ #unpackFormat := value ]

unpackFunc

function to unpack samples

clearAudioFormatInfoUnpackFunc :: MonadIO m => AudioFormatInfo -> m ()

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

clear #unpackFunc

getAudioFormatInfoUnpackFunc :: MonadIO m => AudioFormatInfo -> m (Maybe AudioFormatUnpack)

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

get audioFormatInfo #unpackFunc

setAudioFormatInfoUnpackFunc :: MonadIO m => AudioFormatInfo -> FunPtr C_AudioFormatUnpack -> m ()

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

set audioFormatInfo [ #unpackFunc := value ]

width

amount of bits used for one sample

getAudioFormatInfoWidth :: MonadIO m => AudioFormatInfo -> m Int32

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

get audioFormatInfo #width

setAudioFormatInfoWidth :: MonadIO m => AudioFormatInfo -> Int32 -> m ()

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

set audioFormatInfo [ #width := value ]