##### [API function]

## FMUSIC_GetGlobalVolume

Returns the song's current global volume

int F_API FMUSIC_GetGlobalVolume(
FMUSIC_MODULE *mod
);

### Parameters

mod | Pointer to the song to retrieve song global volume from.

### Return Value

Songs current global volume, from 0 (silence) to the maximum value
determined by the music format. Global volume maximums are different in
respect to each format, they range from 64 to 256.
On failure, -1 is returned.

### Remarks

GLOBAL volume is not the same as MASTER volume. GLOBAL volume is an internal
overall volume which can be altered by the song itself (ie there might be commands
to fade in a particular part of the song by scaling all the volumes in the song
up slowly from nothing).
GLOBAL volume is different to MASTER volume in that the song can modify without
your permission, whereas MASTER volume is an overall scalar that you can control.
For general use, MASTER volume is more useful, but you may want to reset a song's
GLOBAL volume at certain times in the song. (for example the song might have faded
out by using GLOBAL volume and you want to reset it)
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FMUSIC_GetMasterVolume , FMUSIC_SetMasterVolume

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