nw::snd::StreamSoundHandle::Stop Member Function

#include <nw/snd/snd_StreamSoundHandle.h>
void Stop(
     int fadeFrames
);

	Name	Description
in	fadeFrames	Number of elapsed frames during a fade-out. The number of frames is based on the number of calls to SoundArchivePlayer::Update.

None.

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. If 0 has been specified, fade-out is not performed and sound stops after the sound for the release of the envelope is 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.

2010/12/24

Added information about the number of frames.

2010/01/22

Initial version.