Previous Topic Index Next Topic
[API function]

FSOUND_FX_SetChorus

Sets the parameters for the chorus effect on a particular channel

signed char F_API FSOUND_FX_SetChorus(
int fxid,
float WetDryMix,
float Depth,
float Feedback,
float Frequency,
int Waveform,
float Delay,
int Phase
);

Parameters

fxid fx handle generated by FSOUND_FX_Enable, to set chorus parameters for.
WetDryMix Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 through 100 (all wet).
Depth Percentage by which the delay time is modulated by the low-frequency oscillator, in hundredths of a percentage point. Must be in the range from 0 through 100. The default value is 25.
Feedback Percentage of output signal to feed back into the effects input, in the range from -99 to 99. The default value is 0.
Frequency Frequency of the LFO, in the range from 0 to 10. The default value is 0.
Waveform Waveform of the LFO. Defined values are
0 triangle.
1 sine.
By default, the waveform is a sine.
Delay Number of milliseconds the input is delayed before it is played back, in the range from 0 to 20. The default value is 0 ms.
Phase Phase differential between left and right LFOs, in the range from 0 through 4. Possible values are defined as follows:
0 -180 degrees
1 - 90 degrees
2 0 degrees
3 90 degrees
4 180 degrees

Return Value

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

Remarks

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

See Also

FSOUND_FX_Disable , FSOUND_FX_Enable , FSOUND_FX_MODES , FSOUND_FX_SetCompressor , FSOUND_FX_SetDistortion , 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 Fri Dec 20 16:31:08 2002 by SourceDoc v0.10, the automated source code documenter.