IDirectSoundCaptureFXNoiseSuppress8::GetAllParameters Method

Article
09/10/2011

[The feature associated with this page, DirectSound, is a legacy feature. It has been superseded by WASAPI and Audio Graphs. Media Casting have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Media Casting instead of DirectSound, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The GetAllParameters method retrieves the noise suppression parameters of a buffer.

Syntax

HRESULT GetAllParameters(
         LPDSCFXNoiseSuppress pDscFxNoiseSuppress
)

Parameters

pDscFxNoiseSuppress
Address of a DSCFXNoiseSuppress structure that receives the effect parameters.

Return Value

If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following values:

Return code

DSERR_INVALIDPARAM

DSERR_OUTOFMEMORY

Remarks

Windows
Important Note for Windows Vista Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio. To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.

Important Note for Windows Vista

Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.

To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.

Requirements

Header: Declared in DSound.h.

Library: Use Dsdmo.dll.