nw::snd::SoundPlayer::PauseAllSound Member Function

Syntax

#include <nw/snd/snd_SoundPlayer.h>
void PauseAllSound(
     bool flag,
     int fadeFrames
);

Arguments

Name Description
in flag If true, playback pauses. If false, playback restarts.
in fadeFrames Number of frames used for the fade-in/fade-out. The number of frames is based on the number of calls to SoundArchivePlayer::Update.

Return Values

None.

Description

Pauses or restarts all sounds.

Pauses or restarts all sounds currently playing on the player. Performs processing identical to that when pausing or restarting each sound via the handle class.

The fade used during pause/restart operates independently for the fade-in used with restart and the fade-out used with pause.

Revision History

2010/12/24
Added information about the number of frames.
2010/01/15
Initial version.

CONFIDENTIAL