| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.GstAudio.Enums
Contents
- Enumerations
- AudioBaseSinkDiscontReason
- AudioBaseSinkSlaveMethod
- AudioBaseSrcSlaveMethod
- AudioCdSrcMode
- AudioChannelPosition
- AudioDitherMethod
- AudioFormat
- AudioLayout
- AudioNoiseShapingMethod
- AudioResamplerFilterInterpolation
- AudioResamplerFilterMode
- AudioResamplerMethod
- AudioRingBufferFormatType
- AudioRingBufferState
- StreamVolumeFormat
Description
Synopsis
- data AudioBaseSinkDiscontReason
- data AudioBaseSinkSlaveMethod
- data AudioBaseSrcSlaveMethod
- data AudioCdSrcMode
- data AudioChannelPosition
- = AudioChannelPositionNone
- | AudioChannelPositionMono
- | AudioChannelPositionInvalid
- | AudioChannelPositionFrontLeft
- | AudioChannelPositionFrontRight
- | AudioChannelPositionFrontCenter
- | AudioChannelPositionLfe1
- | AudioChannelPositionRearLeft
- | AudioChannelPositionRearRight
- | AudioChannelPositionFrontLeftOfCenter
- | AudioChannelPositionFrontRightOfCenter
- | AudioChannelPositionRearCenter
- | AudioChannelPositionLfe2
- | AudioChannelPositionSideLeft
- | AudioChannelPositionSideRight
- | AudioChannelPositionTopFrontLeft
- | AudioChannelPositionTopFrontRight
- | AudioChannelPositionTopFrontCenter
- | AudioChannelPositionTopCenter
- | AudioChannelPositionTopRearLeft
- | AudioChannelPositionTopRearRight
- | AudioChannelPositionTopSideLeft
- | AudioChannelPositionTopSideRight
- | AudioChannelPositionTopRearCenter
- | AudioChannelPositionBottomFrontCenter
- | AudioChannelPositionBottomFrontLeft
- | AudioChannelPositionBottomFrontRight
- | AudioChannelPositionWideLeft
- | AudioChannelPositionWideRight
- | AudioChannelPositionSurroundLeft
- | AudioChannelPositionSurroundRight
- | AnotherAudioChannelPosition Int
- data AudioDitherMethod
- data AudioFormat
- = AudioFormatUnknown
- | AudioFormatEncoded
- | AudioFormatS8
- | AudioFormatU8
- | AudioFormatS16le
- | AudioFormatS16be
- | AudioFormatU16le
- | AudioFormatU16be
- | AudioFormatS2432le
- | AudioFormatS2432be
- | AudioFormatU2432le
- | AudioFormatU2432be
- | AudioFormatS32le
- | AudioFormatS32be
- | AudioFormatU32le
- | AudioFormatU32be
- | AudioFormatS24le
- | AudioFormatS24be
- | AudioFormatU24le
- | AudioFormatU24be
- | AudioFormatS20le
- | AudioFormatS20be
- | AudioFormatU20le
- | AudioFormatU20be
- | AudioFormatS18le
- | AudioFormatS18be
- | AudioFormatU18le
- | AudioFormatU18be
- | AudioFormatF32le
- | AudioFormatF32be
- | AudioFormatF64le
- | AudioFormatF64be
- | AudioFormatS16
- | AudioFormatU16
- | AudioFormatS2432
- | AudioFormatU2432
- | AudioFormatS32
- | AudioFormatU32
- | AudioFormatS24
- | AudioFormatU24
- | AudioFormatS20
- | AudioFormatU20
- | AudioFormatS18
- | AudioFormatU18
- | AudioFormatF32
- | AudioFormatF64
- | AnotherAudioFormat Int
- data AudioLayout
- data AudioNoiseShapingMethod
- data AudioResamplerFilterInterpolation
- data AudioResamplerFilterMode
- data AudioResamplerMethod
- data AudioRingBufferFormatType
- = AudioRingBufferFormatTypeRaw
- | AudioRingBufferFormatTypeMuLaw
- | AudioRingBufferFormatTypeALaw
- | AudioRingBufferFormatTypeImaAdpcm
- | AudioRingBufferFormatTypeMpeg
- | AudioRingBufferFormatTypeGsm
- | AudioRingBufferFormatTypeIec958
- | AudioRingBufferFormatTypeAc3
- | AudioRingBufferFormatTypeEac3
- | AudioRingBufferFormatTypeDts
- | AudioRingBufferFormatTypeMpeg2Aac
- | AudioRingBufferFormatTypeMpeg4Aac
- | AudioRingBufferFormatTypeMpeg2AacRaw
- | AudioRingBufferFormatTypeMpeg4AacRaw
- | AudioRingBufferFormatTypeFlac
- | AnotherAudioRingBufferFormatType Int
- data AudioRingBufferState
- data StreamVolumeFormat
Enumerations
AudioBaseSinkDiscontReason
data AudioBaseSinkDiscontReason Source #
Different possible reasons for discontinuities. This enum is useful for the custom slave method.
Since: 1.6
Constructors
| AudioBaseSinkDiscontReasonNoDiscont | No discontinuity occurred |
| AudioBaseSinkDiscontReasonNewCaps | New caps are set, causing renegotiotion |
| AudioBaseSinkDiscontReasonFlush | Samples have been flushed |
| AudioBaseSinkDiscontReasonSyncLatency | Sink was synchronized to the estimated latency (occurs during initialization) |
| AudioBaseSinkDiscontReasonAlignment | Aligning buffers failed because the timestamps are too discontinuous |
| AudioBaseSinkDiscontReasonDeviceFailure | Audio output device experienced and recovered from an error but introduced latency in the process (see also |
| AnotherAudioBaseSinkDiscontReason Int | Catch-all for unknown values |
Instances
AudioBaseSinkSlaveMethod
data AudioBaseSinkSlaveMethod Source #
Different possible clock slaving algorithms used when the internal audio clock is not selected as the pipeline master clock.
Constructors
| AudioBaseSinkSlaveMethodResample | Resample to match the master clock |
| AudioBaseSinkSlaveMethodSkew | Adjust playout pointer when master clock drifts too much. |
| AudioBaseSinkSlaveMethodNone | No adjustment is done. |
| AudioBaseSinkSlaveMethodCustom | Use custom clock slaving algorithm (Since: 1.6) |
| AnotherAudioBaseSinkSlaveMethod Int | Catch-all for unknown values |
Instances
AudioBaseSrcSlaveMethod
data AudioBaseSrcSlaveMethod Source #
Different possible clock slaving algorithms when the internal audio clock was not selected as the pipeline clock.
Constructors
| AudioBaseSrcSlaveMethodResample | Resample to match the master clock. |
| AudioBaseSrcSlaveMethodReTimestamp | Retimestamp output buffers with master clock time. |
| AudioBaseSrcSlaveMethodSkew | Adjust capture pointer when master clock drifts too much. |
| AudioBaseSrcSlaveMethodNone | No adjustment is done. |
| AnotherAudioBaseSrcSlaveMethod Int | Catch-all for unknown values |
Instances
AudioCdSrcMode
data AudioCdSrcMode Source #
Mode in which the CD audio source operates. Influences timestamping, EOS handling and seeking.
Constructors
| AudioCdSrcModeNormal | each single track is a stream |
| AudioCdSrcModeContinuous | the entire disc is a single stream |
| AnotherAudioCdSrcMode Int | Catch-all for unknown values |
Instances
AudioChannelPosition
data AudioChannelPosition Source #
Audio channel positions.
These are the channels defined in SMPTE 2036-2-2008 Table 1 for 22.2 audio systems with the Surround and Wide channels from DTS Coherent Acoustics (v.1.3.1) and 10.2 and 7.1 layouts. In the caps the actual channel layout is expressed with a channel count and a channel mask, which describes the existing channels. The positions in the bit mask correspond to the enum values. For negotiation it is allowed to have more bits set in the channel mask than the number of channels to specify the allowed channel positions but this is not allowed in negotiated caps. It is not allowed in any situation other than the one mentioned below to have less bits set in the channel mask than the number of channels.
gSTAUDIOCHANNELPOSITIONMONO can only be used with a single mono channel that
has no direction information and would be mixed into all directional channels.
This is expressed in caps by having a single channel and no channel mask.
gSTAUDIOCHANNELPOSITIONNONE can only be used if all channels have this position.
This is expressed in caps by having a channel mask with no bits set.
As another special case it is allowed to have two channels without a channel mask. This implicitly means that this is a stereo stream with a front left and front right channel.
Constructors
Instances
AudioDitherMethod
data AudioDitherMethod Source #
Set of available dithering methods.
Constructors
| AudioDitherMethodNone | No dithering |
| AudioDitherMethodRpdf | Rectangular dithering |
| AudioDitherMethodTpdf | Triangular dithering (default) |
| AudioDitherMethodTpdfHf | High frequency triangular dithering |
| AnotherAudioDitherMethod Int | Catch-all for unknown values |
Instances
AudioFormat
data AudioFormat Source #
Enum value describing the most common audio formats.
Constructors
| AudioFormatUnknown | unknown or unset audio format |
| AudioFormatEncoded | encoded audio format |
| AudioFormatS8 | 8 bits in 8 bits, signed |
| AudioFormatU8 | 8 bits in 8 bits, unsigned |
| AudioFormatS16le | 16 bits in 16 bits, signed, little endian |
| AudioFormatS16be | 16 bits in 16 bits, signed, big endian |
| AudioFormatU16le | 16 bits in 16 bits, unsigned, little endian |
| AudioFormatU16be | 16 bits in 16 bits, unsigned, big endian |
| AudioFormatS2432le | 24 bits in 32 bits, signed, little endian |
| AudioFormatS2432be | 24 bits in 32 bits, signed, big endian |
| AudioFormatU2432le | 24 bits in 32 bits, unsigned, little endian |
| AudioFormatU2432be | 24 bits in 32 bits, unsigned, big endian |
| AudioFormatS32le | 32 bits in 32 bits, signed, little endian |
| AudioFormatS32be | 32 bits in 32 bits, signed, big endian |
| AudioFormatU32le | 32 bits in 32 bits, unsigned, little endian |
| AudioFormatU32be | 32 bits in 32 bits, unsigned, big endian |
| AudioFormatS24le | 24 bits in 24 bits, signed, little endian |
| AudioFormatS24be | 24 bits in 24 bits, signed, big endian |
| AudioFormatU24le | 24 bits in 24 bits, unsigned, little endian |
| AudioFormatU24be | 24 bits in 24 bits, unsigned, big endian |
| AudioFormatS20le | 20 bits in 24 bits, signed, little endian |
| AudioFormatS20be | 20 bits in 24 bits, signed, big endian |
| AudioFormatU20le | 20 bits in 24 bits, unsigned, little endian |
| AudioFormatU20be | 20 bits in 24 bits, unsigned, big endian |
| AudioFormatS18le | 18 bits in 24 bits, signed, little endian |
| AudioFormatS18be | 18 bits in 24 bits, signed, big endian |
| AudioFormatU18le | 18 bits in 24 bits, unsigned, little endian |
| AudioFormatU18be | 18 bits in 24 bits, unsigned, big endian |
| AudioFormatF32le | 32-bit floating point samples, little endian |
| AudioFormatF32be | 32-bit floating point samples, big endian |
| AudioFormatF64le | 64-bit floating point samples, little endian |
| AudioFormatF64be | 64-bit floating point samples, big endian |
| AudioFormatS16 | 16 bits in 16 bits, signed, native endianness |
| AudioFormatU16 | 16 bits in 16 bits, unsigned, native endianness |
| AudioFormatS2432 | 24 bits in 32 bits, signed, native endianness |
| AudioFormatU2432 | 24 bits in 32 bits, unsigned, native endianness |
| AudioFormatS32 | 32 bits in 32 bits, signed, native endianness |
| AudioFormatU32 | 32 bits in 32 bits, unsigned, native endianness |
| AudioFormatS24 | 24 bits in 24 bits, signed, native endianness |
| AudioFormatU24 | 24 bits in 24 bits, unsigned, native endianness |
| AudioFormatS20 | 20 bits in 24 bits, signed, native endianness |
| AudioFormatU20 | 20 bits in 24 bits, unsigned, native endianness |
| AudioFormatS18 | 18 bits in 24 bits, signed, native endianness |
| AudioFormatU18 | 18 bits in 24 bits, unsigned, native endianness |
| AudioFormatF32 | 32-bit floating point samples, native endianness |
| AudioFormatF64 | 64-bit floating point samples, native endianness |
| AnotherAudioFormat Int | Catch-all for unknown values |
Instances
AudioLayout
data AudioLayout Source #
Layout of the audio samples for the different channels.
Constructors
| AudioLayoutInterleaved | interleaved audio |
| AudioLayoutNonInterleaved | non-interleaved audio |
| AnotherAudioLayout Int | Catch-all for unknown values |
Instances
AudioNoiseShapingMethod
data AudioNoiseShapingMethod Source #
Set of available noise shaping methods
Constructors
| AudioNoiseShapingMethodNone | No noise shaping (default) |
| AudioNoiseShapingMethodErrorFeedback | Error feedback |
| AudioNoiseShapingMethodSimple | Simple 2-pole noise shaping |
| AudioNoiseShapingMethodMedium | Medium 5-pole noise shaping |
| AudioNoiseShapingMethodHigh | High 8-pole noise shaping |
| AnotherAudioNoiseShapingMethod Int | Catch-all for unknown values |
Instances
AudioResamplerFilterInterpolation
data AudioResamplerFilterInterpolation Source #
The different filter interpolation methods.
Since: 1.10
Constructors
| AudioResamplerFilterInterpolationNone | no interpolation |
| AudioResamplerFilterInterpolationLinear | linear interpolation of the filter coefficients. |
| AudioResamplerFilterInterpolationCubic | cubic interpolation of the filter coefficients. |
| AnotherAudioResamplerFilterInterpolation Int | Catch-all for unknown values |
Instances
AudioResamplerFilterMode
data AudioResamplerFilterMode Source #
Select for the filter tables should be set up.
Since: 1.10
Constructors
| AudioResamplerFilterModeInterpolated | Use interpolated filter tables. This
uses less memory but more CPU and is slightly less accurate but it allows for more
efficient variable rate resampling with |
| AudioResamplerFilterModeFull | Use full filter table. This uses more memory but less CPU. |
| AudioResamplerFilterModeAuto | Automatically choose between interpolated and full filter tables. |
| AnotherAudioResamplerFilterMode Int | Catch-all for unknown values |
Instances
AudioResamplerMethod
data AudioResamplerMethod Source #
Different subsampling and upsampling methods
Since: 1.10
Constructors
| AudioResamplerMethodNearest | Duplicates the samples when upsampling and drops when downsampling |
| AudioResamplerMethodLinear | Uses linear interpolation to reconstruct missing samples and averaging to downsample |
| AudioResamplerMethodCubic | Uses cubic interpolation |
| AudioResamplerMethodBlackmanNuttall | Uses Blackman-Nuttall windowed sinc interpolation |
| AudioResamplerMethodKaiser | Uses Kaiser windowed sinc interpolation |
| AnotherAudioResamplerMethod Int | Catch-all for unknown values |
Instances
AudioRingBufferFormatType
data AudioRingBufferFormatType Source #
The format of the samples in the ringbuffer.
Constructors
| AudioRingBufferFormatTypeRaw | samples in linear or float |
| AudioRingBufferFormatTypeMuLaw | samples in mulaw |
| AudioRingBufferFormatTypeALaw | samples in alaw |
| AudioRingBufferFormatTypeImaAdpcm | samples in ima adpcm |
| AudioRingBufferFormatTypeMpeg | samples in mpeg audio (but not AAC) format |
| AudioRingBufferFormatTypeGsm | samples in gsm format |
| AudioRingBufferFormatTypeIec958 | samples in IEC958 frames (e.g. AC3) |
| AudioRingBufferFormatTypeAc3 | samples in AC3 format |
| AudioRingBufferFormatTypeEac3 | samples in EAC3 format |
| AudioRingBufferFormatTypeDts | samples in DTS format |
| AudioRingBufferFormatTypeMpeg2Aac | samples in MPEG-2 AAC ADTS format |
| AudioRingBufferFormatTypeMpeg4Aac | samples in MPEG-4 AAC ADTS format |
| AudioRingBufferFormatTypeMpeg2AacRaw | samples in MPEG-2 AAC raw format (Since: 1.12) |
| AudioRingBufferFormatTypeMpeg4AacRaw | samples in MPEG-4 AAC raw format (Since: 1.12) |
| AudioRingBufferFormatTypeFlac | samples in FLAC format (Since: 1.12) |
| AnotherAudioRingBufferFormatType Int | Catch-all for unknown values |
Instances
AudioRingBufferState
data AudioRingBufferState Source #
The state of the ringbuffer.
Constructors
| AudioRingBufferStateStopped | The ringbuffer is stopped |
| AudioRingBufferStatePaused | The ringbuffer is paused |
| AudioRingBufferStateStarted | The ringbuffer is started |
| AudioRingBufferStateError | The ringbuffer has encountered an error after it has been started, e.g. because the device was disconnected (Since: 1.2) |
| AnotherAudioRingBufferState Int | Catch-all for unknown values |
Instances
StreamVolumeFormat
data StreamVolumeFormat Source #
Different representations of a stream volume. streamVolumeConvertVolume
allows to convert between the different representations.
Formulas to convert from a linear to a cubic or dB volume are cbrt(val) and 20 * log10 (val).
Constructors
| StreamVolumeFormatLinear | Linear scale factor, 1.0 = 100% |
| StreamVolumeFormatCubic | Cubic volume scale |
| StreamVolumeFormatDb | Logarithmic volume scale (dB, amplitude not power) |
| AnotherStreamVolumeFormat Int | Catch-all for unknown values |