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::OutputCapture</title> 51 </head> 52 <body> 53 <h1>nn::snd::CTR::OutputCapture Class</h1> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class OutputCapture</pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>The class for getting the DSP's final output.</p><p> 61 Use this class to get the DSP's final output from a thread other than a sound thread. To get it from a sound thread, use the <CODE><a href="../../../../nn/snd/CTR/GetMixedBusData.html">nn::snd::CTR::GetMixedBusData</a></CODE> function. 62 </p><p> 63 By registering <CODE>OutputCapture</CODE> with the <CODE><a href="../../../../nn/snd/CTR/SetOutputCapture.html">nn::snd::CTR::SetOutputCapture</a></CODE> function, you can automatically get the DSP's final output waveform within the <CODE><a href="../../../../nn/snd/CTR/WaitForDspSync.html">nn::snd::CTR::WaitForDspSync</a></CODE> function to the buffer specified by the <CODE><a href="../../../../nn/snd/CTR/OutputCapture/Initialize.html">nn::snd::CTR::OutputCapture::Initialize</a></CODE> function. The obtained data can be obtained asynchronously for a sound thread with the <CODE><a href="../../../../nn/snd/CTR/OutputCapture/Read.html">nn::snd::CTR::OutputCapture::Read</a></CODE> function. It is possible to control whether to get the data using the <CODE><a href="../../../../nn/snd/CTR/OutputCapture/Enable.html">nn::snd::CTR::OutputCapture::Enable</a></CODE> and <CODE><a href="../../../../nn/snd/CTR/OutputCapture/Disable.html">nn::snd::CTR::OutputCapture::Disable</a></CODE> functions. 64 </p><p>Since the buffer assigned to <CODE>OutputCapture</CODE> by the <CODE><a href="../../../../nn/snd/CTR/OutputCapture/Initialize.html">nn::snd::CTR::OutputCapture::Initialize</a></CODE> function is handled as a ring buffer, when data is not obtained by the <CODE><a href="../../../../nn/snd/CTR/OutputCapture/Read.html">nn::snd::CTR::OutputCapture::Read</a></CODE> function, note that old data may be overwritten. To make sure this does not happen, it is necessary to allocate a buffer of sufficient length. 65 </p></div> 66 <a name="function" id="function"> 67 <h2>Member Functions</h2> 68 <div class="section"> 69 <table class="members"> 70 <tr> 71 <th class="category" colspan="3">Initialization & Shutdown</th> 72 </tr> 73 <tr> 74 <td width="100"> </td> 75 <th> 76 <a href="../../../../nn/snd/CTR/OutputCapture/Initialize.html">Initialize</a> 77 </th> 78 <td>Performs initialization.</td> 79 </tr> 80 <tr> 81 <td width="100"> </td> 82 <th> 83 <a href="../../../../nn/snd/CTR/OutputCapture/Finalize.html">Finalize</a> 84 </th> 85 <td>Performs finalization.</td> 86 </tr> 87 <tr> 88 <td width="100"> 89 <span class="static_style" title="static">S</span> </td> 90 <th> 91 <a href="../../../../nn/snd/CTR/OutputCapture/GetRequiredMemorySize.html">GetRequiredMemorySize</a> 92 </th> 93 <td>Calculates the necessary buffer size from the specified number of sound frames.</td> 94 </tr> 95 <tr> 96 <th class="category" colspan="3">Data Acquisition</th> 97 </tr> 98 <tr> 99 <td width="100"> </td> 100 <th> 101 <a href="../../../../nn/snd/CTR/OutputCapture/Enable.html">Enable</a> 102 </th> 103 <td>Enables/disables the getting of data from the DSP.</td> 104 </tr> 105 <tr> 106 <td width="100"> </td> 107 <th> 108 <a href="../../../../nn/snd/CTR/OutputCapture/Disable.html">Disable</a> 109 </th> 110 <td>Disables the getting of data from the DSP.</td> 111 </tr> 112 <tr> 113 <td width="100"> </td> 114 <th> 115 <a href="../../../../nn/snd/CTR/OutputCapture/IsEnabled.html">IsEnabled</a> 116 </th> 117 <td>Gets whether the getting of data from the DSP is enabled.</td> 118 </tr> 119 <tr> 120 <td width="100"> </td> 121 <th> 122 <a href="../../../../nn/snd/CTR/OutputCapture/Read.html">Read</a> 123 </th> 124 <td>Copies the data obtained from the DSP to the specified buffer.</td> 125 </tr> 126 <tr> 127 <td width="100"> </td> 128 <th> 129 <a href="../../../../nn/snd/CTR/OutputCapture/Reset.html">Reset</a> 130 </th> 131 <td>Destroys all the obtained data.</td> 132 </tr> </table> 133 </div> 134 </a> 135 <h2>Revision History</h2> 136 <div class="section"> 137 <dl class="history"> 138 <dt>2010/10/20</dt> 139 <dd>Initial version.<br /> 140 </dd> 141 </dl> 142 </div> 143 <hr><p>CONFIDENTIAL</p></body> 144</html>