class MemorySoundArchive : public nw::snd::SoundArchive
This class handles sound archive data in memory.
The MemorySoundArchive class cannot handle data being referenced externally by a sound archive. The playback of externally referenced data will always fail.
If a sound archive contains waveform data (waveform archives), that sound archive must be loaded into device memory.
SoundType
|
Type of sound.(Inherited from SoundArchive. |
|---|
typedef Definitions
ItemId
|
A type that represents item IDs in sound archives.(Inherited from SoundArchive. |
|
|---|---|---|
FileId
|
A type that represents file IDs in sound archives.(Inherited from SoundArchive. |
|
StringId
|
A type that represents string IDs in sound archives.(Inherited from SoundArchive. |
| Other | |||
|---|---|---|---|
| S |
INVALID_ID
|
const ItemId | Represents an invalid ID.(Inherited from SoundArchive. |
| S |
SEQ_BANK_MAX
|
const u32 |
The maximum number of banks that can be associated with a sequence sound.(Inherited from SoundArchive. |
| Constructors/Destructors | ||
|---|---|---|
| MemorySoundArchive | Constructor. | |
| V | ~MemorySoundArchive | Destructor. |
| Setup | ||
Initialize
|
Initializes sound archive data in memory. | |
| Finalize | Finalizes sound archive data in memory. | |
| Status Retrieval | ||
| IsAvailable | Checks whether the data in the sound archive is usable.(Inherited from SoundArchive. |
|
| ID/Label character string | ||
GetSoundCount
|
Obtains the number of sounds in the sound archive.(Inherited from SoundArchive. |
|
GetGroupCount
|
Obtains the number of groups in the sound archive.(Inherited from SoundArchive. |
|
GetPlayerCount
|
Obtains the number of players in the sound archive.(Inherited from SoundArchive. |
|
GetBankCount
|
Gets the number of banks in the sound archive.(Inherited from SoundArchive. |
|
GetWaveArchiveCount
|
Gets the number of waveform archives in the sound archive.(Inherited from SoundArchive. |
|
GetItemLabel
|
Gets the label string that corresponds to an item ID.(Inherited from SoundArchive. |
|
GetItemId
|
Converts a label string into its corresponding item ID.(Inherited from SoundArchive. |
|
GetItemFileId
|
Gets the file ID that corresponds to an item ID.(Inherited from SoundArchive. |
|
| S | GetSoundIdFromIndex | Converts the sound serial number to a sound ID.(Inherited from SoundArchive. |
| S | GetBankIdFromIndex | Converts the bank serial number to a bank ID.(Inherited from SoundArchive. |
| S | GetPlayerIdFromIndex | Converts the player serial number to a player ID.(Inherited from SoundArchive. |
| S | GetWaveArchiveIdFromIndex | Converts the wave archive serial number to a wave archive ID.(Inherited from SoundArchive. |
| S | GetGroupIdFromIndex | Converts the group serial number to a group ID.(Inherited from SoundArchive. |
| Getting Information | ||
GetSoundUserParam
|
Gets the user parameter of the sound having the specified ID.(Inherited from SoundArchive. |
|
GetSoundType
|
Gets the sound having the specified ID.(Inherited from SoundArchive. |
|
ReadSoundInfo
|
Gets information for the sound having the specified ID.(Inherited from SoundArchive. |
|
ReadSequenceSoundInfo
|
Gets the information for the sequence sound having the specified ID.(Inherited from SoundArchive. |
|
ReadBankInfo
|
Gets bank information for the specified ID.(Inherited from SoundArchive. |
|
ReadPlayerInfo
|
Retrieves information for the player with the specified ID.(Inherited from SoundArchive. |
|
ReadSoundArchivePlayerInfo
|
Obtains sound archive player information.(Inherited from SoundArchive. |
|
ReadSound3DInfo
|
Gets 3D sound information for the specified ID.(Inherited from SoundArchive. |
|
| File Path | ||
SetExternalFileRoot
|
Sets the root directory for an external reference file.(Inherited from SoundArchive. |
|
nw::snd::SoundArchive
nw::snd::MemorySoundArchive
CONFIDENTIAL