nw4hbm::snd::detail::WaveSound Class Reference

#include <WaveSound.h>

Inheritance diagram for nw4hbm::snd::detail::WaveSound:

Collaboration diagram for nw4hbm::snd::detail::WaveSound:

Public Member Functions
	WaveSound (SoundInstanceManager< WaveSound > *manager)
virtual void	Shutdown ()
virtual void	SetPlayerPriority (int priority)
virtual bool	IsAttachedTempSpecialHandle ()
virtual void	DetachTempSpecialHandle ()
virtual BasicPlayer &	GetBasicPlayer ()
virtual const BasicPlayer &	GetBasicPlayer () const
bool	Prepare (const void *waveSoundBase, s32 waveSoundOffset, int voices, const WsdTrack::WsdCallback *callback, u32 callbackData)
void	SetChannelPriority (int priority)
void	SetReleasePriorityFix (bool flag)
Public Member Functions inherited from nw4hbm::snd::detail::BasicSound
	BasicSound ()
virtual	~BasicSound ()
virtual void	Update ()
virtual void	StartPrepared ()
virtual void	Stop (int frames=0)
virtual void	Pause (bool flag, int frames)
virtual void	SetAutoStopCounter (int count)
virtual void	FadeIn (int frames)
virtual bool	IsPrepared () const
virtual bool	IsPause () const
virtual void	SetInitialVolume (f32 volume)
virtual void	SetVolume (f32 volume, int frames)
virtual void	SetPitch (f32 pitch)
virtual void	SetPan (f32 pan)
virtual void	SetSurroundPan (f32 pan)
virtual void	SetLpfFreq (f32 freq)
virtual void	InitParam ()
PlayerHeap *	GetPlayerHeap ()
void	SetPlayerHeap (PlayerHeap *heap)
bool	IsAttachedGeneralHandle ()
void	DetachGeneralHandle ()
bool	IsAttachedTempGeneralHandle ()
void	DetachTempGeneralHandle ()
SoundPlayer *	GetSoundPlayer ()
void	SetSoundPlayer (SoundPlayer *player)
ExternalSoundPlayer *	GetExternalSoundPlayer ()
void	SetExternalSoundPlayer (ExternalSoundPlayer *extPlayer)
AmbientParamUpdateCallback *	GetAmbientParamUpdateCallback ()
AmbientArgUpdateCallback *	GetAmbientArgUpdateCallback ()
void	ClearAmbientArgUpdateCallback ()
AmbientArgAllocaterCallback *	GetAmbientArgAllocaterCallback ()
void *	GetAmbientArg ()
SoundParam &	GetAmbientParam ()
void	SetAmbientParamCallback (AmbientParamUpdateCallback *paramUpdateCallback, AmbientArgUpdateCallback *argUpdateCallback, AmbientArgAllocaterCallback *argAllocaterCallback, void *callbackArg)
void	SetPriority (int priority)
u32	GetId () const
void	SetId (u32 id)
f32	GetMoveVolume ()
f32	GetInitialVolume () const
f32	GetPan () const
f32	GetSurroundPan () const
f32	GetPitch () const
f32	GetVolume () const
void	SetOutputLine (int flag)
bool	IsEnabledOutputLine () const
int	GetOutputLine () const
f32	GetMainOutVolume () const
void	SetMainOutVolume (f32 volume)
f32	GetRemoteOutVolume (int remote) const
void	SetRemoteOutVolume (int remote, f32 volume)
void	SetFxSend (AuxBus bus, f32 send)
int	CalcCurrentPlayerPriority () const

Public Attributes
	NW4HBM_UT_RUNTIME_TYPEINFO
Public Attributes inherited from nw4hbm::snd::detail::BasicSound
	NW4HBM_UT_RUNTIME_TYPEINFO
ut::LinkListNode	mPriorityLink
ut::LinkListNode	mSoundPlayerPlayLink
ut::LinkListNode	mSoundPlayerPriorityLink
ut::LinkListNode	mExtSoundPlayerPlayLink

Private Attributes
WsdPlayer	mWsdPlayer
WaveSoundHandle *	mTempSpecialHandle
SoundInstanceManager< WaveSound > *	mManager

Friends
class	WaveSoundHandle

Additional Inherited Members
Public Types inherited from nw4hbm::snd::detail::BasicSound
typedef struct nw4hbm::snd::detail::BasicSound::AmbientParamUpdateCallback	AmbientParamUpdateCallback
typedef struct nw4hbm::snd::detail::BasicSound::AmbientArgUpdateCallback	AmbientArgUpdateCallback
typedef struct nw4hbm::snd::detail::BasicSound::AmbientArgAllocaterCallback	AmbientArgAllocaterCallback
typedef struct nw4hbm::snd::detail::BasicSound::AmbientArgInfo	AmbientArgInfo
Static Public Attributes inherited from nw4hbm::snd::detail::BasicSound
static const u32	INVALID_ID = 0xFFFFFFFF
static const int	PRIORITY_MAX = 127

Constructor & Destructor Documentation

WaveSound()

nw4hbm::snd::detail::WaveSound::WaveSound ( SoundInstanceManager< WaveSound > * manager )

explicit

Member Function Documentation

DetachTempSpecialHandle()

virtual void nw4hbm::snd::detail::WaveSound::DetachTempSpecialHandle ( )

virtual

Implements nw4hbm::snd::detail::BasicSound.

GetBasicPlayer() [1/2]

virtual BasicPlayer & nw4hbm::snd::detail::WaveSound::GetBasicPlayer ( )

inlinevirtual

Implements nw4hbm::snd::detail::BasicSound.

GetBasicPlayer() [2/2]

virtual const BasicPlayer & nw4hbm::snd::detail::WaveSound::GetBasicPlayer ( ) const

inlinevirtual

Implements nw4hbm::snd::detail::BasicSound.

IsAttachedTempSpecialHandle()

virtual bool nw4hbm::snd::detail::WaveSound::IsAttachedTempSpecialHandle ( )

virtual

Implements nw4hbm::snd::detail::BasicSound.

Prepare()

bool nw4hbm::snd::detail::WaveSound::Prepare	(	const void *	waveSoundBase,
		s32	waveSoundOffset,
		int	voices,
		const WsdTrack::WsdCallback *	callback,
		u32	callbackData )

SetChannelPriority()

void nw4hbm::snd::detail::WaveSound::SetChannelPriority

(

int

priority

)

SetPlayerPriority()

virtual void nw4hbm::snd::detail::WaveSound::SetPlayerPriority ( int priority )

virtual

Reimplemented from nw4hbm::snd::detail::BasicSound.

SetReleasePriorityFix()

void nw4hbm::snd::detail::WaveSound::SetReleasePriorityFix

(

bool

flag

)

Shutdown()

virtual void nw4hbm::snd::detail::WaveSound::Shutdown ( )

virtual

Reimplemented from nw4hbm::snd::detail::BasicSound.

Friends And Related Symbol Documentation

WaveSoundHandle

friend class WaveSoundHandle

friend

Member Data Documentation

mManager

SoundInstanceManager<WaveSound>* nw4hbm::snd::detail::WaveSound::mManager

private

mTempSpecialHandle

WaveSoundHandle* nw4hbm::snd::detail::WaveSound::mTempSpecialHandle

private

mWsdPlayer

WsdPlayer nw4hbm::snd::detail::WaveSound::mWsdPlayer

private

NW4HBM_UT_RUNTIME_TYPEINFO

nw4hbm::snd::detail::WaveSound::NW4HBM_UT_RUNTIME_TYPEINFO

---

The documentation for this class was generated from the following file:

• src/revolution/homebuttonLib/nw4hbm/snd/WaveSound.h