Share via

IDirectSoundCaptureBuffer8::GetFXStatus Method

  • Article

[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 GetFXStatus method retrieves the status of capture effects.

Syntax

HRESULT GetFXStatus(
         DWORD dwFXCount,
         LPDWORD pdwFXStatus
)

Parameters

  • dwFXCount
    Number of elements in the pdwFXStatus array.
  • pdwFXStatus
    Address of an array of DWORD variables that receive the status of each effect. This should contain the same number of elements as the array passed in the dwFXCount member of the DSCBUFFERDESC structure passed to DirectSoundFullDuplexCreate8 or IDirectSoundCapture8::CreateCaptureBuffer. The possible values returned in the array are as follows:
    Value Description
    DSCFXR_LOCHARDWARE Effect is instantiated in hardware.
    DSCFXR_LOCSOFTWARE Effect is instantiated in software.

Return Value

If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.

Requirements

Header: Declared in DSound.h.

Library: Use Dsound3d.dll.

See Also

IDirectSoundCaptureBuffer8