[API function]
Sets a channels volume linearly.
This function IS affected by FSOUND_SetSFXMasterVolume.
signed char F_API FSOUND_SetVolume(
int channel,
int vol
);
Parameters
channel |
The channel number/handle to change the volume for. FSOUND_ALL can also be used (see remarks)
|
vol |
The volume to set. Valid ranges are from 0 (silent) to 255 (full volume)
|
Return Value
On success, TRUE is returned.
On failure, FALSE is returned.
Remarks
FSOUND_ALL is supported. Passing this will set the volume of ALL channels available.
If FSOUND_ALL is used the last channel success flag will be returned. This return value is not useful in most circumstances.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2
See Also
FSOUND_DSP_MixBuffers
,
FSOUND_GetVolume
,
FSOUND_Sample_SetDefaults
,
FSOUND_SetSFXMasterVolume
,
FSOUND_SetVolumeAbsolute
,
FSOUND_Stream_Play
,
FSOUND_Stream_PlayEx
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.