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</title> 49 </head> 50 <body> 51 <h1><a href="../../nw/Overview.html">nw</a>::snd Namespace</h1> 52 <h2>Description</h2> 53 <div class="section"> 54 <p>Namespace for the sound library. See the <I>Sound Programmer's Guide</I> in conjunction with this documentation.</p> 55 </div> 56 <a name="class" id="class"> 57 <h2>Classes</h2> 58 <div class="section"> 59 <table class="members"> 60 <tr> 61 <th> 62 <a href="../../nw/snd/BiquadFilterCallback/Overview.html">nw::snd::BiquadFilterCallback</a> 63 </th> 64 <td>An abstract class that represents a biquad filter.</td> 65 </tr> 66 <tr> 67 <th> 68 <a href="../../nw/snd/FxBase/Overview.html"><CODE>nw::snd::FxBase</CODE></a> 69 </th> 70 <td>Abstract class for effects.</td> 71 </tr> 72 <tr> 73 <th> 74 <a href="../../nw/snd/FxDelay/Overview.html">nw::snd::FxDelay</a> 75 </th> 76 <td>The delay effect class.</td> 77 </tr> 78 <tr> 79 <th> 80 <a href="../../nw/snd/FxReverb/Overview.html">nw::snd::FxReverb</a> 81 </th> 82 <td>Reverb effect class.</td> 83 </tr> 84 <tr> 85 <th> 86 <a href="../../nw/snd/HioSoundArchive/Overview.html">nw::snd::HioSoundArchive</a> 87 </th> 88 <td>This class handles sound archive data stored on the host PC.</td> 89 </tr> 90 <tr> 91 <th> 92 <a href="../../nw/snd/MemorySoundArchive/Overview.html"><CODE>nw::snd::MemorySoundArchive</CODE></a> 93 </th> 94 <td>This class handles sound archive data in memory.</td> 95 </tr> 96 <tr> 97 <th> 98 <a href="../../nw/snd/RomSoundArchive/Overview.html"><CODE>nw::snd::RomSoundArchive</CODE></a> 99 </th> 100 <td>This class handles sound archive data in a ROM.</td> 101 </tr> 102 <tr> 103 <th> 104 <a href="../../nw/snd/SequenceSoundHandle/Overview.html"><CODE>nw::snd::SequenceSoundHandle</CODE></a> 105 </th> 106 <td>A handle class used to control sequence sounds that are played back.</td> 107 </tr> 108 <tr> 109 <th> 110 <a href="../../nw/snd/Sound3DActor/Overview.html"><CODE>nw::snd::Sound3DActor</CODE></a> 111 </th> 112 <td>A 3D sound actor class used to represent an audio source within a 3D space.</td> 113 </tr> 114 <tr> 115 <th> 116 <a href="../../nw/snd/Sound3DCalculator/Overview.html"><CODE>nw::snd::Sound3DCalculator</CODE></a> 117 </th> 118 <td>A class that consolidates standard parameter calculations for 3D sound.</td> 119 </tr> 120 <tr> 121 <th> 122 <a href="../../nw/snd/Sound3DEngine/Overview.html"><CODE>nw::snd::Sound3DEngine</CODE></a> 123 </th> 124 <td>A parameter calculation engine class for 3D sounds.</td> 125 </tr> 126 <tr> 127 <th> 128 <a href="../../nw/snd/Sound3DListener/Overview.html"><CODE>nw::snd::Sound3DListener</CODE></a> 129 </th> 130 <td>A 3D sound listener class used to represent a listening point within a 3D space.</td> 131 </tr> 132 <tr> 133 <th> 134 <a href="../../nw/snd/Sound3DManager/Overview.html">nw::snd::Sound3DManager</a> 135 </th> 136 <td>A class used to calculate and manage 3D sound parameters.</td> 137 </tr> 138 <tr> 139 <th> 140 <a href="../../nw/snd/SoundActor/Overview.html"><CODE>nw::snd::SoundActor</CODE></a> 141 </th> 142 <td>A class used to play back and manage multiple sounds together.</td> 143 </tr> 144 <tr> 145 <th> 146 <a href="../../nw/snd/SoundArchive/Overview.html"><CODE>nw::snd::SoundArchive</CODE></a> 147 </th> 148 <td>A class that handles sound archives.</td> 149 </tr> 150 <tr> 151 <th> 152 <a href="../../nw/snd/SoundArchivePlayer/Overview.html"><CODE>nw::snd::SoundArchivePlayer</CODE></a> 153 </th> 154 <td>A class that plays back sounds in a sound archive.</td> 155 </tr> 156 <tr> 157 <th> 158 <a href="../../nw/snd/SoundDataManager/Overview.html"><CODE>nw::snd::SoundDataManager</CODE></a> 159 </th> 160 <td>A flag used to load sound archive data.</td> 161 </tr> 162 <tr> 163 <th> 164 <a href="../../nw/snd/SoundHandle/Overview.html">nw::snd::SoundHandle</a> 165 </th> 166 <td>A handle class used to control sounds that are played back.</td> 167 </tr> 168 <tr> 169 <th> 170 <a href="../../nw/snd/SoundHeap/Overview.html"><CODE>nw::snd::SoundHeap</CODE></a> 171 </th> 172 <td>A heap class used for sound data.</td> 173 </tr> 174 <tr> 175 <th> 176 <a href="../../nw/snd/SoundMemoryAllocatable/Overview.html"><CODE>nw::snd::SoundMemoryAllocatable</CODE></a> 177 </th> 178 <td>An interface for allocating memory used to store sound data.</td> 179 </tr> 180 <tr> 181 <th> 182 <a href="../../nw/snd/SoundPlayer/Overview.html"><CODE>nw::snd::SoundPlayer</CODE></a> 183 </th> 184 <td>A class used to play sounds.</td> 185 </tr> 186 <tr> 187 <th> 188 <a href="../../nw/snd/SoundStartable/Overview.html"><CODE>nw::snd::SoundStartable</CODE></a> 189 </th> 190 <td>An abstract class that represents a playable sound.</td> 191 </tr> 192 <tr> 193 <th> 194 <a href="../../nw/snd/SoundSystem/Overview.html">nw::snd::SoundSystem</a> 195 </th> 196 <td>Configures settings related to the overall sound system.</td> 197 </tr> 198 <tr> 199 <th> 200 <a href="../../nw/snd/StreamSoundHandle/Overview.html"><CODE>nw::snd::StreamSoundHandle</CODE></a> 201 </th> 202 <td>A handle class used to control stream sounds that are played back.</td> 203 </tr> 204 <tr> 205 <th> 206 <a href="../../nw/snd/WaveSoundHandle/Overview.html"><CODE>nw::snd::WaveSoundHandle</CODE></a> 207 </th> 208 <td>A handle class used to control wave sounds that are played back.</td> 209 </tr> </table> 210 </div> 211 </a> <a name="struct" id="struct"> 212 <h2>Structures</h2> 213 <div class="section"> 214 <table class="members"> 215 <tr> 216 <th> 217 <a href="../../nw/snd/SoundAmbientParam/Overview.html"><CODE>nw::snd::SoundAmbientParam</CODE></a> 218 </th> 219 <td>Ambient parameter structure.</td> 220 </tr> 221 <tr> 222 <th> 223 <a href="../../nw/snd/SequenceUserprocCallbackParam/Overview.html"><CODE>nw::snd::SequenceUserprocCallbackParam</CODE></a> 224 </th> 225 <td>The structure used by the callback invoked by the <CODE>userproc</CODE> command.</td> 226 </tr> 227 <tr> 228 <th> 229 <a href="../../nw/snd/Sound3DParam/Overview.html"><CODE>nw::snd::Sound3DParam</CODE></a> 230 </th> 231 <td>These are 3D sound parameters.</td> 232 </tr> 233 <tr> 234 <th> 235 <a href="../../nw/snd/StreamDataInfo/Overview.html"><CODE>nw::snd::StreamDataInfo</CODE></a> 236 </th> 237 <td>This set of parameters is for stream data.</td> 238 </tr> 239 <tr> 240 <th> 241 <a href="../../nw/snd/WaveSoundDataInfo/Overview.html"><CODE>nw::snd::WaveSoundDataInfo</CODE></a> 242 </th> 243 <td>This set of parameters is for wave sound data.</td> 244 </tr> </table> 245 </div> 246 </a> <a name="enum" id="enum"> 247 <h2>Enumerated Types</h2> 248 <div class="section"> 249 <table class="members"> 250 <tr> 251 <td width="100"> </td> 252 <th> 253 <a href="../../nw/snd/OutputMode.html"><CODE>OutputMode</CODE></a> 254 </th> 255 <td>Definition of the sound output mode.</td> 256 </tr> 257 <tr> 258 <td width="100"> </td> 259 <th> 260 <a href="../../nw/snd/AuxBus.html">AuxBus</a> 261 </th> 262 <td>Definition of the AUX bus ID.</td> 263 </tr> 264 <tr> 265 <td width="100"> </td> 266 <th> 267 <a href="../../nw/snd/SampleFormat.html">SampleFormat</a> 268 </th> 269 <td>Sample format.</td> 270 </tr> 271 <tr> 272 <td width="100"> </td> 273 <th> 274 <a href="../../nw/snd/SeqMute.html">SeqMute</a> 275 </th> 276 <td>Definition for muting and unmuting sequence tracks.</td> 277 </tr> 278 <tr> 279 <td width="100"> </td> 280 <th> 281 <a href="../../nw/snd/PanMode.html">PanMode</a> 282 </th> 283 <td>Definition of the pan operation mode.</td> 284 </tr> 285 <tr> 286 <td width="100"> </td> 287 <th> 288 <a href="../../nw/snd/PanCurve.html">PanCurve</a> 289 </th> 290 <td>Pan curve definitions.</td> 291 </tr> 292 <tr> 293 <td width="100"> </td> 294 <th> 295 <a href="../../nw/snd/DecayCurve.html">DecayCurve</a> 296 </th> 297 <td>This is an enumerator type for volume attenuation curves.</td> 298 </tr> 299 <tr> 300 <td width="100"> </td> 301 <th> 302 <a href="../../nw/snd/BiquadFilterType.html">BiquadFilterType</a> 303 </th> 304 <td>Enumerated type indicating the biquad filter type.</td> 305 </tr> 306 <tr> 307 <td width="100"> </td> 308 <th> 309 <a href="../../nw/snd/SrcType.html"><CODE>SrcType</CODE></a> 310 </th> 311 <td>SRC type definitions (interpolation methods for the sampling rate converter).</td> 312 </tr> </table> 313 </div> 314 </a> <a name="typedef" id="typedef"> 315 <h2><CODE>typedef</CODE> Definitions</h2> 316 <div class="section"> 317 <table class="members"> 318 <tr> 319 <td width="100" /> 320 <th> 321 <a href="../../nw/snd/SoundFrameUserCallback.html">SoundFrameUserCallback</a> 322 </th> 323 <td>Type definition of the user callback function called by the sound frame process.</td> 324 </tr> 325 <tr> 326 <td width="100" /> 327 <th> 328 <a href="../../nw/snd/SequenceUserprocCallback.html"><CODE>SequenceUserprocCallback</CODE></a> 329 </th> 330 <td>The callback of a user procedure that can be used by sequence sounds.</td> 331 </tr> </table> 332 </div> 333 </a> 334 <h2>Revision History</h2> 335 <div class="section"> 336 <dl class="history"> 337 <dt>2010/03/12</dt> 338 <dd>Initial version.<br /> 339 </dd> 340 </dl> 341 </div> 342 <hr><p>CONFIDENTIAL</p></body> 343</html> 344