nw::snd::SoundPlayer::StopAllSound Member Function

Syntax

#include <nw/snd/snd_SoundPlayer.h>

void StopAllSound(
     int fadeFrames
);

Arguments

Name Description
in fadeFrames Number of elapsed frames during a fade-out.

Return Values

None.

Description

Stops all sounds.

Stops all sounds currently playing on the player. Performs processing identical to that when stopping a sound via the handle class.

You can fade out over the number of frames specified by fadeFrames. Fade-out is not performed when 0 has been specified. However, in the case of sound being generated in sequence sound, sound stops after the sound for the release of the envelope was generated, and all attenuation has been completed.

The volume control for fade-out is also used for fade-in. The number of fade-out frames correlates to the speed of change from maximum volume to silence. If a fade-out is specified during a fade-in, or in other similar situations, it may complete sooner than the specified frame count.

Revision History

2010/01/15
Initial version.

CONFIDENTIAL