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

#include <nw/snd/snd_SoundStartable.h>

StartResult PrepareSound(
     SoundHandle * pHandle,
     SoundArchive::ItemId soundId,
     const StartInfo * pStartInfo = NULL
);

	Name	Description
in	pHandle	The handle associated with the sound to play.
in	soundId	ID of the sound to play.
in	pStartInfo	Detailed playback parameters.

Returns the playback preparation result as a StartResult type.

Prepares to play the sound with the specified ID.

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.

SoundHandle Class
StartResult
StartSound
StartInfo

2010/07/27

Added that midway playback of a sound using pStartInfo is not yet supported.

2010/01/15

Initial version.