FSOUND_FX_SetGargle

##### [API function]

## FSOUND_FX_SetGargle

Sets the parameters for the gargle effect on a particular channel

signed char F_API FSOUND_FX_SetGargle(
int fxid,
int RateHz,
int WaveShape
);

### Parameters

fxid | fx handle generated by FSOUND_FX_Enable, to set gargle parameters for.
RateHz | Rate of modulation, in Hertz. Must be in the range from 1 through 1000.
WaveShape | Shape of the modulation wave. The following values are defined. 0 - Triangular wave. 1 - Square wave.

### Return Value

On success, TRUE is returned.
On failure, FALSE is returned.

### Remarks

Make sure you have enabled this effect with FSOUND_FX_Enable and FSOUND_FX_GARGLE before using this function.
___________________
Supported on the following platforms : Win32

### See Also

FSOUND_FX_Disable , FSOUND_FX_Enable , FSOUND_FX_MODES , FSOUND_FX_SetChorus , FSOUND_FX_SetCompressor , FSOUND_FX_SetDistortion , FSOUND_FX_SetEcho , FSOUND_FX_SetFlanger , FSOUND_FX_SetI3DL2Reverb , FSOUND_FX_SetParamEQ , FSOUND_FX_SetWavesReverb

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Thu Dec 15 17:31:29 2005 by SourceDoc v0.10, the automated source code documenter.