AudioFormatFlags Enum
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Flags describing the stream in the AudioStreamBasicDescription.
This enumeration supports a bitwise combination of its member values.
[System.Flags]
public enum AudioFormatFlags
type AudioFormatFlags =
- Inheritance
-
AudioFormatFlags
- Attributes
Fields
Name | Value | Description |
---|---|---|
AppleLossless16BitSourceData | 1 | Apple Lossless data, native endian, signed integers, 16 bits. |
CafIsFloat | 1 | |
IsFloat | 1 | If this flag is set, the data is encoded using floating point values instead of integers. |
LinearPCMIsFloat | 1 | |
AppleLossless20BitSourceData | 2 | Apple Lossless data, native endian, signed integers, 20 bits (24 bit aligned). |
CafIsLittleEndian | 2 | |
IsBigEndian | 2 | If this flag is set, the data is encoded in big endian format otherwise it is in little endian. |
LinearPCMIsBigEndian | 2 | |
AppleLossless24BitSourceData | 3 | Apple Lossless data, native endian, signed integers, 24 bits. |
AppleLossless32BitSourceData | 4 | Apple Lossless data, native endian, signed integers, 32 bits. |
IsSignedInteger | 4 | If the data encoded using integers (the IsFloat flag is cleared) this determines whether they are signed or unsigned. |
LinearPCMIsSignedInteger | 4 | |
LinearPCMSampleFractionShift | 7 | |
IsPacked | 8 | Set if the sample bits occupy the entire available bits for the channel, clear if they are high- or low-aligned within the channel. |
LinearPCMIsPacked | 8 | |
IsAlignedHigh | 16 | If set, sample bits are on the high bits. |
LinearPCMIsAlignedHigh | 16 | Linear PCM audio format: if set, sample bits are on the high bits. |
IsNonInterleaved | 32 | If set, the data is non-interleaved (monophonic). |
LinearPCMIsNonInterleaved | 32 | If this flag is set then there are separate AudioBuffers for each channel, otherwise the data for the left and right channels is interleaved in the same buffer. |
IsNonMixable | 64 | If set, the audio data is non-mixable. |
LinearPCMIsNonMixable | 64 | |
LinearPCMSampleFractionMask | 8064 | |
FlagsAreAllClear | 2147483648 | Use this value to indicate that no flags are set. Use instead of the value zero, as that represents that no flag state is set. |
LinearPCMFlagsAreAllClear | 2147483648 | Linear PCM audio format: all flags are set to zero. Use this instead of zero, which means that no flags are configured. |
Remarks
The core set of flags describe properties of the audio stream (integer vs float values, endianess, interleaved) while the other flags are only used if the AudioFormatType is set to either LinearPCM (those are the values prefixed with LinearPCM) or AppleLossles (enumeration values prefixed with AppleLossles).