Microsoft DirectX 8.0 (C++)

DSCEFFECTDESC

Contains parameters for an effect associated with a capture buffer.

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 IDirectSoundCapture8::CreateCaptureBuffer, this member can be zero or one or more of the following values.
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 or more of the following values.
DSCFXR_LOCHARDWARE
Effect was created in hardware.
DSCFXR_LOCSOFTWARE
Effect was created in software.
DSCFXR_UNALLOCATED
The effect was not created.
DSCFXR_FAILED
Effect creation failed.
DSCFXR_UNKNOWN
Result of effect creation is unknown.
guidDSCFXClass
Value of type GUID that specifies the class identifier of the effect. The following standard identifiers are defined.
DSCFX_CLASS_AEC
Acoustic echo cancellation.
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.
DSCFX_MS_AEC
Microsoft acoustic echo cancellation. Available in software only.
DSCFX_MS _NS
Microsoft noise suppression. Available in software only.
DSCFX_SYSTEM_AEC
System default acoustic echo cancellation.
DSCFX_SYSTEM_NS
System default noise suppression.
DSCFX_NOP
No effect.

dwReserved1
Reserved. Must be 0.
dwReserved2
Reserved. Must be 0.

Requirements

  Header: Declared in dsound.h.