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