nw::snd::SoundStartable::HoldSound Member Function

#include <nw/snd/snd_SoundStartable.h>

StartResult HoldSound(
     SoundHandle * pHandle,
     const char * pSoundName,
     const StartInfo * pHoldInfo = NULL
);

	Name	Description
in	pHandle	The handle associated with the sound to play.
in	pSoundName	Label character string of the sound to play.
in	pHoldInfo	Detailed playback parameters.

Returns the playback result as a StartResult type.

Plays or holds the sound with the specified label string.

The sound can be played as long as this function is called each frame with the same ID. The sound stops when calling stops.

The first argument specifies the sound handle.

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

The value of pHoldInfo 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
StartInfo

2010/07/27

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

2010/01/15

Initial version.