nw::snd::SoundStartable::StartSound Member Function

#include <nw/snd/snd_SoundStartable.h>
StartResult StartSound(
     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 result as a StartResult type.

Plays the sound having the specified ID.

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.

Calling this function is the same as calling PrepareSound immediately followed by a call to the handle class SoundHandle::StartPrepared.

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.