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