Module xaudio2

Content

const XAudio2.Constants [src]

FORMAT_EXTENSIBLE	u16
Processor1	u32
Processor10	u32
Processor11	u32
Processor12	u32
Processor13	u32
Processor14	u32
Processor15	u32
Processor16	u32
Processor17	u32
Processor18	u32
Processor19	u32
Processor2	u32
Processor20	u32
Processor21	u32
Processor22	u32
Processor23	u32
Processor24	u32
Processor25	u32
Processor26	u32
Processor27	u32
Processor28	u32
Processor29	u32
Processor3	u32
Processor30	u32
Processor31	u32
Processor32	u32
Processor4	u32
Processor5	u32
Processor6	u32
Processor7	u32
Processor8	u32
Processor9	u32
X3DAUDIO_HANDLE_BYTESIZE	s32
X3DAUDIO_SPEED_OF_SOUND	f32
XAUDIO2_1024_QUANTUM	u32	Used in XAudio2Create to specify nondefault processing quantum of 21.33 ms (1024 samples at 48KHz).
XAUDIO2_ANY_PROCESSOR	u32
XAUDIO2_COMMIT_ALL	s32	Used in IXAudio2::CommitChanges.
XAUDIO2_COMMIT_NOW	s32	Used as an OperationSet argument.
XAUDIO2_DEBUG_ENGINE	u32	Used in XAudio2Create.
XAUDIO2_DEFAULT_CHANNELS	s32	Used in CreateMasteringVoice.
XAUDIO2_DEFAULT_FREQ_RATIO	f32	Default MaxFrequencyRatio argument.
XAUDIO2_DEFAULT_SAMPLERATE	s32	Used in CreateMasteringVoice.
XAUDIO2_END_OF_STREAM	u32	Used in XAUDIO2_BUFFER.Flags.
XAUDIO2_INVALID_OPSET	u32	Not allowed for OperationSet arguments.
XAUDIO2_LOG_API_CALLS	u32	Public API function entries and exits.
XAUDIO2_LOG_DETAIL	u32	More detailed chit-chat.
XAUDIO2_LOG_ERRORS	u32	For handled errors with serious effects.
XAUDIO2_LOG_FUNC_CALLS	u32	Internal function entries and exits.
XAUDIO2_LOG_INFO	u32	Informational chit-chat (e.g. state changes).
XAUDIO2_LOG_LOCKS	u32	Usage of critical sections and mutexes.
XAUDIO2_LOG_MEMORY	u32	Memory heap usage information.
XAUDIO2_LOG_STREAMING	u32	Audio streaming information.
XAUDIO2_LOG_TIMING	u32	Delays detected and other timing data.
XAUDIO2_LOG_WARNINGS	u32	For handled errors that may be recoverable.
XAUDIO2_LOOP_INFINITE	s32	Used in XAUDIO2_BUFFER.LoopCount.
XAUDIO2_MAX_AUDIO_CHANNELS	s32	Maximum channels in an audio stream.
XAUDIO2_MAX_BUFFERS_SYSTEM	s32	Maximum buffers allowed for system threads (Xbox 360 only).
XAUDIO2_MAX_BUFFER_BYTES	u32	Maximum bytes allowed in a source buffer.
XAUDIO2_MAX_FILTER_FREQUENCY	f32	Maximum XAUDIO2_FILTER_PARAMETERS.Frequency.
XAUDIO2_MAX_FILTER_ONEOVERQ	f32	Maximum XAUDIO2_FILTER_PARAMETERS.OneOverQ.
XAUDIO2_MAX_FREQ_RATIO	f32	Maximum MaxFrequencyRatio argument.
XAUDIO2_MAX_INSTANCES	s32	Maximum simultaneous XAudio2 objects on Xbox 360.
XAUDIO2_MAX_LOOP_COUNT	s32	Maximum non-infinite XAUDIO2_BUFFER.LoopCount.
XAUDIO2_MAX_QUEUED_BUFFERS	s32	Maximum buffers allowed in a voice queue.
XAUDIO2_MAX_SAMPLE_RATE	s32	Maximum audio sample rate supported.
XAUDIO2_MAX_VOLUME_LEVEL	f32	Maximum acceptable volume level (2^24).
XAUDIO2_MIN_FREQ_RATIO	f32	Minimum SetFrequencyRatio argument.
XAUDIO2_MIN_SAMPLE_RATE	s32	Minimum audio sample rate supported.
XAUDIO2_NO_LOOP_REGION	s32	Used in XAUDIO2_BUFFER.LoopCount.
XAUDIO2_NO_VIRTUAL_AUDIO_CLIENT	u32	Used in CreateMasteringVoice to create a virtual audio client.
XAUDIO2_PLAY_TAILS	u32	Used in IXAudio2SourceVoice::Stop.
XAUDIO2_SEND_USEFILTER	u32	Used in XAUDIO2_SEND_DESCRIPTOR.Flags.
XAUDIO2_STOP_ENGINE_WHEN_IDLE	u32	Used in XAudio2Create to force the engine to Stop when no source voices are Started, and Start when a voice is Started.
XAUDIO2_VOICE_NOPITCH	u32	Used in IXAudio2::CreateSourceVoice.
XAUDIO2_VOICE_NOSAMPLESPLAYED	u32	Used in IXAudio2SourceVoice::GetState.
XAUDIO2_VOICE_NOSRC	u32	Used in IXAudio2::CreateSourceVoice.
XAUDIO2_VOICE_USEFILTER	u32	Used in IXAudio2::CreateSource/SubmixVoice.

type alias XAudio2.Type Aliases [src]

FLOAT32	FLOAT32
UINT32	UINT32
UINT64	UINT64
X3DAUDIO_HANDLE	X3DAUDIO_HANDLE
XAUDIO2_PROCESSOR	XAUDIO2_PROCESSOR

enum XAudio2.AUDIO_STREAM_CATEGORY [src]

AudioCategory_Other
AudioCategory_ForegroundOnlyMedia
AudioCategory_BackgroundCapableMedia
AudioCategory_Communications
AudioCategory_Alerts
AudioCategory_SoundEffects
AudioCategory_GameEffects
AudioCategory_GameMedia
AudioCategory_GameChat
AudioCategory_Speech
AudioCategory_Movie
AudioCategory_Media

struct XAudio2.IXAudio2 [src]

vtbl

*IXAudio2Itf

struct XAudio2.IXAudio2EngineCallback [src]

vtbl

*IXAudio2EngineCallbackItf

struct XAudio2.IXAudio2EngineCallbackItf [src]

onProcessingPassStart	func(*IXAudio2EngineCallback)
onProcessingPassEnd	func(*IXAudio2EngineCallback)
onCriticalError	func(*IXAudio2EngineCallback, Win32.HRESULT)

struct XAudio2.IXAudio2Itf [src]

queryInterface	*void
addRef	func(*IXAudio2)->Win32.ULONG
release	func(*IXAudio2)->Win32.ULONG
registerForCallbacks	func(IXAudio2, IXAudio2EngineCallback)
unregisterForCallbacks	func(IXAudio2, IXAudio2EngineCallback)
createSourceVoice	func(IXAudio2, IXAudio2SourceVoice, const WAVEFORMATEX, UINT32, f32, IXAudio2VoiceCallback, const XAUDIO2_VOICE_SENDS, const *XAUDIO2_EFFECT_CHAIN)->Win32.HRESULT
createSubmixVoice	func(IXAudio2, IXAudio2SubmixVoice, UINT32, UINT32, UINT32, UINT32, const XAUDIO2_VOICE_SENDS, const *XAUDIO2_EFFECT_CHAIN)->Win32.HRESULT
createMasteringVoice	func(IXAudio2, IXAudio2MasteringVoice, UINT32, UINT32, UINT32, Win32.LPCWSTR, XAUDIO2_EFFECT_CHAIN, AUDIO_STREAM_CATEGORY)->Win32.HRESULT
startEngine	func(*IXAudio2)->Win32.HRESULT
stopEngine	func(*IXAudio2)
commitChanges	func(*IXAudio2, UINT32)->Win32.HRESULT
getPerformanceData	func(IXAudio2, XAUDIO2_PERFORMANCE_DATA)
setDebugConfiguration	func(IXAudio2, const XAUDIO2_DEBUG_CONFIGURATION, *void)

struct XAudio2.IXAudio2MasteringVoice [src]

vtbl

*IXAudio2MasteringVoiceItf

struct XAudio2.IXAudio2MasteringVoiceItf [src]

using voice	IXAudio2VoiceItf
getChannelMask	func(IXAudio2MasteringVoice, Win32.DWORD)->Win32.HRESULT

struct XAudio2.IXAudio2SourceVoice [src]

vtbl

*IXAudio2SourceVoiceItf

struct XAudio2.IXAudio2SourceVoiceItf [src]

using voice	IXAudio2VoiceItf
start	func(*IXAudio2SourceVoice, UINT32, UINT32)->Win32.HRESULT
stop	func(*IXAudio2SourceVoice, UINT32, UINT32)->Win32.HRESULT
submitSourceBuffer	func(IXAudio2SourceVoice, const XAUDIO2_BUFFER, const *XAUDIO2_BUFFER_WMA)->Win32.HRESULT
glushSourceBuffers	func(*IXAudio2SourceVoice)->Win32.HRESULT
discontinuity	func(*IXAudio2SourceVoice)->Win32.HRESULT
exitLoop	func(*IXAudio2SourceVoice, UINT32)->Win32.HRESULT
getState	func(IXAudio2SourceVoice, XAUDIO2_VOICE_STATE, UINT32)
setFrequencyRatio	func(*IXAudio2SourceVoice, f32, UINT32)->Win32.HRESULT
getFrequencyRatio	func(IXAudio2SourceVoice, f32)
setSourceSampleRate	func(*IXAudio2SourceVoice, UINT32)->Win32.HRESULT

struct XAudio2.IXAudio2SubmixVoice [src]

vtbl

*IXAudio2SubmixVoiceItf

struct XAudio2.IXAudio2SubmixVoiceItf [src]

using voice

IXAudio2VoiceItf

struct XAudio2.IXAudio2Voice [src]

vtbl

*IXAudio2VoiceItf

struct XAudio2.IXAudio2VoiceCallback [src]

vtbl

*IXAudio2VoiceCallbackItf

struct XAudio2.IXAudio2VoiceCallbackItf [src]

onVoiceProcessingPassStart	func(*IXAudio2VoiceCallback, UINT32)
onVoiceProcessingPassEnd	func(*IXAudio2VoiceCallback)
onStreamEnd	func(*IXAudio2VoiceCallback)
onBufferStart	func(IXAudio2VoiceCallback, void)
onBufferEnd	func(IXAudio2VoiceCallback, void)
onLoopEnd	func(IXAudio2VoiceCallback, void)
onVoiceError	func(IXAudio2VoiceCallback, void, Win32.HRESULT)

struct XAudio2.IXAudio2VoiceItf [src]

getVoiceDetails	func(IXAudio2Voice, XAUDIO2_VOICE_DETAILS)
setOutputVoices	func(IXAudio2Voice, const XAUDIO2_VOICE_SENDS)->Win32.HRESULT
setEffectChain	func(IXAudio2Voice, const XAUDIO2_EFFECT_CHAIN)
enableEffect	func(*IXAudio2Voice, UINT32, UINT32)->Win32.HRESULT
disableEffect	func(*IXAudio2Voice, UINT32, UINT32)->Win32.HRESULT
getEffectState	func(IXAudio2Voice, UINT32, Win32.BOOL)
setEffectParameters	func(IXAudio2Voice, UINT32, const void, UINT32, UINT32)->Win32.HRESULT
getEffectParameters	func(IXAudio2Voice, UINT32, void, UINT32)->Win32.HRESULT
setFilterParameters	func(IXAudio2Voice, const XAUDIO2_FILTER_PARAMETERS, UINT32)->Win32.HRESULT
getFilterParameters	func(IXAudio2Voice, XAUDIO2_FILTER_PARAMETERS)
setOutputFilterParameters	func(IXAudio2Voice, IXAudio2Voice, const *XAUDIO2_FILTER_PARAMETERS, UINT32)->Win32.HRESULT
getOutputFilterParameters	func(IXAudio2Voice, IXAudio2Voice, *XAUDIO2_FILTER_PARAMETERS)
setVolume	func(*IXAudio2Voice, f32, UINT32)->Win32.HRESULT
getVolume	func(IXAudio2Voice, f32)
setChannelVolumes	func(IXAudio2Voice, UINT32, const f32, UINT32)->Win32.HRESULT
getChannelVolumes	func(IXAudio2Voice, UINT32, f32)
setOutputMatrix	func(IXAudio2Voice, IXAudio2Voice, UINT32, UINT32, const *f32, UINT32)->Win32.HRESULT
getOutputMatrix	func(IXAudio2Voice, IXAudio2Voice, UINT32, UINT32, *f32)
destroyVoice	func(*IXAudio2Voice)

struct XAudio2.WAVEFORMATEX [src]

wFormatTag	Win32.WORD
nChannels	Win32.WORD
nSamplesPerSec	Win32.DWORD
nAvgBytesPerSec	Win32.DWORD
nBlockAlign	Win32.WORD
wBitsPerSample	Win32.WORD
cbSize	Win32.WORD

struct XAudio2.WAVEFORMATEXTENSIBLE [src]

format	WAVEFORMATEX
samples	{wValidBitsPerSample:Win32.WORD,wSamplesPerBlock:Win32.WORD,wReserved:Win32.WORD}
dwChannelMask	Win32.DWORD
subFormat	Win32.GUID

func XAudio2.X3DAudioInitialize [src]

func X3DAudioInitialize(speakerChannelMask: UINT32, speedOfSound: FLOAT32, instance: X3DAUDIO_HANDLE)->Win32.HRESULT

struct XAudio2.XAUDIO2_BUFFER [src]

flags	UINT32	Either 0 or XAUDIO2_END_OF_STREAM.
audioBytes	UINT32	Size of the audio data buffer in bytes.
pAudioData	const *Win32.BYTE	Pointer to the audio data buffer.
playBegin	UINT32	First sample in this buffer to be played.
playLength	UINT32	Length of the region to be played in samples, or 0 to play the whole buffer.
loopBegin	UINT32	First sample of the region to be looped.
loopLength	UINT32	Length of the desired for region in samples, or 0 to for the entire buffer.
loopCount	UINT32	Number of times to repeat the for region, or XAUDIO2_LOOP_INFINITE to for forever.
pContext	*void	Context value to be passed back in callbacks.

struct XAudio2.XAUDIO2_BUFFER_WMA [src]

pDecodedPacketCumulativeBytes	const *UINT32
PacketCount	UINT32

struct XAudio2.XAUDIO2_DEBUG_CONFIGURATION [src]

traceMask	UINT32
breakMask	UINT32
logThreadID	Win32.BOOL
logFileline	Win32.BOOL
logFunctionName	Win32.BOOL
logTiming	Win32.BOOL

struct XAudio2.XAUDIO2_EFFECT_CHAIN [src]

struct XAudio2.XAUDIO2_FILTER_PARAMETERS [src]

type	XAUDIO2_FILTER_TYPE
frequency	f32
oneOverQ	f32

enum XAudio2.XAUDIO2_FILTER_TYPE [src]

Used in XAUDIO2_FILTER_PARAMETERS below.

LowPassFilter	Attenuates frequencies above the cutoff frequency (state-variable filter).
BandPassFilter	Attenuates frequencies outside a given range (state-variable filter).
HighPassFilter	Attenuates frequencies below the cutoff frequency (state-variable filter).
NotchFilter	Attenuates frequencies inside a given range (state-variable filter).
LowPassOnePoleFilter	Attenuates frequencies above the cutoff frequency (one-pole filter, XAUDIO2_FILTER_PARAMETERS.OneOverQ has no effect).
HighPassOnePoleFilter	Attenuates frequencies below the cutoff frequency (one-pole filter, XAUDIO2_FILTER_PARAMETERS.OneOverQ has no effect).

struct XAudio2.XAUDIO2_PERFORMANCE_DATA [src]

AudioCyclesSinceLastQuery	UINT64
TotalCyclesSinceLastQuery	UINT64
MinimumCyclesPerQuantum	UINT32
MaximumCyclesPerQuantum	UINT32
MemoryUsageInBytes	UINT32
CurrentLatencyInSamples	UINT32
GlitchesSinceEngineStarted	UINT32
ActiveSourceVoiceCount	UINT32
TotalSourceVoiceCount	UINT32
ActiveSubmixVoiceCount	UINT32
ActiveResamplerCount	UINT32
ActiveMatrixMixCount	UINT32
ActiveXmaSourceVoices	UINT32
ActiveXmaStreams	UINT32

struct XAudio2.XAUDIO2_SEND_DESCRIPTOR [src]

flags	UINT32
pOutputVoice	*IXAudio2Voice

struct XAudio2.XAUDIO2_VOICE_DETAILS [src]

creationFlags	UINT32
activeFlags	UINT32
inputChannels	UINT32
inputSampleRate	UINT32

struct XAudio2.XAUDIO2_VOICE_SENDS [src]

sendCount	UINT32
pSends	*XAUDIO2_SEND_DESCRIPTOR

struct XAudio2.XAUDIO2_VOICE_STATE [src]

pCurrentBufferContext	*void
buffersQueued	UINT32
samplesPlayed	UINT64

func XAudio2.XAudio2Create [src]

func XAudio2Create(ppXAudio2: **IXAudio2, flags: UINT32, processor: XAUDIO2_PROCESSOR = XAUDIO2_ANY_PROCESSOR)->Win32.HRESULT

Generated on 12-10-2025 with swag 0.45.0

Table of Contents

Structs

Enums

Constants

Type Aliases

Functions

Module xaudio2

Content