nw::snd::SoundStartable::PrepareSound Member Function

Syntax

#include <nw/snd/snd_SoundStartable.h>
StartResult PrepareSound(
     SoundHandle * pHandle,
     SoundArchive::ItemId soundId,
     const StartInfo * pStartInfo = NULL
);
StartResult PrepareSound(
     SoundHandle * pHandle,
     const char * pSoundName,
     const StartInfo * pStartInfo = NULL
);

List of Overloaded Member Functions

PrepareSound ( SoundHandle *, SoundArchive::ItemId, const StartInfo * ) Prepares to play the sound with the specified ID.
PrepareSound ( SoundHandle *, const char *, const StartInfo * ) Prepares to play the sound with the specified label string.

Description of PrepareSound ( SoundHandle *, SoundArchive::ItemId, const StartInfo * )

You can call SoundHandle::StartPrepared from the handle class to start playing a sound for which preparations are complete.

The first argument specifies the sound handle. The sound for which playback succeeded is associated with this sound handle.

The second argument specifies the ID of the sound to play.

The pStartInfo argument contains detailed parameters that can be set during playback. You can start playback without setting these parameters.

Midway playback of a sound using pStartInfo is not supported because this is not currently implemented.

Description of PrepareSound ( SoundHandle *, const char *, const StartInfo * )

You can call SoundHandle::StartPrepared from the handle class to start playing a sound for which preparations are complete.

The first argument specifies the sound handle. The sound for which playback succeeded is associated with this sound handle.

The second argument specifies a label string that identifies the sound to play.

The pStartInfo argument contains detailed parameters that can be set during playback. You can start playback without setting these parameters.

Midway playback of a sound using pStartInfo is not supported because this is not currently implemented.

CONFIDENTIAL