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/FxDelay/Overview.html">FxDelay</a> * fx
17);
18
19bool SetEffect(
20     <a href="../../../nn/snd/CTR/AuxBusId.html">AuxBusId</a> busId,
21     <a href="../../../nn/snd/CTR/FxReverb/Overview.html">FxReverb</a> * fx
22);
23</pre>
24    </div>
25<h2>List of Overloaded Member Functions</h2>
26    <div class="section">
27      <table class="members">
28        <tr>
29          <td>
30<a href="./SetEffect(0).html">SetEffect ( AuxBusId, FxDelay * ) </a>
31          </td>
32<td>Configures the delay effect.</td>
33        </tr>
34        <tr>
35          <td>
36<a href="./SetEffect(1).html">SetEffect ( AuxBusId, FxReverb * ) </a>
37          </td>
38<td>Configures the reverb effect.</td>
39        </tr> </table>
40    </div>
41<h2>SetEffect ( AuxBusId, FxDelay * ) Description</h2>
42<div class="section"><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">FxDelay::SetParam</a></CODE>, <CODE><a href="../../../nn/snd/CTR/FxDelay/GetRequiredMemSize.html">FxDelay::GetRequiredMemSize</a></CODE>, and <CODE><a href="../../../nn/snd/CTR/FxDelay/AssignWorkBuffer.html">FxDelay::AssignWorkBuffer</a></CODE> functions from the <CODE><A>FxDelay</A></CODE> class to finish preparing for the delay effect.</p></div>
43<h2>SetEffect ( AuxBusId, FxReverb * ) Description</h2>
44<div class="section"><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>
45  <hr><p>CONFIDENTIAL</p></body>
46</html>