FSOUND_SetVolumeAbsolute

##### [API function]

## FSOUND_SetVolumeAbsolute

Sets a channels volume linearly.
This function is NOT affected by master volume.
This function is used when you want to quiet everything down using FSOUND_SetSFXMasterVolume, but make
a channel prominent.

signed char F_API FSOUND_SetVolumeAbsolute(
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 absolute 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.
-------------
A good example of this function being used for a game needing a voice over.
If all the background sounds were too loud and drowned out the voice over, there is no way to
feasibly go through all the sfx channels and lower the background noise volumes (some might be allocated by music).
Simply lower the background noise with FSOUND_SetSFXMasterVolume, and use FSOUND_SetVolumeAbsolute to bring
up the volume of the voice over to full, and you will get one channel standing out amongst the rest.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FSOUND_GetVolume , FSOUND_SetSFXMasterVolume , FSOUND_SetVolume , FSOUND_SetVolumeAbsolute

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Thu Dec 15 17:31:34 2005 by SourceDoc v0.10, the automated source code documenter.