1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48 <title>nw::snd::SoundArchive</title> 49 </head> 50 <body> 51 <h1><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::SoundArchive Class</h1> 52 <div class="section"> 53 <b>Header file: </b>nw/snd/snd_SoundArchive.h</div> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class SoundArchive</pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>A class that handles sound archives.</p><p>You cannot use this class directly. Use one of the derived classes <span><span>RomSoundArchive</span></span> or <span><span>MemorySoundArchive</span></span>.</p></div> 61 <a name="struct" id="struct"> 62 <h2>Structures</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <th> 67 <a href="../../../nw/snd/SoundArchive/BankInfo/Overview.html">nw::snd::SoundArchive::BankInfo</a> 68 </th> 69 <td>Structure that stores bank settings.</td> 70 </tr> 71 <tr> 72 <th> 73 <a href="../../../nw/snd/SoundArchive/PlayerInfo/Overview.html">nw::snd::SoundArchive::PlayerInfo</a> 74 </th> 75 <td>Structure storing settings information for a player.</td> 76 </tr> 77 <tr> 78 <th> 79 <a href="../../../nw/snd/SoundArchive/SequenceSoundInfo/Overview.html">nw::snd::SoundArchive::SequenceSoundInfo</a> 80 </th> 81 <td>This structure stores setup information for the sequence sound.</td> 82 </tr> 83 <tr> 84 <th> 85 <a href="../../../nw/snd/SoundArchive/Sound3DInfo/Overview.html">nw::snd::SoundArchive::Sound3DInfo</a> 86 </th> 87 <td>Structure storing a sound's 3D sound setting information.</td> 88 </tr> 89 <tr> 90 <th> 91 <a href="../../../nw/snd/SoundArchive/SoundArchivePlayerInfo/Overview.html">nw::snd::SoundArchive::SoundArchivePlayerInfo</a> 92 </th> 93 <td>Structure storing settings information for a sound archive player.</td> 94 </tr> 95 <tr> 96 <th> 97 <a href="../../../nw/snd/SoundArchive/SoundInfo/Overview.html">nw::snd::SoundArchive::SoundInfo</a> 98 </th> 99 <td>Structure storing a sound's settings information.</td> 100 </tr> </table> 101 </div> 102 </a> <a name="enum" id="enum"> 103 <h2>Enumerated Types</h2> 104 <div class="section"> 105 <table class="members"> 106 <tr> 107 <td width="100"> </td> 108 <th> 109 <a href="../../../nw/snd/SoundArchive/SoundType.html"><CODE>SoundType</CODE></a> 110 </th> 111 <td>Type of sound.</td> 112 </tr> </table> 113 </div> 114 </a> <a name="typedef" id="typedef"> 115 <h2><CODE>typedef</CODE> Definitions</h2> 116 <div class="section"> 117 <table class="members"> 118 <tr> 119 <td width="100" /> 120 <th> 121 <a href="../../../nw/snd/SoundArchive/ItemId.html"><CODE>ItemId</CODE></a> 122 </th> 123 <td>A type that represents item IDs in sound archives.</td> 124 </tr> 125 <tr> 126 <td width="100" /> 127 <th> 128 <a href="../../../nw/snd/SoundArchive/FileId.html"><CODE>FileId</CODE></a> 129 </th> 130 <td>A type that represents file IDs in sound archives.</td> 131 </tr> 132 <tr> 133 <td width="100" /> 134 <th> 135 <a href="../../../nw/snd/SoundArchive/StringId.html"><CODE>StringId</CODE></a> 136 </th> 137 <td>A type that represents string IDs in sound archives.</td> 138 </tr> </table> 139 </div> 140 </a> <a name="constant" id="constant"> 141 <h2>Member Constants</h2> 142 <div class="section"> 143 <table class="members"> 144 <tr> 145 <th class="category" colspan="4">Other</th> 146 </tr> 147 <tr> 148 <td width="100"> 149 <span class="static_style" title="static">S</span> 150 </td> 151 <th> 152 <span class="argument"><a href="../../../nw/snd/SoundArchive/INVALID_ID.html"><CODE>INVALID_ID</CODE></a></span> 153 </th> 154 <td width="100">const <a href="../../../nw/snd/SoundArchive/ItemId.html">ItemId</a></td> 155 <td>Represents an invalid ID.</td> 156 </tr> 157 <tr> 158 <td width="100"> 159 <span class="static_style" title="static">S</span> 160 </td> 161 <th> 162 <span class="argument"><a href="../../../nw/snd/SoundArchive/SEQ_BANK_MAX.html"><CODE>SEQ_BANK_MAX</CODE></a></span> 163 </th> 164 <td width="100"><CODE>const <span>u32</span></CODE></td> 165 <td>The maximum number of banks that can be associated with a sequence sound.</td> 166 </tr> </table> 167 </div> 168 </a> <a name="function" id="function"> 169 <h2>Member Functions</h2> 170 <div class="section"> 171 <table class="members"> 172 <tr> 173 <th class="category" colspan="3">Getting Information</th> 174 </tr> 175 <tr> 176 <td width="100"> </td> 177 <th> 178 <a href="../../../nw/snd/SoundArchive/GetSoundUserParam.html"><CODE>GetSoundUserParam</CODE></a> 179 </th> 180 <td>Gets the user parameter of the sound having the specified ID.</td> 181 </tr> 182 <tr> 183 <td width="100"> </td> 184 <th> 185 <a href="../../../nw/snd/SoundArchive/GetSoundType.html"><CODE>GetSoundType</CODE></a> 186 </th> 187 <td>Gets the sound having the specified ID.</td> 188 </tr> 189 <tr> 190 <td width="100"> </td> 191 <th> 192 <a href="../../../nw/snd/SoundArchive/ReadSoundInfo.html"><CODE>ReadSoundInfo</CODE></a> 193 </th> 194 <td>Gets information for the sound having the specified ID.</td> 195 </tr> 196 <tr> 197 <td width="100"> </td> 198 <th> 199 <a href="../../../nw/snd/SoundArchive/ReadSequenceSoundInfo.html"><CODE>ReadSequenceSoundInfo</CODE></a> 200 </th> 201 <td>Gets the information for the sequence sound having the specified ID.</td> 202 </tr> 203 <tr> 204 <td width="100"> </td> 205 <th> 206 <a href="../../../nw/snd/SoundArchive/ReadBankInfo.html"><CODE>ReadBankInfo</CODE></a> 207 </th> 208 <td>Gets bank information for the specified ID.</td> 209 </tr> 210 <tr> 211 <td width="100"> </td> 212 <th> 213 <a href="../../../nw/snd/SoundArchive/ReadPlayerInfo.html"><CODE>ReadPlayerInfo</CODE></a> 214 </th> 215 <td>Retrieves information for the player with the specified ID.</td> 216 </tr> 217 <tr> 218 <td width="100"> </td> 219 <th> 220 <a href="../../../nw/snd/SoundArchive/ReadSoundArchivePlayerInfo.html"><CODE>ReadSoundArchivePlayerInfo</CODE></a> 221 </th> 222 <td>Obtains sound archive player information.</td> 223 </tr> 224 <tr> 225 <td width="100"> </td> 226 <th> 227 <a href="../../../nw/snd/SoundArchive/ReadSound3DInfo.html"><CODE>ReadSound3DInfo</CODE></a> 228 </th> 229 <td>Gets 3D sound information for the specified ID.</td> 230 </tr> 231 <tr> 232 <th class="category" colspan="3">Constructors/Destructors</th> 233 </tr> 234 <tr> 235 <td width="100"> 236 <span class="protected_style" title="protected">protected</span> </td> 237 <th> 238 <a href="../../../nw/snd/SoundArchive/SoundArchive.html">SoundArchive</a> 239 </th> 240 <td>Constructor.</td> 241 </tr> 242 <tr> 243 <td width="100"> <span class="virtual_style" title="virtual">V</span> 244 </td> 245 <th> 246 <a href="../../../nw/snd/SoundArchive/~SoundArchive.html">~SoundArchive</a> 247 </th> 248 <td>Destructor.</td> 249 </tr> 250 <tr> 251 <th class="category" colspan="3">Status Retrieval</th> 252 </tr> 253 <tr> 254 <td width="100"> </td> 255 <th> 256 <a href="../../../nw/snd/SoundArchive/IsAvailable.html">IsAvailable</a> 257 </th> 258 <td>Checks whether the data in the sound archive is usable.</td> 259 </tr> 260 <tr> 261 <th class="category" colspan="3">ID/Label character string</th> 262 </tr> 263 <tr> 264 <td width="100"> </td> 265 <th> 266 <a href="../../../nw/snd/SoundArchive/GetSoundCount.html"><CODE>GetSoundCount</CODE></a> 267 </th> 268 <td>Obtains the number of sounds in the sound archive.</td> 269 </tr> 270 <tr> 271 <td width="100"> </td> 272 <th> 273 <a href="../../../nw/snd/SoundArchive/GetGroupCount.html"><CODE>GetGroupCount</CODE></a> 274 </th> 275 <td>Obtains the number of groups in the sound archive.</td> 276 </tr> 277 <tr> 278 <td width="100"> </td> 279 <th> 280 <a href="../../../nw/snd/SoundArchive/GetPlayerCount.html"><CODE>GetPlayerCount</CODE></a> 281 </th> 282 <td>Obtains the number of players in the sound archive.</td> 283 </tr> 284 <tr> 285 <td width="100"> </td> 286 <th> 287 <a href="../../../nw/snd/SoundArchive/GetBankCount.html"><CODE>GetBankCount</CODE></a> 288 </th> 289 <td>Gets the number of banks in the sound archive.</td> 290 </tr> 291 <tr> 292 <td width="100"> </td> 293 <th> 294 <a href="../../../nw/snd/SoundArchive/GetWaveArchiveCount.html"><CODE>GetWaveArchiveCount</CODE></a> 295 </th> 296 <td>Gets the number of waveform archives in the sound archive.</td> 297 </tr> 298 <tr> 299 <td width="100"> </td> 300 <th> 301 <a href="../../../nw/snd/SoundArchive/GetItemLabel.html"><CODE>GetItemLabel</CODE></a> 302 </th> 303 <td>Gets the label string that corresponds to an item ID.</td> 304 </tr> 305 <tr> 306 <td width="100"> </td> 307 <th> 308 <a href="../../../nw/snd/SoundArchive/GetItemId.html"><CODE>GetItemId</CODE></a> 309 </th> 310 <td>Converts a label string into its corresponding item ID.</td> 311 </tr> 312 <tr> 313 <td width="100"> </td> 314 <th> 315 <a href="../../../nw/snd/SoundArchive/GetItemFileId.html"><CODE>GetItemFileId</CODE></a> 316 </th> 317 <td>Gets the file ID that corresponds to an item ID.</td> 318 </tr> 319 <tr> 320 <td width="100"> 321 <span class="static_style" title="static">S</span> </td> 322 <th> 323 <a href="../../../nw/snd/SoundArchive/GetSoundIdFromIndex.html">GetSoundIdFromIndex</a> 324 </th> 325 <td>Converts the sound serial number to a sound ID.</td> 326 </tr> 327 <tr> 328 <td width="100"> 329 <span class="static_style" title="static">S</span> </td> 330 <th> 331 <a href="../../../nw/snd/SoundArchive/GetBankIdFromIndex.html">GetBankIdFromIndex</a> 332 </th> 333 <td>Converts the bank serial number to a bank ID.</td> 334 </tr> 335 <tr> 336 <td width="100"> 337 <span class="static_style" title="static">S</span> </td> 338 <th> 339 <a href="../../../nw/snd/SoundArchive/GetPlayerIdFromIndex.html">GetPlayerIdFromIndex</a> 340 </th> 341 <td>Converts the player serial number to a player ID.</td> 342 </tr> 343 <tr> 344 <td width="100"> 345 <span class="static_style" title="static">S</span> </td> 346 <th> 347 <a href="../../../nw/snd/SoundArchive/GetWaveArchiveIdFromIndex.html">GetWaveArchiveIdFromIndex</a> 348 </th> 349 <td>Converts the wave archive serial number to a wave archive ID.</td> 350 </tr> 351 <tr> 352 <td width="100"> 353 <span class="static_style" title="static">S</span> </td> 354 <th> 355 <a href="../../../nw/snd/SoundArchive/GetGroupIdFromIndex.html">GetGroupIdFromIndex</a> 356 </th> 357 <td>Converts the group serial number to a group ID.</td> 358 </tr> 359 <tr> 360 <th class="category" colspan="3">File Path</th> 361 </tr> 362 <tr> 363 <td width="100"> </td> 364 <th> 365 <a href="../../../nw/snd/SoundArchive/SetExternalFileRoot.html"><CODE>SetExternalFileRoot</CODE></a> 366 </th> 367 <td>Sets the root directory for an external reference file.</td> 368 </tr> </table> 369 </div> 370 </a> 371 <h2>See Also</h2> 372 <div class="section"> 373 <p class="reference"><a href="../../../nw/snd/RomSoundArchive/Overview.html">RomSoundArchive</a><br /><a href="../../../nw/snd/MemorySoundArchive/Overview.html">MemorySoundArchive</a><br /> </p> 374 </div> 375 <h2>Revision History</h2> 376 <div class="section"> 377 <dl class="history"> 378 <dt>2010/02/23</dt> 379 <dd>Added headers.<br /> 380 </dd> 381 <dt>2010/01/29</dt> 382 <dd>Added See Also.<br /> 383 </dd> 384 <dt>2010/01/15</dt> 385 <dd>Initial version.<br /> 386 </dd> 387 </dl> 388 </div> 389 <hr><p>CONFIDENTIAL</p></body> 390</html> 391