Share via

DSFXGargle Structure

  • 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 DSFXGargle structure contains parameters for an amplitude modulation effect.

Syntax

typedef struct DSFXGargle {
    DWORD dwRateHz;
    DWORD dwWaveShape;
} DSFXGargle;

Members

  • dwRateHz
    Rate of modulation, in Hertz. Must be in the range from DSFXGARGLE_RATEHZ_MIN through DSFXGARGLE_RATEHZ_MAX. The default value is 20.

  • dwWaveShape
    Shape of the modulation waveform. The following values are defined.

    Value Description
    DSFXGARGLE_WAVE_TRIANGLE Triangular waveform.
    DSFXGARGLE_WAVE_SQUARE Square waveform.

    The default value is DSFXGARGLE_WAVE_TRIANGLE.

Requirements

Header: Declared in DSound.h.

See Also

Gargle
IDirectSoundFXGargle8