nw::snd::SequenceSoundHandle::Pause Member Function

#include <nw/snd/snd_SequenceSoundHandle.h>

void Pause(
     bool flag,
     int fadeFrames
);

	Name	Description
in	flag	Playback pauses when this is true and restarts if this is false.
in	fadeFrames	Number of frames that elapse when fading in and out.

None.

Pauses or restarts a sound.

Pauses or restarts the sound associated with the handle. If the handle is invalid, the function does nothing.

You can pause the sound while fading out or restart it while fading in for the number of frames specified by fadeFrames. If 0 is specified, the sound stops or restarts immediately.

The fade used during pause/restart operates independently for the fade-in used with restart and the fade-out used with pause. Since the number of frames taken to perform the fade represents the rate of change in volume from maximum volume to zero volume (or the number of frames from 0 volume to maximum volume) there is a possibility that the fade may complete in a shorter amount of time than the specified number of frames when another fade has been specified midway through a fade.

IsPause

2010/01/22

Initial version.