[API function]
Enables effect processing for the specified channel. This command continues to add effects to a channel (up to 16) until FSOUND_FX_Disable is called.
int F_API FSOUND_FX_Enable(
int channel,
unsigned int fx
);
Parameters
channel |
Channel number/handle to enable fx for.
|
fx |
A single fx enum value to enable certain effects.
|
Return Value
On success, an FX id is returned.
On failure, -1 is returned.
Remarks
This command can only be issued while the channel is paused.
If an effect is not enabled, then it will not be affected by its corresponding FSOUND_FX_Set functions.
This function must be played after a paused PlaySoundEx (ie FSOUND_PlaySoundEx(FSOUND_FREE, sound, NULL, TRUE)), and before
the FSOUND_SetPaused(FALSE) so that the hardware can get the resource before it starts playing.
A total of 16 FX per channel is allowed, any more will result in an error. FX are reset to 0 after a sound is stopped or played. (but as above, before the unpausing of a play-paused sound).
Warning : This function is expensive to call as it has to set up fx buffers etc. It is best to call it once, reserve the channel then reuse the channel index when calling playsound without calling it again.
Note : Channels with FX enabled sounds cannot have their frequency changed.
___________________
Supported on the following platforms : Win32
See Also
FSOUND_FX_Disable
,
FSOUND_FX_MODES
,
FSOUND_FX_SetChorus
,
FSOUND_FX_SetCompressor
,
FSOUND_FX_SetDistortion
,
FSOUND_FX_SetEcho
,
FSOUND_FX_SetFlanger
,
FSOUND_FX_SetGargle
,
FSOUND_FX_SetI3DL2Reverb
,
FSOUND_FX_SetParamEQ
,
FSOUND_FX_SetWavesReverb
,
FSOUND_PlaySound
,
FSOUND_PlaySoundEx
,
FSOUND_SetPaused
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.