Edit

Share via

XAUDIO2_EFFECT_DESCRIPTOR structure (xaudio2.h)

  • Article

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

Syntax

typedef struct XAUDIO2_EFFECT_DESCRIPTOR {
  IUnknown *pEffect;
  BOOL     InitialState;
  UINT32   OutputChannels;
} XAUDIO2_EFFECT_DESCRIPTOR;

Members

pEffect

Pointer to the IUnknown interface of the XAPO object.

InitialState

TRUE if the effect should begin in the enabled state. Otherwise, FALSE.

OutputChannels

Number of output channels the effect should produce.

Remarks

XAPO instances are passed to XAudio2 as IUnknown interfaces and XAudio2 uses IXAPO::QueryInterface to acquire an IXAPO interface and to detect whether the XAPO implements the IXAPOParameters interface.

For additional information on using XAPOs with XAudio2 see How to: Create an Effect Chain and How to: Use an XAPO in XAudio2.

Platform Requirements

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

Requirements

Requirement Value
Header xaudio2.h

See also

XAPO Overview

XAudio2 Structures

XAudio2_Effect_Chain