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<title>SetEffect</title>
8  </head>
9  <body>
10<h1>nn::snd::CTR::SetEffect Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14bool SetEffect(
15     <a href="../../../nn/snd/CTR/AuxBusId.html">AuxBusId</a> busId,
16     <a href="../../../nn/snd/CTR/FxReverb/Overview.html">FxReverb</a> * fx
17);
18</pre>
19    </div>
20<h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>in</td>
32<th>busId</th>
33<td>Bus ID.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>fx</th>
38<td>The reverb effect to be configured.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">Returns <CODE>true</CODE> when the configuration was successful. When <CODE>fx</CODE> is NULL, the configuration failed, and <CODE>false</CODE> is returned. </div>
43<h2>Description</h2>
44    <div class="section">
45<p>Configures the reverb effect.</p><p>To process data that is to be output by AUX, you can use this function to apply delay and reverb effects in addition to configuring advance processing with the <CODE><a href="../../../nn/snd/CTR/RegisterAuxCallback.html">RegisterAuxCallback</a></CODE> function.</p><p>Note that you can only configure one delay (<CODE><A>FxDelay</A></CODE>) and one reverb (<CODE><A>FxReverb</A></CODE>) for each bus.</p><p>When you configure more than one, only the settings for the last one will be valid. The older configured effects will be cleared.</p><p>When you call <CODE><a href="../../../nn/snd/CTR/ClearEffect.html">ClearEffect</a></CODE> to clear older configurations as noted above, you can use the <CODE><a href="../../../nn/snd/CTR/FxDelay/ReleaseWorkBuffer.html">FxDelay::ReleaseWorkBuffer</a></CODE> and <CODE><a href="../../../nn/snd/CTR/FxReverb/ReleaseWorkBuffer.html">FxReverb::ReleaseWorkBuffer</a></CODE> function to deallocate the memory used for the relevant effects.</p><p>Before calling this function, you need to call the <CODE><a href="../../../nn/snd/CTR/FxDelay/SetParam.html">FxReverb::SetParam</a></CODE>, <CODE><a href="../../../nn/snd/CTR/FxDelay/GetRequiredMemSize.html">FxReverb::GetRequiredMemSize</a></CODE>, and <CODE><a href="../../../nn/snd/CTR/FxDelay/AssignWorkBuffer.html">FxReverb::AssignWorkBuffer</a></CODE> functions from the <CODE><A>FxReverb</A></CODE> class to finish preparing for the reverb effect.</p></div>
46<h2>See Also</h2>
47    <div class="section">
48<p class="reference"><a href="../../../nn/snd/CTR/ClearEffect.html">ClearEffect</a><br /><a href="../../../nn/snd/CTR/RegisterAuxCallback.html">RegisterAuxCallback</a><br /><a href="../../../nn/snd/CTR/FxReverb/Overview.html">FxReverb</a> Class<br /><a href="../../../nn/snd/CTR/FxDelay/Overview.html">FxDelay</a> Class<br /> </p>
49    </div>
50<h2>Revision History</h2>
51    <div class="section">
52      <dl class="history">
53        <dt>2010/10/20</dt>
54<dd>Initial version.<br />
55        </dd>
56      </dl>
57    </div>
58  <hr><p>CONFIDENTIAL</p></body>
59</html>
60