mirror of
https://github.com/ENSL/NS.git
synced 2024-12-02 09:11:56 +00:00
73 lines
2.9 KiB
HTML
73 lines
2.9 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<META NAME="GENERATOR" Content="SOURCEDOC.EXE">
|
|
<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<TITLE>FMUSIC_GetGlobalVolume</TITLE>
|
|
<STYLE>
|
|
#flush {margin-left: -10p; margin-right: -0p}
|
|
#buttonbar {color: white}
|
|
</STYLE>
|
|
</HEAD>
|
|
<BODY TOPMARGIN=0 BGPROPERTIES="FIXED" BGCOLOR="white">
|
|
<FONT FACE="ARIAL">
|
|
<SPAN ID="flush">
|
|
<A NAME="SEE ALSO">
|
|
<TABLE WIDTH="100%" COLS=2 BORDER=0 BGCOLOR="#000000">
|
|
<TR ALIGN=RIGHT>
|
|
<TD ALIGN=LEFT>
|
|
<IMG SRC="banner03.gif" WIDTH="88" HEIGHT="31" BORDER=0>
|
|
</TD>
|
|
<TD ALIGN=RIGHT VALIGN=TOP>
|
|
<FONT FACE="ARIAL" SIZE="2">
|
|
<A ID=buttonbar HREF="FMUSIC_GetBPM.html">
|
|
<IMG SRC="u_prev.gif" WIDTH="71" HEIGHT="16" BORDER=0 ALT="Previous Topic">
|
|
</A>
|
|
<A ID=buttonbar HREF="FMUSIC.html">
|
|
<IMG SRC="u_index.gif" WIDTH="47" HEIGHT="16" BORDER=0 ALT="Index">
|
|
</A>
|
|
<A ID=buttonbar HREF="FMUSIC_GetMasterVolume.html">
|
|
<IMG SRC="u_next.gif" WIDTH="48" HEIGHT="16" BORDER=0 ALT="Next Topic">
|
|
</A>
|
|
</FONT></TD><TD WIDTH=15></TD>
|
|
</TR>
|
|
</TABLE>
|
|
</A>
|
|
</SPAN>
|
|
<A HREF="FMUSIC.html#Functions"><H5>[API function]</A></H5>
|
|
<H2><A NAME="FMUSIC_GetGlobalVolume">FMUSIC_GetGlobalVolume</A></H2>
|
|
Returns the song's current global volume<BR>
|
|
<P>
|
|
<B>int F_API </B><B> </B><B>FMUSIC_GetGlobalVolume</B><B>(</B><BR>
|
|
<B>FMUSIC_MODULE *</B><I>mod</I><BR>
|
|
<B>);</B><BR>
|
|
<H3>Parameters</H3>
|
|
<TABLE>
|
|
<TR VALIGN=top><TD><I>mod</I></TD>
|
|
<TD>Pointer to the song to retrieve song global volume from.<BR>
|
|
</TD></TABLE>
|
|
<H3>Return Value</H3>
|
|
Songs current global volume, from 0 (silence) to the maximum value<BR>
|
|
determined by the music format. Global volume maximums are different in <BR>
|
|
respect to each format, they range from 64 to 256.<BR>
|
|
On failure, -1 is returned.<BR>
|
|
<H3>Remarks</H3>
|
|
GLOBAL volume is not the same as MASTER volume. GLOBAL volume is an internal<BR>
|
|
overall volume which can be altered by the song itself (ie there might be commands<BR>
|
|
to fade in a particular part of the song by scaling all the volumes in the song <BR>
|
|
up slowly from nothing).<BR>
|
|
GLOBAL volume is different to MASTER volume in that the song can modify without<BR>
|
|
your permission, whereas MASTER volume is an overall scalar that you can control.<BR>
|
|
For general use, MASTER volume is more useful, but you may want to reset a song's<BR>
|
|
GLOBAL volume at certain times in the song. (for example the song might have faded <BR>
|
|
out by using GLOBAL volume and you want to reset it)<BR>
|
|
___________________<BR>
|
|
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube<BR>
|
|
<H3>See Also</H3>
|
|
<A HREF="FMUSIC_GetMasterVolume.html">FMUSIC_GetMasterVolume</A>
|
|
,
|
|
<A HREF="FMUSIC_SetMasterVolume.html">FMUSIC_SetMasterVolume</A>
|
|
<HR><BR><FONT SIZE="-2">This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.</FONT><BR>
|
|
<FONT SIZE="-2">Generated Thu Dec 15 17:31:25 2005
|
|
by SourceDoc v0.10, the automated source code documenter.</FONT><BR>
|
|
</BODY>
|
|
</HTML>
|