nw::snd::Sound3DActor::SetupSound Member Function

Syntax

#include <nw/snd/snd_Sound3DActor.h>
protected:
virtual SoundStartable::StartResult SetupSound(
     SoundHandle* handle,
     u32 soundId,
     const StartInfo * startInfo,
     void* setupArg
);

Arguments

Name Description
in handle The handle associated with the sound to play.
in soundId ID of the sound to play.
in startInfo Detailed playback parameters.
in setupArg Parameter used at setup time.

Return Values

Returns the result of playback as a SoundStartable::StartResult type.

Description

Virtual function called when a sound is played.

Processing during sound playback can be customized by overriding this function.

setupArg is passed unchanged as an argument when calling SoundActor::SetupSound.

See Also

SoundHandle Class
SoundStartable::StartResult
SoundStartable::StartInfo

Revision History

2010/02/23
Initial version.

CONFIDENTIAL