Edit

Share via


xaudio2.h header

This header is used by XAudio2 APIs. For more information, see:

xaudio2.h contains the following programming interfaces:

Interfaces

 
IXAudio2

IXAudio2 is the interface for the XAudio2 object that manages all audio engine states, the audio processing thread, the voice graph, and so forth.
IXAudio2EngineCallback

The IXAudio2EngineCallback interface contains methods that notify the client when certain events happen in the IXAudio2 engine.
IXAudio2MasteringVoice

A mastering voice is used to represent the audio output device.
IXAudio2SourceVoice

Use a source voice to submit audio data to the XAudio2 processing pipeline.
IXAudio2SubmixVoice

A submix voice is used primarily for performance improvements and effects processing.
IXAudio2Voice

IXAudio2Voice represents the base interface from which IXAudio2SourceVoice, IXAudio2SubmixVoice and IXAudio2MasteringVoice are derived. The methods listed below are common to all voice subclasses.
IXAudio2VoiceCallback

The IXAudio2VoiceCallback interface contains methods that notify the client when certain events happen in a given IXAudio2SourceVoice.

Functions

 
XAudio2AmplitudeRatioToDecibels

Inline function that converts an amplitude ratio value to a decibel value.
XAudio2Create

Creates a new XAudio2 object and returns a pointer to its IXAudio2 interface.
XAudio2CutoffFrequencyToOnePoleCoefficient

Inline function that converts from filter cutoff frequencies expressed in hertz to the filter coefficients used with the Frequency member of the XAUDIO2_FILTER_PARAMETERS structure.
XAudio2CutoffFrequencyToRadians

Inline function that converts from filter cutoff frequencies expressed in hertz to the radian frequency values used in the Frequency member of the XAUDIO2_FILTER_PARAMETERS structure.
XAudio2DecibelsToAmplitudeRatio

Inline function that converts a decibel value to an amplitude ratio value.
XAudio2FrequencyRatioToSemitones

Inline function that converts a frequency ratio value to a semitone value.
XAudio2RadiansToCutoffFrequency

Inline function that converts from the radian frequencies used in XAUDIO2_FILTER_PARAMETERS back to absolute frequencies in hertz.
XAudio2SemitonesToFrequencyRatio

Inline function that converts a semitone value to a frequency ratio value.

Structures

 
XAUDIO2_BUFFER

Represents an audio data buffer, used with IXAudio2SourceVoice::SubmitSourceBuffer.
XAUDIO2_BUFFER_WMA

Used with IXAudio2SourceVoice::SubmitSourceBuffer when submitting xWMA data.
XAUDIO2_DEBUG_CONFIGURATION

Contains the new global debug configuration for XAudio2. Used with the SetDebugConfiguration function.
XAUDIO2_EFFECT_CHAIN

Defines an effect chain.
XAUDIO2_EFFECT_DESCRIPTOR

Contains information about an XAPO for use in an effect chain.
XAUDIO2_FILTER_PARAMETERS

Defines filter parameters for a source voice.
XAUDIO2_PERFORMANCE_DATA

Contains performance information. (XAUDIO2_PERFORMANCE_DATA)
XAUDIO2_SEND_DESCRIPTOR

Defines a destination voice that is the target of a send from another voice and specifies whether a filter should be used.
XAUDIO2_VOICE_DETAILS

Contains information about the creation flags, input channels, and sample rate of a voice.
XAUDIO2_VOICE_SENDS

Defines a set of voices to receive data from a single output voice.
XAUDIO2_VOICE_STATE

Returns the voice's current state and cursor position data.

Enumerations

 
XAUDIO2_FILTER_TYPE

Indicates the filter type.