Previous Topic Index Next Topic
[API function]

FSOUND_FX_SetCompressor

Sets the parameters for the compressor effect on a particular channel

signed char F_API FSOUND_FX_SetCompressor(
int fxid,
float Gain,
float Attack,
float Release,
float Threshold,
float Ratio,
float Predelay
);

Parameters

fxid fx handle generated by FSOUND_FX_Enable, to set compressor parameters for.
Gain Output gain of signal after compression, in the range from -60 to 60. The default value is 0 dB.
Attack Time before compression reaches its full value, in the range from 0.01 to 500. The default value is 0.01 ms.
Release Speed at which compression is stopped after input drops below fThreshold, in the range from 50 to 3000. The default value is 50 ms.
Threshold Point at which compression begins, in decibels, in the range from -60 to 0. The default value is -10 dB.
Ratio Compression ratio, in the range from 1 to 100. The default value is 10, which means 10:1 compression.
Predelay Time after lThreshold is reached before attack phase is started, in milliseconds, in the range from 0 to 4. The default value is 0 ms.

Return Value

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

Remarks

Make sure you have enabled this effect with FSOUND_FX_COMPRESSOR 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_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.