Previous Topic Index Next Topic
[API function]

FSOUND_FX_SetI3DL2Reverb

Sets the parameters for the I3DL2 Reverb effect on a particular channel

signed char F_API FSOUND_FX_SetI3DL2Reverb(
int fxid,
int Room,
int RoomHF,
float RoomRolloffFactor,
float DecayTime,
float DecayHFRatio,
int Reflections,
float ReflectionsDelay,
int Reverb,
float ReverbDelay,
float Diffusion,
float Density,
float HFReference
);

Parameters

fxid fx handle generated by FSOUND_FX_Enable, to set I3DL2 Reverb parameters for.
Room Attenuation of the room effect, in millibels (mB), in the range from -10000 to 0. The default value is -1000 mB.
RoomHF Attenuation of the room high-frequency effect, in mB, in the range from -10000 to 0. The default value is 0 mB.
RoomRolloffFactor Rolloff factor for the reflected signals, in the range from 0 to 10. The default value is 0.0. The rolloff factor for the direct path is controlled by the listener.
DecayTime Decay time, in seconds, in the range from .1 to 20. The default value is 1.49 seconds.
DecayHFRatio Ratio of the decay time at high frequencies to the decay time at low frequencies, in the range from 0.1 to 2. The default value is 0.83.
Reflections Attenuation of early reflections relative to lRoom, in mB, in the range from -10000 to 1000. The default value is -2602 mB.
ReflectionsDelay Delay time of the first reflection relative to the direct path, in seconds, in the range from 0 to 0.3. The default value is 0.007 seconds.
Reverb Attenuation of late reverberation relative to lRoom, in mB, in the range from -10000 to 2000. The default value is 200 mB.
ReverbDelay Time limit between the early reflections and the late reverberation relative to the time of the first reflection, in seconds, in the range from 0 to 0.1. The default value is 0.011 seconds.
Diffusion Echo density in the late reverberation decay, in percent, in the range from 0 to 100. The default value is 100.0 percent.
Density Modal density in the late reverberation decay, in percent, in the range from 0 to 100. The default value is 100.0 percent.
HFReference Reference high frequency, in hertz, in the range from 20 to 20000. The default value is 5000.0 Hz.

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_I3DL2REVERB 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_SetGargle , 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.