##### [API function]

## FMUSIC_SetMasterVolume

Sets a songs master volume.

signed char F_API FMUSIC_SetMasterVolume(
FMUSIC_MODULE *mod,
int volume
);

### Parameters

mod | Pointer to the song to have its master volume set.
volume | value from 0-256. 0 = silence, 256 = full volume.

### Return Value

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

### Remarks

Note if the hardware midi synth is selected, you cannot set the master volume.
This command will only work reliably if FSOUND_INIT_USEDEFAULTMIDISYNTH is selected.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FMUSIC_GetGlobalVolume , FMUSIC_GetMasterVolume , FSOUND_GetSFXMasterVolume , FSOUND_SetSFXMasterVolume

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