Twilight Princess
Decompilation of The Legend of Zelda: Twilight Princess
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Private Member Functions | List of all members
nw4hbm::snd::SoundStartable Class Referenceabstract

#include <SoundStartable.h>

+ Inheritance diagram for nw4hbm::snd::SoundStartable:

Classes

struct  StartInfo
 

Public Types

enum  StartResult {
  START_SUCCESS = 0 , START_ERR_LOW_PRIORITY , START_ERR_INVALID_LABEL_STRING , START_ERR_INVALID_SOUNDID ,
  START_ERR_NOT_DATA_LOADED , START_ERR_NOT_ENOUGH_PLAYER_HEAP , START_ERR_CANNOT_OPEN_FILE , START_ERR_NOT_AVAILABLE ,
  START_ERR_CANNOT_ALLOCATE_TRACK , START_ERR_NOT_ENOUGH_INSTANCE , START_ERR_INVALID_PARAMETER , START_ERR_INVALID_SEQ_START_LOCATION_LABEL ,
  START_ERR_USER = 128 , START_ERR_UNKNOWN = 255
}
 
typedef enum nw4hbm::snd::SoundStartable::StartResult StartResult
 
typedef struct nw4hbm::snd::SoundStartable::StartInfo StartInfo
 

Public Member Functions

virtual ~SoundStartable ()
 
virtual StartResult detail_SetupSound (SoundHandle *soundHandle, u32 id, detail::BasicSound::AmbientArgInfo *ambientArgInfo, detail::ExternalSoundPlayer *extPlayer, bool hold, const StartInfo *startInfo)=0
 
virtual u32 detail_ConvertLabelStringToSoundId (const char *label)=0
 
bool StartSound (SoundHandle *soundHandle, u32 id)
 
bool StartSound (SoundHandle *soundHandle, unsigned int id)
 
bool StartSound (SoundHandle *soundHandle, int id)
 
bool HoldSound (SoundHandle *soundHandle, u32 id)
 
bool HoldSound (SoundHandle *soundHandle, unsigned int id)
 
bool HoldSound (SoundHandle *soundHandle, int id)
 
bool PrepareSound (SoundHandle *soundHandle, u32 id)
 
bool PrepareSound (SoundHandle *soundHandle, unsigned int id)
 
bool PrepareSound (SoundHandle *soundHandle, int id)
 

Private Member Functions

StartResult detail_StartSound (SoundHandle *soundHandle, u32 id, detail::BasicSound::AmbientArgInfo *ambientArgInfo, detail::ExternalSoundPlayer *extPlayer, const StartInfo *startInfo)
 
StartResult detail_HoldSound (SoundHandle *soundHandle, u32 id, detail::BasicSound::AmbientArgInfo *ambientArgInfo, detail::ExternalSoundPlayer *extPlayer, const StartInfo *startInfo)
 
StartResult detail_PrepareSound (SoundHandle *soundHandle, u32 id, detail::BasicSound::AmbientArgInfo *ambientArgInfo, detail::ExternalSoundPlayer *extPlayer, const StartInfo *startInfo)
 

Member Typedef Documentation

◆ StartInfo

struct nw4hbm::snd::SoundStartable::StartInfo nw4hbm::snd::SoundStartable::StartInfo

◆ StartResult

enum nw4hbm::snd::SoundStartable::StartResult nw4hbm::snd::SoundStartable::StartResult

Member Enumeration Documentation

◆ StartResult

enum nw4hbm::snd::SoundStartable::StartResult
Enumerator
START_SUCCESS 
START_ERR_LOW_PRIORITY 
START_ERR_INVALID_LABEL_STRING 
START_ERR_INVALID_SOUNDID 
START_ERR_NOT_DATA_LOADED 
START_ERR_NOT_ENOUGH_PLAYER_HEAP 
START_ERR_CANNOT_OPEN_FILE 
START_ERR_NOT_AVAILABLE 
START_ERR_CANNOT_ALLOCATE_TRACK 
START_ERR_NOT_ENOUGH_INSTANCE 
START_ERR_INVALID_PARAMETER 
START_ERR_INVALID_SEQ_START_LOCATION_LABEL 
START_ERR_USER 
START_ERR_UNKNOWN 

Constructor & Destructor Documentation

◆ ~SoundStartable()

virtual nw4hbm::snd::SoundStartable::~SoundStartable ( )
inlinevirtual

Member Function Documentation

◆ detail_ConvertLabelStringToSoundId()

virtual u32 nw4hbm::snd::SoundStartable::detail_ConvertLabelStringToSoundId ( const char * label)
pure virtual

Implemented in nw4hbm::snd::SoundArchivePlayer.

◆ detail_HoldSound()

StartResult nw4hbm::snd::SoundStartable::detail_HoldSound ( SoundHandle * soundHandle,
u32 id,
detail::BasicSound::AmbientArgInfo * ambientArgInfo,
detail::ExternalSoundPlayer * extPlayer,
const StartInfo * startInfo )
private

◆ detail_PrepareSound()

StartResult nw4hbm::snd::SoundStartable::detail_PrepareSound ( SoundHandle * soundHandle,
u32 id,
detail::BasicSound::AmbientArgInfo * ambientArgInfo,
detail::ExternalSoundPlayer * extPlayer,
const StartInfo * startInfo )
private

◆ detail_SetupSound()

virtual StartResult nw4hbm::snd::SoundStartable::detail_SetupSound ( SoundHandle * soundHandle,
u32 id,
detail::BasicSound::AmbientArgInfo * ambientArgInfo,
detail::ExternalSoundPlayer * extPlayer,
bool hold,
const StartInfo * startInfo )
pure virtual

Implemented in nw4hbm::snd::SoundArchivePlayer.

◆ detail_StartSound()

SoundStartable::StartResult nw4hbm::snd::SoundStartable::detail_StartSound ( SoundHandle * soundHandle,
u32 id,
detail::BasicSound::AmbientArgInfo * ambientArgInfo,
detail::ExternalSoundPlayer * extPlayer,
const StartInfo * startInfo )
private

◆ HoldSound() [1/3]

bool nw4hbm::snd::SoundStartable::HoldSound ( SoundHandle * soundHandle,
int id )
inline

◆ HoldSound() [2/3]

bool nw4hbm::snd::SoundStartable::HoldSound ( SoundHandle * soundHandle,
u32 id )
inline

◆ HoldSound() [3/3]

bool nw4hbm::snd::SoundStartable::HoldSound ( SoundHandle * soundHandle,
unsigned int id )
inline

◆ PrepareSound() [1/3]

bool nw4hbm::snd::SoundStartable::PrepareSound ( SoundHandle * soundHandle,
int id )
inline

◆ PrepareSound() [2/3]

bool nw4hbm::snd::SoundStartable::PrepareSound ( SoundHandle * soundHandle,
u32 id )
inline

◆ PrepareSound() [3/3]

bool nw4hbm::snd::SoundStartable::PrepareSound ( SoundHandle * soundHandle,
unsigned int id )
inline

◆ StartSound() [1/3]

bool nw4hbm::snd::SoundStartable::StartSound ( SoundHandle * soundHandle,
int id )
inline

◆ StartSound() [2/3]

bool nw4hbm::snd::SoundStartable::StartSound ( SoundHandle * soundHandle,
u32 id )
inline

◆ StartSound() [3/3]

bool nw4hbm::snd::SoundStartable::StartSound ( SoundHandle * soundHandle,
unsigned int id )
inline
The documentation for this class was generated from the following files: