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::RomSoundArchive</title> 49 </head> 50 <body> 51 <h1><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::RomSoundArchive Class</h1> 52 <div class="section"> 53 <b>Header file: </b>nw/snd/snd_RomSoundArchive.h</div> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class RomSoundArchive : public <a href="../../../nw/snd/SoundArchive/Overview.html">nw::snd::SoundArchive</a></pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>This class handles sound archive data in a ROM.</p> 61 </div> 62 <a name="enum" id="enum"> 63 <h2>Enumerated Types</h2> 64 <div class="section"> 65 <table class="members"> 66 <tr> 67 <td width="100"> </td> 68 <th> 69 <a href="../../../nw/snd/SoundArchive/SoundType.html"><CODE>SoundType</CODE></a> 70 </th> 71 <td>Type of sound.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 72 </tr> </table> 73 </div> 74 </a> <a name="typedef" id="typedef"> 75 <h2><CODE>typedef</CODE> Definitions</h2> 76 <div class="section"> 77 <table class="members"> 78 <tr> 79 <td width="100" /> 80 <th> 81 <a href="../../../nw/snd/SoundArchive/ItemId.html"><CODE>ItemId</CODE></a> 82 </th> 83 <td>A type that represents item IDs in sound archives.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 84 </tr> 85 <tr> 86 <td width="100" /> 87 <th> 88 <a href="../../../nw/snd/SoundArchive/FileId.html"><CODE>FileId</CODE></a> 89 </th> 90 <td>A type that represents file IDs in sound archives.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 91 </tr> 92 <tr> 93 <td width="100" /> 94 <th> 95 <a href="../../../nw/snd/SoundArchive/StringId.html"><CODE>StringId</CODE></a> 96 </th> 97 <td>A type that represents string IDs in sound archives.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 98 </tr> </table> 99 </div> 100 </a> <a name="constant" id="constant"> 101 <h2>Member Constants</h2> 102 <div class="section"> 103 <table class="members"> 104 <tr> 105 <th class="category" colspan="4">Other</th> 106 </tr> 107 <tr> 108 <td width="100"> 109 <span class="static_style" title="static">S</span> 110 </td> 111 <th> 112 <span class="argument"><a href="../../../nw/snd/SoundArchive/INVALID_ID.html"><CODE>INVALID_ID</CODE></a></span> 113 </th> 114 <td width="100">const <a href="../../../nw/snd/SoundArchive/ItemId.html">ItemId</a></td> 115 <td>Represents an invalid ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 116 </tr> 117 <tr> 118 <td width="100"> 119 <span class="static_style" title="static">S</span> 120 </td> 121 <th> 122 <span class="argument"><a href="../../../nw/snd/SoundArchive/SEQ_BANK_MAX.html"><CODE>SEQ_BANK_MAX</CODE></a></span> 123 </th> 124 <td width="100"><CODE>const <span>u32</span></CODE></td> 125 <td>The maximum number of banks that can be associated with a sequence sound.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 126 </tr> </table> 127 </div> 128 </a> <a name="function" id="function"> 129 <h2>Member Functions</h2> 130 <div class="section"> 131 <table class="members"> 132 <tr> 133 <th class="category" colspan="3">Constructors/Destructors</th> 134 </tr> 135 <tr> 136 <td width="100"> </td> 137 <th> 138 <a href="../../../nw/snd/RomSoundArchive/RomSoundArchive.html">RomSoundArchive</a> 139 </th> 140 <td>Constructor.</td> 141 </tr> 142 <tr> 143 <td width="100"> <span class="virtual_style" title="virtual">V</span> 144 </td> 145 <th> 146 <a href="../../../nw/snd/RomSoundArchive/~RomSoundArchive.html">~RomSoundArchive</a> 147 </th> 148 <td>Destructor.</td> 149 </tr> 150 <tr> 151 <th class="category" colspan="3">Open/Close</th> 152 </tr> 153 <tr> 154 <td width="100"> </td> 155 <th> 156 <a href="../../../nw/snd/RomSoundArchive/Open.html"><CODE>Open</CODE></a> 157 </th> 158 <td>Opens a sound archive file in ROM.</td> 159 </tr> 160 <tr> 161 <td width="100"> </td> 162 <th> 163 <a href="../../../nw/snd/RomSoundArchive/Close.html"><CODE>Close</CODE></a> 164 </th> 165 <td>Closes a sound archive file in ROM.</td> 166 </tr> 167 <tr> 168 <th class="category" colspan="3">Header</th> 169 </tr> 170 <tr> 171 <td width="100"> </td> 172 <th> 173 <a href="../../../nw/snd/RomSoundArchive/GetHeaderSize.html"><CODE>GetHeaderSize</CODE></a> 174 </th> 175 <td>Gets the size of the sound archive header.</td> 176 </tr> 177 <tr> 178 <td width="100"> </td> 179 <th> 180 <a href="../../../nw/snd/RomSoundArchive/LoadHeader.html">LoadHeader</a> 181 </th> 182 <td>Loads the header of the sound archive.</td> 183 </tr> 184 <tr> 185 <th class="category" colspan="3">Label String Data</th> 186 </tr> 187 <tr> 188 <td width="100"> </td> 189 <th> 190 <a href="../../../nw/snd/RomSoundArchive/GetLabelStringDataSize.html">GetLabelStringDataSize</a> 191 </th> 192 <td>Gets the size of the label string data in the sound archive.</td> 193 </tr> 194 <tr> 195 <td width="100"> </td> 196 <th> 197 <a href="../../../nw/snd/RomSoundArchive/LoadLabelStringData.html">LoadLabelStringData</a> 198 </th> 199 <td>Loads the label string data in the sound archive.</td> 200 </tr> 201 <tr> 202 <th class="category" colspan="3">Status Retrieval</th> 203 </tr> 204 <tr> 205 <td width="100"> </td> 206 <th> 207 <a href="../../../nw/snd/SoundArchive/IsAvailable.html">IsAvailable</a> 208 </th> 209 <td>Checks whether the data in the sound archive is usable.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 210 </tr> 211 <tr> 212 <th class="category" colspan="3">ID/Label character string</th> 213 </tr> 214 <tr> 215 <td width="100"> </td> 216 <th> 217 <a href="../../../nw/snd/SoundArchive/GetSoundCount.html"><CODE>GetSoundCount</CODE></a> 218 </th> 219 <td>Obtains the number of sounds in the sound archive.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 220 </tr> 221 <tr> 222 <td width="100"> </td> 223 <th> 224 <a href="../../../nw/snd/SoundArchive/GetGroupCount.html"><CODE>GetGroupCount</CODE></a> 225 </th> 226 <td>Obtains the number of groups in the sound archive.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 227 </tr> 228 <tr> 229 <td width="100"> </td> 230 <th> 231 <a href="../../../nw/snd/SoundArchive/GetPlayerCount.html"><CODE>GetPlayerCount</CODE></a> 232 </th> 233 <td>Obtains the number of players in the sound archive.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 234 </tr> 235 <tr> 236 <td width="100"> </td> 237 <th> 238 <a href="../../../nw/snd/SoundArchive/GetBankCount.html"><CODE>GetBankCount</CODE></a> 239 </th> 240 <td>Gets the number of banks in the sound archive.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 241 </tr> 242 <tr> 243 <td width="100"> </td> 244 <th> 245 <a href="../../../nw/snd/SoundArchive/GetWaveArchiveCount.html"><CODE>GetWaveArchiveCount</CODE></a> 246 </th> 247 <td>Gets the number of waveform archives in the sound archive.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 248 </tr> 249 <tr> 250 <td width="100"> </td> 251 <th> 252 <a href="../../../nw/snd/SoundArchive/GetItemLabel.html"><CODE>GetItemLabel</CODE></a> 253 </th> 254 <td>Gets the label string that corresponds to an item ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 255 </tr> 256 <tr> 257 <td width="100"> </td> 258 <th> 259 <a href="../../../nw/snd/SoundArchive/GetItemId.html"><CODE>GetItemId</CODE></a> 260 </th> 261 <td>Converts a label string into its corresponding item ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 262 </tr> 263 <tr> 264 <td width="100"> </td> 265 <th> 266 <a href="../../../nw/snd/SoundArchive/GetItemFileId.html"><CODE>GetItemFileId</CODE></a> 267 </th> 268 <td>Gets the file ID that corresponds to an item ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 269 </tr> 270 <tr> 271 <td width="100"> 272 <span class="static_style" title="static">S</span> </td> 273 <th> 274 <a href="../../../nw/snd/SoundArchive/GetSoundIdFromIndex.html">GetSoundIdFromIndex</a> 275 </th> 276 <td>Converts the sound serial number to a sound ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 277 </tr> 278 <tr> 279 <td width="100"> 280 <span class="static_style" title="static">S</span> </td> 281 <th> 282 <a href="../../../nw/snd/SoundArchive/GetBankIdFromIndex.html">GetBankIdFromIndex</a> 283 </th> 284 <td>Converts the bank serial number to a bank ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 285 </tr> 286 <tr> 287 <td width="100"> 288 <span class="static_style" title="static">S</span> </td> 289 <th> 290 <a href="../../../nw/snd/SoundArchive/GetPlayerIdFromIndex.html">GetPlayerIdFromIndex</a> 291 </th> 292 <td>Converts the player serial number to a player ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 293 </tr> 294 <tr> 295 <td width="100"> 296 <span class="static_style" title="static">S</span> </td> 297 <th> 298 <a href="../../../nw/snd/SoundArchive/GetWaveArchiveIdFromIndex.html">GetWaveArchiveIdFromIndex</a> 299 </th> 300 <td>Converts the wave archive serial number to a wave archive ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 301 </tr> 302 <tr> 303 <td width="100"> 304 <span class="static_style" title="static">S</span> </td> 305 <th> 306 <a href="../../../nw/snd/SoundArchive/GetGroupIdFromIndex.html">GetGroupIdFromIndex</a> 307 </th> 308 <td>Converts the group serial number to a group ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 309 </tr> 310 <tr> 311 <th class="category" colspan="3">Getting Information</th> 312 </tr> 313 <tr> 314 <td width="100"> </td> 315 <th> 316 <a href="../../../nw/snd/SoundArchive/GetSoundUserParam.html"><CODE>GetSoundUserParam</CODE></a> 317 </th> 318 <td>Gets the user parameter of the sound having the specified ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 319 </tr> 320 <tr> 321 <td width="100"> </td> 322 <th> 323 <a href="../../../nw/snd/SoundArchive/GetSoundType.html"><CODE>GetSoundType</CODE></a> 324 </th> 325 <td>Gets the sound having the specified ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 326 </tr> 327 <tr> 328 <td width="100"> </td> 329 <th> 330 <a href="../../../nw/snd/SoundArchive/ReadSoundInfo.html"><CODE>ReadSoundInfo</CODE></a> 331 </th> 332 <td>Gets information for the sound having the specified ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 333 </tr> 334 <tr> 335 <td width="100"> </td> 336 <th> 337 <a href="../../../nw/snd/SoundArchive/ReadSequenceSoundInfo.html"><CODE>ReadSequenceSoundInfo</CODE></a> 338 </th> 339 <td>Gets the information for the sequence sound having the specified ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 340 </tr> 341 <tr> 342 <td width="100"> </td> 343 <th> 344 <a href="../../../nw/snd/SoundArchive/ReadBankInfo.html"><CODE>ReadBankInfo</CODE></a> 345 </th> 346 <td>Gets bank information for the specified ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 347 </tr> 348 <tr> 349 <td width="100"> </td> 350 <th> 351 <a href="../../../nw/snd/SoundArchive/ReadPlayerInfo.html"><CODE>ReadPlayerInfo</CODE></a> 352 </th> 353 <td>Retrieves information for the player with the specified ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 354 </tr> 355 <tr> 356 <td width="100"> </td> 357 <th> 358 <a href="../../../nw/snd/SoundArchive/ReadSoundArchivePlayerInfo.html"><CODE>ReadSoundArchivePlayerInfo</CODE></a> 359 </th> 360 <td>Obtains sound archive player information.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 361 </tr> 362 <tr> 363 <td width="100"> </td> 364 <th> 365 <a href="../../../nw/snd/SoundArchive/ReadSound3DInfo.html"><CODE>ReadSound3DInfo</CODE></a> 366 </th> 367 <td>Gets 3D sound information for the specified ID.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 368 </tr> 369 <tr> 370 <th class="category" colspan="3">File Path</th> 371 </tr> 372 <tr> 373 <td width="100"> </td> 374 <th> 375 <a href="../../../nw/snd/SoundArchive/SetExternalFileRoot.html"><CODE>SetExternalFileRoot</CODE></a> 376 </th> 377 <td>Sets the root directory for an external reference file.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.</td> 378 </tr> </table> 379 </div> 380 </a> 381 <h2>Class Hierarchy</h2> 382 <div class="section"> 383 <p class="hierarchy"><a href="../../../nw/snd/SoundArchive/Overview.html">nw::snd::SoundArchive</a><br /> <b>nw::snd::RomSoundArchive</b> 384 </p> 385 </div> 386 <h2>See Also</h2> 387 <div class="section"> 388 <p class="reference"><a href="../../../nw/snd/SoundArchivePlayer/Overview.html"><CODE>SoundArchive</CODE></a> Class<br /> </p> 389 </div> 390 <h2>Revision History</h2> 391 <div class="section"> 392 <dl class="history"> 393 <dt>2010/01/15</dt> 394 <dd>Initial version.<br /> 395 </dd> 396 </dl> 397 </div> 398 <hr><p>CONFIDENTIAL</p></body> 399</html> 400