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>nn::snd::CTR</title> 51 </head> 52 <body> 53 <h1><CODE>nn::snd::CTR</CODE> Namespace</h1> 54 <h2>Description</h2> 55 <div class="section"> 56 <p>Sound (SND) namespace. <br />(This can also be written with "<CODE>CTR</CODE>" omitted.）</p><!-- write here --></div> 57 <a name="class" id="class"> 58 <h2>Classes</h2> 59 <div class="section"> 60 <table class="members"> 61 <tr> 62 <th> 63 <a href="../../../nn/snd/CTR/Bcwav/Overview.html"><CODE>nn::snd::CTR::Bcwav</CODE></a> 64 </th> 65 <td>Definition of a class that handles BCWAV files.</td> 66 </tr> 67 <tr> 68 <th> 69 <a href="../../../nn/snd/CTR/Voice/Overview.html"><CODE>nn::snd::CTR::Voice</CODE></a> 70 </th> 71 <td>A class used to control <CODE>Voice</CODE> objects.</td> 72 </tr> 73 </table> 74 </div> 75 </a> <a name="struct" id="struct"> 76 <h2>Structures</h2> 77 <div class="section"> 78 <table class="members"> 79 <tr> 80 <th> 81 <a href="../../../nn/snd/CTR/AdpcmParam/Overview.html"><CODE>nn::snd::CTR::AdpcmParam</CODE></a> 82 </th> 83 <td>A structure that stores ADPCM coefficients.</td> 84 </tr> 85 <tr> 86 <th> 87 <a href="../../../nn/snd/CTR/AdpcmContext/Overview.html"><CODE>nn::snd::CTR::AdpcmContext</CODE></a> 88 </th> 89 <td>A structure that stores an ADPCM context.</td> 90 </tr> 91 <tr> 92 <th> 93 <a href="../../../nn/snd/CTR/MonoFilterCoefficients/Overview.html"><CODE>nn::snd::CTR::MonoFilterCoefficients</CODE></a> 94 </th> 95 <td>Structure that stores one-pole filter coefficients.</td> 96 </tr> 97 <tr> 98 <th> 99 <a href="../../../nn/snd/CTR/BiquadFilterCoefficients/Overview.html"><CODE>nn::snd::CTR::BiquadFilterCoefficients</CODE></a> 100 </th> 101 <td>Structure that stores biquad filter coefficients.</td> 102 </tr> 103 <tr> 104 <th> 105 <a href="../../../nn/snd/CTR/MixParam/Overview.html"><CODE>nn::snd::CTR::MixParam</CODE></a> 106 </th> 107 <td>A structure that stores the gain for each channel.</td> 108 </tr> 109 <tr> 110 <th> 111 <a href="../../../nn/snd/CTR/WaveBuffer/Overview.html"><CODE>nn::snd::CTR::WaveBuffer</CODE></a> 112 </th> 113 <td>Structure that stores information about a buffer storing sample data.</td> 114 </tr> 115 <tr> 116 <th> 117 <a href="../../../nn/snd/CTR/AuxBusData/Overview.html"><CODE>nn::snd::CTR::AuxBusData</CODE></a> 118 </th> 119 <td>Typedef for functions containing the code that processes <CODE>Aux</CODE> bus data in each sound frame.</td> 120 </tr> 121 </table> 122 </div> 123 </a> <a name="enum" id="enum"> 124 <h2>Enumerated Types</h2> 125 <div class="section"> 126 <table class="members"> 127 <tr> 128 <td width="100"> </td> 129 <th> 130 <a href="../../../nn/snd/CTR/ChannelIndex.html"><CODE>ChannelIndex</CODE></a> 131 </th> 132 <td>An enumerated type representing channel positions.</td> 133 </tr> 134 <tr> 135 <td width="100"> </td> 136 <th> 137 <a href="../../../nn/snd/CTR/OutputMode.html"><CODE>OutputMode</CODE></a> 138 </th> 139 <td>Enumerated type representing a mixer's output mode.</td> 140 </tr> 141 <tr> 142 <td width="100"> </td> 143 <th> 144 <a href="../../../nn/snd/CTR/ClippingMode.html"><CODE>ClippingMode</CODE></a> 145 </th> 146 <td>Enumerated type that represents the clipping mode.</td> 147 </tr> 148 <tr> 149 <td width="100"> </td> 150 <th> 151 <a href="../../../nn/snd/CTR/SurroundSpeakerPosition.html"><CODE>SurroundSpeakerPosition</CODE></a> 152 </th> 153 <td>Enumerated type indicating the virtual speaker position for 3D surround sound.</td> 154 </tr> 155 <tr> 156 <td width="100"> </td> 157 <th> 158 <a href="../../../nn/snd/CTR/InterpolationType.html"><CODE>InterpolationType</CODE></a> 159 </th> 160 <td>An enumerated type representing the interpolation method.</td> 161 </tr> 162 <tr> 163 <td width="100"> </td> 164 <th> 165 <a href="../../../nn/snd/CTR/FilterType.html"><CODE>FilterType</CODE></a> 166 </th> 167 <td>Enumerated type representing the filter type.</td> 168 </tr> 169 <tr> 170 <td width="100"> </td> 171 <th> 172 <a href="../../../nn/snd/CTR/AuxBusId.html"><CODE>AuxBusId</CODE></a> 173 </th> 174 <td>The enumerated type representing the <CODE>Aux</CODE> bus ID.</td> 175 </tr> 176 <tr> 177 <td width="100"> </td> 178 <th> 179 <a href="../../../nn/snd/CTR/SampleFormat.html"><CODE>SampleFormat</CODE></a> 180 </th> 181 <td>An enumerated type representing sample formats.</td> 182 </tr> </table> 183 </div> 184 </a> <a name="typedef" id="typedef"> 185 <h2><CODE>typedef</CODE> Definitions</h2> 186 <div class="section"> 187 <table class="members"> 188 <tr> 189 <td width="100" /> 190 <th> 191 <a href="../../../nn/snd/CTR/AuxCallback.html"><CODE>AuxCallback</CODE></a> 192 </th> 193 <td>Typedef for the <CODE>Aux</CODE> callback function pointer.</td> 194 </tr> 195 <tr> 196 <td width="100" /> 197 <th> 198 <a href="../../../nn/snd/CTR/VoiceDropCallbackFunc.html"><CODE>VoiceDropCallbackFunc</CODE></a> 199 </th> 200 <td>Typedef for the callback function to invoke when the library frees a voice.</td> 201 </tr> </table> 202 </div> 203 </a> <a name="constant" id="constant"> 204 <h2>Constants</h2> 205 <div class="section"> 206 <table class="members"> 207 <tr> 208 <td width="100"> 209 <span class="static_style" title="static">S</span> 210 </td> 211 <th> 212 <span class="argument"><a href="./VOICE_PRIORITY_NODROP.html"><CODE>VOICE_PRIORITY_NODROP</CODE></a></span> 213 </th> 214 <td>This is the highest possible priority and is also given special treatment.</td> 215 </tr> 216 <tr> 217 <td width="100"> 218 <span class="static_style" title="static">S</span> 219 </td> 220 <th> 221 <span class="argument"><a href="./NN_SND_DSP_MAXIMUM_CYCLES.html"><CODE>NN_SND_DSP_MAXIMUM_CYCLES</CODE></a></span> 222 </th> 223 <td>Maximum number of DSP cycles per sound frame.</td> 224 </tr> </table> 225 </div> 226 </a> <a name="function" id="function"> 227 <h2>Functions</h2> 228 <div class="section"> 229 <table class="members"> 230 <tr> 231 <th class="category" colspan="3">Initialize/Finalize</th> 232 </tr> 233 <tr> 234 <td width="100"> </td> 235 <th> 236 <a href="../../../nn/snd/CTR/Initialize.html"><CODE>Initialize</CODE></a> 237 </th> 238 <td>Initializes the sound library.</td> 239 </tr> 240 <tr> 241 <td width="100"> </td> 242 <th> 243 <a href="../../../nn/snd/CTR/Finalize.html">Finalize</a> 244 </th> 245 <td>Finalizes the sound library.</td> 246 </tr> 247 <tr> 248 <td width="100"> </td> 249 <th> 250 <a href="../../../nn/snd/CTR/InitializeWaveBuffer.html"><CODE>InitializeWaveBuffer</CODE></a> 251 </th> 252 <td>Initializes a buffer information structure.</td> 253 </tr> 254 <tr> 255 <th class="category" colspan="3">Cache Operations</th> 256 </tr> 257 <tr> 258 <td width="100"> </td> 259 <th> 260 <a href="../../../nn/snd/CTR/FlushDataCache.html"><CODE>FlushDataCache</CODE></a> 261 </th> 262 <td>Writes data for the specified cache range back into memory and invalidates the cache.</td> 263 </tr> 264 <tr> 265 <td width="100"> </td> 266 <th> 267 <a href="../../../nn/snd/CTR/InvalidateDataCache.html"><CODE>InvalidateDataCache</CODE></a> 268 </th> 269 <td>Invalidates the specified cache range.</td> 270 </tr> 271 <tr> 272 <th class="category" colspan="3">Synchronous Processing</th> 273 </tr> 274 <tr> 275 <td width="100"> </td> 276 <th> 277 <a href="../../../nn/snd/CTR/WaitForDspSync.html"><CODE>WaitForDspSync</CODE></a> 278 </th> 279 <td>Receives the result of DSP processing.</td> 280 </tr> 281 <tr> 282 <td width="100"> </td> 283 <th> 284 <a href="../../../nn/snd/CTR/SendParameterToDsp.html"><CODE>SendParameterToDsp</CODE></a> 285 </th> 286 <td>Applies the configured parameters to the DSP.</td> 287 </tr> 288 <tr> 289 <th class="category" colspan="3">3D Surround Sound</th> 290 </tr> 291 <tr> 292 <td width="100"> </td> 293 <th> 294 <a href="../../../nn/snd/CTR/SetSoundOutputMode.html"><CODE>SetSoundOutputMode</CODE></a> 295 </th> 296 <td>Sets the sound output mode.</td> 297 </tr> 298 <tr> 299 <td width="100"> </td> 300 <th> 301 <a href="../../../nn/snd/CTR/GetSoundOutputMode.html"><CODE>GetSoundOutputMode</CODE></a> 302 </th> 303 <td>Gets the sound output mode.</td> 304 </tr> 305 <tr> 306 <td width="100"> </td> 307 <th> 308 <a href="../../../nn/snd/CTR/SetClippingMode.html"><CODE>SetClippingMode</CODE></a> 309 </th> 310 <td>Sets the clipping mode.</td> 311 </tr> 312 <tr> 313 <td width="100"> </td> 314 <th> 315 <a href="../../../nn/snd/CTR/GetClippingMode.html"><CODE>GetClippingMode</CODE></a> 316 </th> 317 <td>Gets the clipping mode.</td> 318 </tr> 319 <tr> 320 <td width="100"> </td> 321 <th> 322 <a href="../../../nn/snd/CTR/SetSurroundDepth.html"><CODE>SetSurroundDepth</CODE></a> 323 </th> 324 <td>Sets the surround sound depth.</td> 325 </tr> 326 <tr> 327 <td width="100"> </td> 328 <th> 329 <a href="../../../nn/snd/CTR/SetSurroundSpeakerPosition.html"><CODE>SetSurroundSpeakerPosition</CODE></a> 330 </th> 331 <td>Sets the virtual speaker position for 3D surround sound.</td> 332 </tr> 333 <tr> 334 <th class="category" colspan="3">Dropped Processing Detection</th> 335 </tr> 336 <tr> 337 <td width="100"> </td> 338 <th> 339 <a href="../../../nn/snd/CTR/GetDroppedSoundFrameCount.html"><CODE>GetDroppedSoundFrameCount</CODE></a> 340 </th> 341 <td>Gets the number of dropped sound frames.</td> 342 </tr> 343 <tr> 344 <td width="100"> </td> 345 <th> 346 <a href="../../../nn/snd/CTR/ClearDroppedSoundFrameCount.html"><CODE>ClearDroppedSoundFrameCount</CODE></a> 347 </th> 348 <td>Initializes the number of dropped sound frames.</td> 349 </tr> 350 <tr> 351 <th class="category" colspan="3">DSP-ADPCM-Related</th> 352 </tr> 353 <tr> 354 <td width="100"> </td> 355 <th> 356 <a href="../../../nn/snd/CTR/EncodeAdpcmData.html"><CODE>EncodeAdpcmData</CODE></a> 357 </th> 358 <td>Encodes 16-bit PCM data into DSP-ADPCM format.</td> 359 </tr> 360 <tr> 361 <td width="100"> </td> 362 <th> 363 <a href="../../../nn/snd/CTR/DecodeAdpcmData.html"><CODE>DecodeAdpcmData</CODE></a> 364 </th> 365 <td>Decodes DSP-ADPCM data.</td> 366 </tr> 367 <tr> 368 <td width="100"> </td> 369 <th> 370 <a href="../../../nn/snd/CTR/GetAdpcmOutputBufferSize.html"><CODE>GetAdpcmOutputBufferSize</CODE></a> 371 </th> 372 <td>Returns the size of the output buffer that is required during encoding.</td> 373 </tr> 374 <tr> 375 <td width="100"> </td> 376 <th> 377 <a href="../../../nn/snd/CTR/ConvertAdpcmPos2Nib.html"><CODE>ConvertAdpcmPos2Nib</CODE></a> 378 </th> 379 <td>Converts the sample position to a number of nibbles.</td> 380 </tr> 381 <tr> 382 <td width="100"> </td> 383 <th> 384 <a href="../../../nn/snd/CTR/ConvertAdpcmNib2Pos.html"><CODE>ConvertAdpcmNib2Pos</CODE></a> 385 </th> 386 <td>Converts the number of nibbles to a sample position.</td> 387 </tr> 388 <tr> 389 <th class="category" colspan="3">Other</th> 390 </tr> 391 <tr> 392 <td width="100"> </td> 393 <th> 394 <a href="../../../nn/snd/CTR/GetSampleLength.html"><CODE>GetSampleLength</CODE></a> 395 </th> 396 <td>Gets the sample length.</td> 397 </tr> 398 <tr> 399 <td width="100"> </td> 400 <th> 401 <a href="../../../nn/snd/CTR/SetMasterVolume.html"><CODE>SetMasterVolume</CODE></a> 402 </th> 403 <td>This function sets the master volume.</td> 404 </tr> 405 <tr> 406 <td width="100"> </td> 407 <th> 408 <a href="../../../nn/snd/CTR/SetAuxReturnVolume.html"><CODE>SetAuxReturnVolume</CODE></a> 409 </th> 410 <td>Sets the <CODE>Aux</CODE> bus volume.</td> 411 </tr> 412 <tr> 413 <td width="100"> </td> 414 <th> 415 <a href="../../../nn/snd/CTR/GetAuxReturnVolume.html"><CODE>SetAuxReturnVolume</CODE></a> 416 </th> 417 <td>Gets the <CODE>Aux</CODE> bus volume.</td> 418 </tr> 419 <tr> 420 <td width="100"> </td> 421 <th> 422 <a href="../../../nn/snd/CTR/RegisterAuxCallback.html"><CODE>RegisterAuxCallback</CODE></a> 423 </th> 424 <td>Sets the <CODE>Aux</CODE> bus callback function.</td> 425 </tr> 426 <tr> 427 <td width="100"> </td> 428 <th> 429 <a href="../../../nn/snd/CTR/GetAuxCallback.html"><CODE>GetAuxCallback</CODE></a> 430 </th> 431 <td>Gets the <CODE>Aux</CODE> bus callback function.</td> 432 </tr> 433 <tr> 434 <td width="100"> </td> 435 <th> 436 <a href="../../../nn/snd/CTR/ClearAuxCallback.html"><CODE>ClearAuxCallback</CODE></a> 437 </th> 438 <td>Clears the <CODE>Aux</CODE> bus callback function.</td> 439 </tr> 440 <tr> 441 <td width="100"> </td> 442 <th> 443 <a href="../../../nn/snd/CTR/SetAuxFrontBypass.html"><CODE>SetAuxFrontBypass</CODE></a> 444 </th> 445 <td>Configures whether to bypass the front channels of an Aux bus.</td> 446 </tr> 447 <tr> 448 <td width="100"> </td> 449 <th> 450 <a href="../../../nn/snd/CTR/GetMixedBusData.html"><CODE>GetMixedBusData</CODE></a> 451 </th> 452 <td>Copies the <CODE>Mix</CODE> bus data to the specified buffer.</td> 453 </tr> 454 <tr> 455 <td width="100"> </td> 456 <th> 457 <a href="../../../nn/snd/CTR/SetMaximumDspCycles.html"><CODE>SetMaximumDspCycles</CODE></a> 458 </th> 459 <td>Sets the number of DSP cycles that sound can use.</td> 460 </tr> 461 <tr> 462 <td width="100"> </td> 463 <th> 464 <a href="../../../nn/snd/CTR/GetMaximumDspCycles.html"><CODE>GetMaximumDspCycles</CODE></a> 465 </th> 466 <td>Gets the number of DSP cycles allocated to sound.</td> 467 </tr> 468 <tr> 469 <td width="100"> </td> 470 <th> 471 <a href="../../../nn/snd/CTR/GetDspCycles.html"><CODE>GetDspCycles</CODE></a> 472 </th> 473 <td>Gets the number of cycles consumed by the DSP to create the last audio frame.</td> 474 </tr> 475 <tr> 476 <td width="100"> </td> 477 <th> 478 <a href="../../../nn/snd/CTR/GetHeadphoneStatus.html"><CODE>GetHeadphoneStatus</CODE></a> 479 </th> 480 <td>Gets whether headphones are plugged in.</td> 481 </tr> 482 <tr> 483 <td width="100"> </td> 484 <th> 485 <a href="../../../nn/snd/CTR/UpdateHeadphoneStatus.html"><CODE>UpdateHeadphoneStatus</CODE></a> 486 </th> 487 <td>Updates and gets the headphone state (whether they are inserted or not).</td> 488 </tr> 489 <tr> 490 <td width="100"> </td> 491 <th> 492 <a href="../../../nn/snd/CTR/AllocVoice.html"><CODE>AllocVoice</CODE></a> 493 </th> 494 <td>Gets a voice.</td> 495 </tr> 496 <tr> 497 <td width="100"> </td> 498 <th> 499 <a href="../../../nn/snd/CTR/FreeVoice.html"><CODE>FreeVoice</CODE></a> 500 </th> 501 <td>Frees a voice.</td> 502 </tr> </table> 503 </div> 504 </a> 505 <h2>Revision History</h2> 506 <div class="section"> 507 <dl class="history"> 508 <dt>2010/02/09</dt> 509 <dd>Initial version.<br /> 510 </dd> 511 </dl> 512 </div> 513 <hr><p>CONFIDENTIAL</p></body> 514</html>