Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IXAPO interface

The interface for an Audio Processing Object which be used in an XAudio2 effect chain.

Members

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

Methods

The IXAPO interface has these methods.

MethodDescription
AddRef

Increments the XAPO object's reference count.

CalcInputFrames

Returns the number of input frames required to generate the given number of output frames.

CalcOutputFrames

Returns the number of output frames that will be generated from a given number of input frames.

GetRegistrationProperties

Returns the registration properties of an XAPO.

Initialize

Performs any effect-specific initialization.

IsInputFormatSupported

Queries if a specific input format is supported for a given output format.

IsOutputFormatSupported

Queries if a specific output format is supported for a given input format.

LockForProcess

Called by XAudio2 to lock the input and output configurations of an XAPO allowing it to do any final initialization before Process is called on the realtime thread.

Process

Runs the XAPO's digital signal processing (DSP) code on the given input and output buffers.

QueryInterface

Retrieves the requested interface pointer if the XAPO supports it.

Release

Decrements the XAPO object's reference count and deletes the object if the reference count falls to zero.

Reset

Resets variables dependent on frame history.

UnlockForProcess

Deallocates variables that were allocated with the LockForProcess method.

 

Remarks

Platform Requirements

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Requirements

Header

XAPO.h

See also

Interfaces

 

 

Show:
© 2016 Microsoft