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