class SoundArchive
A class that handles sound archives.
You cannot use this class directly. Use one of the derived classes RomSoundArchive or MemorySoundArchive.
| nw::snd::SoundArchive::BankInfo | Structure that stores bank settings. |
|---|---|
| nw::snd::SoundArchive::PlayerInfo | Structure storing settings information for a player. |
| nw::snd::SoundArchive::SequenceSoundInfo | This structure stores setup information for the sequence sound. |
| nw::snd::SoundArchive::Sound3DInfo | Structure storing a sound's 3D sound setting information. |
| nw::snd::SoundArchive::SoundArchivePlayerInfo | Structure storing settings information for a sound archive player. |
| nw::snd::SoundArchive::SoundInfo | Structure storing a sound's settings information. |
SoundType
|
Type of sound. |
|---|
typedef Definitions
ItemId
|
A type that represents item IDs in sound archives. | |
|---|---|---|
FileId
|
A type that represents file IDs in sound archives. | |
StringId
|
A type that represents string IDs in sound archives. |
| Other | ||
|---|---|---|
| S |
INVALID_ID
|
Represents an invalid ID. |
| S |
SEQ_BANK_MAX
|
The maximum number of banks that can be associated with a sequence sound. |
| Getting Information | ||
|---|---|---|
GetSoundUserParam
|
Gets the user parameter of the sound having the specified ID. | |
GetSoundType
|
Gets the sound having the specified ID. | |
ReadSoundInfo
|
Gets information for the sound having the specified ID. | |
ReadSequenceSoundInfo
|
Gets the information for the sequence sound having the specified ID. | |
ReadBankInfo
|
Gets bank information for the specified ID. | |
ReadPlayerInfo
|
Retrieves information for the player with the specified ID. | |
ReadSoundArchivePlayerInfo
|
Obtains sound archive player information. | |
ReadSound3DInfo
|
Gets 3D sound information for the specified ID. | |
| Constructors/Destructors | ||
| protected | SoundArchive | Constructor. |
| V | ~SoundArchive | Destructor. |
| Status Retrieval | ||
| IsAvailable | Checks whether the data in the sound archive is usable. | |
| ID/Label character string | ||
GetSoundCount
|
Obtains the number of sounds in the sound archive. | |
GetGroupCount
|
Obtains the number of groups in the sound archive. | |
GetPlayerCount
|
Obtains the number of players in the sound archive. | |
GetBankCount
|
Gets the number of banks in the sound archive. | |
GetWaveArchiveCount
|
Gets the number of waveform archives in the sound archive. | |
GetItemLabel
|
Gets the label string that corresponds to an item ID. | |
GetItemId
|
Converts a label string into its corresponding item ID. | |
GetItemFileId
|
Gets the file ID that corresponds to an item ID. | |
| S | GetSoundIdFromIndex | Converts the sound serial number to a sound ID. |
| S | GetBankIdFromIndex | Converts the bank serial number to a bank ID. |
| S | GetPlayerIdFromIndex | Converts the player serial number to a player ID. |
| S | GetWaveArchiveIdFromIndex | Converts the wave archive serial number to a wave archive ID. |
| S | GetGroupIdFromIndex | Converts the group serial number to a group ID. |
| File Path | ||
SetExternalFileRoot
|
Sets the root directory for an external reference file. | |
CONFIDENTIAL