Previous Topic Index Next Topic
[API function]

FSOUND_SetFrequency

Sets a channels frequency or playback rate, in HZ.

signed char F_API FSOUND_SetFrequency(
int channel,
int freq
);

Parameters

channel The channel number/handle to change the frequency for. FSOUND_ALL can also be used (see remarks).
freq The frequency to set. Valid ranges are from 100 to 705600, and -100 to -705600.

Return Value

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

Remarks

FSOUND_ALL is supported here. Passing this will set ALL channels to specified frequency.
If FSOUND_ALL is used the last channel success flag will be returned. This return value is not useful in most circumstances.
Negative frequencies make the sound play backwards, so FSOUND_SetCurrentPosition would be needed to set the sound to the right
position. Note! This effect is only supported in the Linux and Win32 build with high quality mixers.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2

See Also

FSOUND_DSP_MixBuffers , FSOUND_GetFrequency , FSOUND_Record_StartSample , FSOUND_Sample_SetDefaults , FSOUND_SetCurrentPosition

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Fri Dec 20 16:31:09 2002 by SourceDoc v0.10, the automated source code documenter.