nw::snd::SoundHandle::Stop Member Function#include <nw/snd/snd_SoundHandle.h>
void Stop(
int fadeFrames
);
| Name | Description | |
|---|---|---|
| in | fadeFrames | Number of elapsed frames during a fade-out. |
Stops the sound.
Stops the sound associated with the handle. If the handle is invalid, the function does nothing.
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.
CONFIDENTIAL