IXAudio2 interface

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

This is the only XAudio2 interface that is derived from the COM IUnknown interface. It controls the lifetime of the XAudio2 object using two methods derived from IUnknownIXAudio2::AddRef and IXAudio2::Release. No other XAudio2 objects are reference-counted. Their lifetimes are explicitly controlled using create and destroy calls, and are bounded by the lifetime of the XAudio2 object that owns them.

Members

The IXAudio2 Interface interface inherits from the IUnknown interface. IXAudio2 also has these types of members:

Methods

The IXAudio2 Interface interface has these methods.

MethodDescription
AddRef

Adds a reference to the XAudio2 object.

CommitChanges

Atomically applies a set of operations that are tagged with a given identifier.

CreateMasteringVoice

Creates and configures a mastering voice.

CreateSourceVoice

Creates and configures a source voice.

CreateSubmixVoice

Creates and configures a submix voice.

GetPerformanceData

Returns current resource usage details, such as available memory or CPU usage.

QueryInterface

Queries for a given COM interface on the XAudio2 object.

RegisterForCallbacks

Adds an IXAudio2EngineCallback pointer to the XAudio2 engine callback list.

Release

Releases a reference to the XAudio2 object.

SetDebugConfiguration

Changes global debug logging options for XAudio2.

StartEngine

Starts the audio processing thread.

StopEngine

Stops the audio processing thread.

UnregisterForCallbacks

Removes an IXAudio2EngineCallback pointer from the XAudio2 engine callback list.

 

Remarks

The DirectX SDK versions of XAUDIO2 included three member functions that are not present in the Windows 8 version: GetDeviceCount, GetDeviceDetails, and Initialize. These enumeration methods are no longer provided and standard Windows Audio APIs should be used for device enumeration instead.

Platform Requirements

Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Requirements

Header

Xaudio2.h

Library

Xaudio2.lib

See also

XAudio2 Interfaces

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.