nw::snd::SoundSystem::SetMasterVolume Member Function

#include <nw/snd/snd_SoundSystem.h>

static void SetMasterVolume(
     float volume,
     int fadeTimes
);

	Name	Description
in	volume	Volume ratio (0.0 or higher).
in	fadeTimes	Time over which volume is varied (in milliseconds).

None.

This function sets the master volume.

The master volume affects all sounds played by the sound library. It does not affect sounds played by any other means.

The value specified by this function operates independently of other volume parameters, which are mixed together.

The volume argument specifies a ratio of 0.0 or greater. There is no effect on the volume if 1.0 is specified. If 0.0 is specified, no sound is output. The default value is 1.0.

Note: After being combined with the other volume parameters, the final volume is clamped to the range of 0.0 to 2.0. Twice the original sound volume may not result even if 2.0 is set with this function.

The volume changes over the time specified by fadeTimes. If this function is called during a change in volume, the volume varies over the newly specified time, using the volume value at that point as the reference point.

GetMasterVolume

2010/01/26

Adjusted the wording.

2010/01/25

Added a description of arguments.

2010/01/15

Initial version.