Previous Topic Index Next Topic
[API function]

FSOUND_FX_SetEcho

Sets the parameters for the echo effect on a particular channel

signed char F_API FSOUND_FX_SetEcho(
int fxid,
float WetDryMix,
float Feedback,
float LeftDelay,
float RightDelay,
int PanDelay
);

Parameters

fxid fx handle generated by FSOUND_FX_Enable, to set echo parameters for.
WetDryMix Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 through 100 (all wet).
Feedback Percentage of output fed back into input, in the range from 0 through 100. The default value is 0.
LeftDelay Delay for left channel, in milliseconds, in the range from 1 through 2000. The default value is 333 ms.
RightDelay Delay for right channel, in milliseconds, in the range from 1 through 2000. The default value is 333 ms.
PanDelay Value that specifies whether to swap left and right delays with each successive echo. The default value is FALSE, meaning no swap. Possible values are defined as TRUE or FALSE.

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_ECHO 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_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.