XAPO Reference

The following components are used to build cross-platform audio effects.

Classes

Name	Description
CXAPOBase	Default implementation of the IXAPO interface.For a list of all members of this class, see CXAPOBase Members.
CXAPOParametersBase	Default implementation of the IXAPOParameters interface.For a list of all members of this class, see CXAPOParametersBase Members.

Interfaces

Name	Description
IXAPO	Interface that defines an XAPO, allowing it to be used in an XAudio2 effect chain.
IXAPOParameters	An optional interface that allows an XAPO to use effect-specific parameters.

Functions

Name	Description
CreateFX	Creates an instance of the requested XAPOFX effect.

Structures

Name	Description
FXECHO_INITDATA	Initialization parameters for use with the FXECHO XAPOFX.
FXECHO_PARAMETERS	Parameters for use with the FXECHO XAPOFX.
FXEQ_PARAMETERS	Parameters for use with the FXEQ XAPO.
FXLOUDNESS_PARAMETERS	Parameters for use with the FXLoudness XAPO.
FXMASTERINGLIMITER_PARAMETERS	Parameters for use with the FXMasteringLimiter XAPO.
FXREVERB_PARAMETERS	Parameters for use with the FXReverb XAPO.
XAPO_LOCKFORPROCESS_PARAMETERS	Defines stream buffer parameters that remain constant while an XAPO is locked. Used with the IXAPO::LockForProcess method.
XAPO_PROCESS_BUFFER_PARAMETERS	Defines stream buffer parameters that may change from one call to the next. Used with the Process method.
XAPO_REGISTRATION_PROPERTIES	Describes general characteristics of an XAPO. Used with IXAPO::GetRegistrationProperties and CXAPOBase::CXAPOBase.

Enumerations

Name	Description
XAPO_BUFFER_FLAGS	Describes the contents of a stream buffer.

Macros

Name	Description
XAPOAlloc	Memory allocation macro used by IXAPO methods that must allocate arbitrary sized structures that are subsequently returned to the application.
XAPOFree	Macro used to free memory allocated with the XAPOAlloc macro.