XAudio2 Boundary Values and Flags
XAudio2 constants that specify default parameters, maximum values, and flags.
XAudio2 boundary values
| Constant | Description |
|---|---|
|
Maximum value allowed for XAUDIO2_BUFFER.AudioBytes. |
|
Maximum buffers allowed in a voice queue. |
|
Maximum buffers allowed for system threads (Xbox 360 only). |
|
Maximum value allowed for WAVEFORMATEX.nChannels. |
|
Minimum audio sample rate supported. |
|
Maximum audio sample rate supported. |
|
Maximum allowed volume level. |
|
Minimum frequency ratio allowed in a source voice. |
|
Maximum frequency ratio allowed in a source voice. |
|
Default value for the MaxFrequencyRatio argument of IXAudio2::CreateSourceVoice. |
|
Maximum value for XAUDIO2_FILTER_PARAMETERS.OneOverQ. |
|
Maximum value for XAUDIO2_FILTER_PARAMETERS.Frequency. |
|
Maximum value that will not be treated as infinite looping for XAUDIO2_BUFFER.LoopCount. |
|
Maximum simultaneous instances of XAudio2 allowed on Xbox 360. |
XAudio2 values with special meaning
| Constant | Description |
|---|---|
|
Used as a parameter to methods with an OperationSet argument. See XAudio2 Operation Sets for more information. |
|
Used as a parameter in IXAudio2::CommitChanges. |
|
Specifies an invalid value for OperationSet arguments. See XAudio2 Operation Sets for more information. |
|
Specifies no loop region, used in XAUDIO2_BUFFER.LoopCount. |
|
Specifies infinite looping, used in XAUDIO2_BUFFER.LoopCount. |
|
Specifies the default number of channels for the current platform, used in IXAudio2::CreateMasteringVoice. |
|
Specifies the default sample rate for the current platform, used in IXAudio2::CreateMasteringVoice. |
XAudio2 Flags
| Constant | Description |
|---|---|
| XAUDIO2_DEBUG_ENGINE |
Specifies that the debug/checked version of the audio engine should be used instead of the release version. See XAudio2Create. Note: This flag is not supported on Windows 8 or Windows 10. |
|
Specifies that a source voice will not use pitch shifting, see IXAudio2::CreateSourceVoice. |
|
Specifies that no sample rate conversion is available on a source voice, the voice's outputs must have the same sample rate. See IXAudio2::CreateSourceVoice. |
|
Specifies that the filter effect should be available on a voice. See IXAudio2::CreateSourceVoice and IXAudio2::CreateSubmixVoice. |
|
Specifies that a voice should continue emitting effect output after it is stopped. See IXAudio2SourceVoice::Stop. |
|
Indicates the last buffer in a stream. See XAUDIO2_BUFFER.Flags. |
|
Specifies that the audio engine should stop when no source voices are started and start when a voice is started. See XAudio2Create. |
|
Indicates a filter should be used on a voice send. See XAUDIO2_SEND_DESCRIPTOR.Flags. |
|
Specifies a non-default processing quantum of 21.33 ms (1024 samples at 48KHz). See XAudio2Create. |
| XAUDIO2_NO_VIRTUAL_AUDIO_CLIENT |
Specifies that a virtual audio client should not be used. See IXAudio2::CreateMasteringVoice. Note: On devices in the Mobile device family, a virtual audio client is always used, regardless of whether this flag is used. |
XAudio2 Default Parameters for the Built-in Voice Filter
| Constant | Description |
|---|---|
|
Specifies the default filter type to be used with voices and voice sends. |
|
Specifies the default filter frequency to be used with voices and voice sends. |
|
Specifies the default filter rate of decay to be used with voices and voice sends. |
Remarks
Platform Requirements
Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)
Requirements
| Requirement | Value |
|---|---|
| Header |
|
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for