| Microsoft DirectX 9.0 |
The DSCEFFECTDESC structure contains parameters for an effect associated with a capture buffer.
Syntax
typedef struct _DSCEFFECTDESC {
DWORD dwSize;
DWORD dwFlags;
GUID guidDSCFXClass;
GUID guidDSCFXInstance;
DWORD dwReserved1;
DWORD dwReserved2;
} DSCEFFECTDESC, *LPDSCEFFECTDESC;
typedef const DSCEFFECTDESC *LPCDSCEFFECTDESC;
Members
dwSize
Size of the structure, in bytes.
dwFlags
Flags that specify desired parameters of the effect. When this structure is passed to DirectSoundFullDuplexCreate8, or IDirectSoundCapture8::CreateCaptureBuffer, this member must be one of the values shown in the following table.
| Value | Description |
| DSCFX_LOCHARDWARE | Effect specified by guidDSCFXInstance must be in hardware. |
| DSCFX_LOCSOFTWARE | Effect specified by guidDSCFXInstance must be in software. |
On return, this member can contain one of the values shown in the following table.
| Value | Description |
| DSCFXR_LOCHARDWARE | Effect was created in hardware. |
| DSCFXR_LOCSOFTWARE | Effect was created in software. |
guidDSCFXClass
Value of type GUID that specifies the class identifier of the effect. The following standard identifiers are defined.
| Value | Description |
| GUID_DSCFX_CLASS_AEC | Acoustic echo cancellation. |
| GUID_DSCFX_CLASS_NS | Noise suppression. |
guidDSCFXInstance
Value of type GUID that specifies the unique identifier of the preferred effect. The following standard identifiers are defined.
| Value | Description |
| GUID_DSCFX_MS_AEC | Microsoft acoustic echo cancellation. Available in software only. |
| GUID_DSCFX_MS_NS | Microsoft noise suppression. Available in software only. |
| GUID_DSCFX_SYSTEM_AEC | System default acoustic echo cancellation. |
| GUID_DSCFX_SYSTEM_NS | System default noise suppression. |
dwReserved1
Reserved. Must be zero.
dwReserved2
Reserved. Must be zero.
Requirements
Header: Declared in Dsound.h.