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>SetParam</title>
8  </head>
9  <body>
10<h1>nn::snd::CTR::FxDelay::SetParam Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14bool SetParam(
15     const <a href="../../../../nn/snd/CTR/FxDelay/Param/Overview.html">FxDelay::Param</a> & param
16);
17</pre>
18    </div>
19<h2>Arguments</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25<th>Name</th>
26<td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30<td>in</td>
31<th>param</th>
32<td>The delay parameter.</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36<div class="section">Returns <CODE>true</CODE> when configuration succeeded and <CODE>false</CODE> when it failed (when an out-of-range value was configured, etc.). </div>
37<h2>Description</h2>
38    <div class="section">
39<p>Configures the delay parameters.</p><p>The <CODE><a href="../../../../nn/snd/CTR/FxDelay/GetRequiredMemSize.html">GetRequiredMemSize</a></CODE> function calculates the required memory sized based on the delay parameters configured here.</p><p>The configured <CODE><A>Param</A></CODE> structure is copied within the <CODE>FxDelay</CODE> instance.</p><p>The behavior of the <CODE><A>FxDelay</A></CODE> differs depending on whether it is before or after you pass it to the <CODE><A>SetEffect</A></CODE> function.</p><p>Before calling the <a href="../../../../nn/snd/CTR/SetEffect.html"><CODE>SetEffect</CODE></a> function, range checks are performed on <CODE>m_FeedbackGain</CODE> and <CODE>m_Damping</CODE> within the <a href="../../../../nn/snd/CTR/FxDelay/Param/Overview.html"><CODE>Param</CODE></a> structure. When out of range, you halt on an assert in the debug/development versions, and <CODE>false</CODE> is returned in the release version.</p><p>After calling the <CODE><A>SetEffect</A></CODE> function, a check is performed for whether additional memory is needed, in addition to the range check performed before calling. In other words, if a larger value is configured for <CODE>m_DelayTime</CODE> than was configured when the <a href="../../../../nn/snd/CTR/SetEffect.html"><CODE>SetEffect</CODE></a> function was called, or if <CODE>m_IsEnableSurround</CODE> is set to <CODE>true</CODE> even though it was set to <CODE>false</CODE> when the <a href="../../../../nn/snd/CTR/SetEffect.html"><CODE>SetEffect</CODE></a> function was called, then this function will fail and return <CODE>false</CODE>. If the above conditions are not met, subsequent parameter changes can be made with the <CODE><A>SetEffect</A></CODE> function.</p><!-- write here --></div>
40<h2>See Also</h2>
41    <div class="section">
42<p class="reference"><a href="../../../../nn/snd/CTR/FxDelay/GetRequiredMemSize.html">GetRequiredMemSize</a><br /><a href="../../../../nn/snd/CTR/FxDelay/GetParam.html">GetParam</a><br /><a href="../../../../nn/snd/CTR/SetEffect.html">SetEffect</a><br /> </p>
43    </div>
44<h2>Revision History</h2>
45    <div class="section">
46      <dl class="history">
47        <dt>2010/11/10</dt>
48<dd>Initial version.<br />
49        </dd>
50      </dl>
51    </div>
52  <hr><p>CONFIDENTIAL</p></body>
53</html>