FSOUND_FX_SetDistortion

##### [API function]

## FSOUND_FX_SetDistortion

Sets the parameters for the distortion effect on a particular channel

signed char F_API FSOUND_FX_SetDistortion(
int fxid,
float Gain,
float Edge,
float PostEQCenterFrequency,
float PostEQBandwidth,
float PreLowpassCutoff
);

### Parameters

fxid | fx handle generated by FSOUND_FX_Enable, to set distortion parameters for.
Gain | Amount of signal change after distortion, in the range from -60 through 0. The default value is 0 dB.
Edge | Percentage of distortion intensity, in the range in the range from 0 through 100. The default value is 50 percent.
PostEQCenterFrequency | Center frequency of harmonic content addition, in the range from 100 through 8000. The default value is 4000 Hz.
PostEQBandwidth | Width of frequency band that determines range of harmonic content addition, in the range from 100 through 8000. The default value is 4000 Hz.
PreLowpassCutoff | Filter cutoff for high-frequency harmonics attenuation, in the range from 100 through 8000. The default value is 4000 Hz.

### Return Value

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

### Remarks

Make sure you have enabled this effect with FSOUND_FX_DISTORTION 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_SetEcho , FSOUND_FX_SetFlanger , FSOUND_FX_SetGargle , 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.