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