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

Syntax

#include <nw/snd/snd_SoundStartable.h>

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

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

List of Overloaded Member Functions

HoldSound ( SoundHandle , SoundArchive::ItemId, const StartInfo )	Plays or continues the sound with the specified ID.
HoldSound ( SoundHandle , const char , const StartInfo * )	Plays or holds the sound with the specified label string.

Description of HoldSound ( SoundHandle , SoundArchive::ItemId, const StartInfo )

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 the ID of 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.

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

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.