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