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::DspFxDelay::Param</title>
49  </head>
50  <body>
51<h1><CODE><a href="../../../../../nn/Overview.html">nn</a>::<a href="../../../../../nn/snd/Overview.html">snd</a>::<a href="../../../../../nn/snd/CTR/Overview.html">CTR</a>::<a href="../../../../../nn/snd/CTR/DspFxDelay/Overview.html">DspFxDelay</a>::Param</CODE> Structure</h1>
52<h2>Syntax</h2>
53    <div class="section">
54<pre class="definition">struct Param
55{
56<a href="../../../../../nn_types/u32.html">u32</a> m_DelayTime;
57<a href="../../../../../nn_types/f32.html">f32</a> m_FeedbackGain;
58<a href="../../../../../nn_types/f32.html">f32</a> m_Damping;
59bool m_IsEnableSurround;
60};
61</pre>
62    </div>
63<h2>Description</h2>
64    <div class="section">
65<p>A structure for delay parameters.</p><p>
66<CODE>m_DelayTime</CODE> expresses the delay time. This is measured in milliseconds. Increasing the value of <CODE>m_DelayTime</CODE> increases the time by which echoes are delayed. In addition, as this value increases so does the required memory size obtained by the <a href="../../../../../nn/snd/CTR/DspFxDelay/GetRequiredMemorySize.html"><CODE>nn::snd::CTR::DspFxDelay::GetRequiredMemorySize</CODE></a> function. The initial value is <CODE>250</CODE>.
67      </p><p>
68<CODE>m_FeedbackGain</CODE> expresses the feedback gain for the delay sound. It needs to be set in the range from 0.0f to 1.0f. Increasing the value of <CODE>m_FeedbackGain</CODE> prevents the delay sound from vanishing. Specifying a value of <CODE>0.0f</CODE> (no feedback) indicates a one-shot delay. The initial value is <CODE>0.4f</CODE>.
69      </p><p>
70The value of <CODE>m_Damping</CODE> affects the behavior of low-pass filters. It needs to be set in the range from 0.0f to 1.0f. Increasing this value decreases the cutoff frequency. If you specify a value of <CODE>0.0f</CODE>, a low-pass filter is not applied. The initial value is <CODE>0.5f</CODE>.
71      </p><p>
72When <CODE>m_IsEnableSurround</CODE> is <CODE>true</CODE>, the surround components (rear left and right) are also delayed. When <CODE>false</CODE>, delay processing is skipped for the surround components and that processing load is decreased. When this is <CODE>true</CODE>, on the other hand, the processing load increases as does the required memory size obtained by the <a href="../../../../../nn/snd/CTR/DspFxDelay/GetRequiredMemorySize.html"><CODE>nn::snd::CTR::DspFxDelay::GetRequiredMemorySize</CODE></a> function.
73      </p><p>
74When you change <CODE>m_DelayTime</CODE> while an effect is executing, there is the possibility that noise will occur.
75      </p><p>
76In addition, if you continually change <CODE>m_FeedbackGain</CODE> and <CODE>m_Damping</CODE> even while an effect is executing, noise will not occur.
77      </p><p>
78Call the <a href="../../../../../nn/snd/CTR/DspFxDelay/SetParam.html"><CODE>nn::snd::CTR::DspFxDelay::SetParam</CODE></a> function to change parameters while an effect is running.
79      </p></div>
80    <a name="variable" id="variable">
81<h2>Member Variables</h2>
82      <div class="section">
83        <table class="members">
84          <tr>
85            <td width="100"> </td>
86            <th>
87<span class="argument"><CODE>m_DelayTime</CODE></span>
88            </th>
89<td width="100"><a href="../../../../../nn_types/u32.html">u32</a></td>
90<td>The delay time (in milliseconds). The initial value is <CODE>250</CODE>.</td>
91          </tr>
92          <tr>
93            <td width="100"> </td>
94            <th>
95<span class="argument"><CODE>m_FeedbackGain</CODE></span>
96            </th>
97<td width="100"><a href="../../../../../nn_types/f32.html">f32</a></td>
98<td>Feedback gain. Specify a value between <CODE>0.0f</CODE> and <CODE>1.0f</CODE>. The initial value is <CODE>0.4f</CODE>.</td>
99          </tr>
100          <tr>
101            <td width="100"> </td>
102            <th>
103<span class="argument"><CODE>m_Damping</CODE></span>
104            </th>
105<td width="100"><a href="../../../../../nn_types/f32.html">f32</a></td>
106<td>The behavior of low-pass filters. Specify a value between <CODE>0.0f</CODE> and <CODE>1.0f</CODE>. The initial value is <CODE>0.5f</CODE>.</td>
107          </tr>
108          <tr>
109            <td width="100"> </td>
110            <th>
111<span class="argument"><CODE>m_IsEnableSurround</CODE></span>
112            </th>
113<td width="100">bool</td>
114<td>A flag that determines whether to enable delays for surround channels as well.</td>
115          </tr> </table>
116      </div>
117    </a> <a name="function" id="function">
118<h2>Member Functions</h2>
119      <div class="section">
120        <table class="members">
121          <tr>
122            <td width="100">  </td>
123            <th>
124<a href="../../../../../nn/snd/CTR/DspFxDelay/Param/Param.html"><CODE>Param</CODE></a>
125            </th>
126<td>Constructor.</td>
127          </tr> </table>
128      </div>
129    </a>
130<h2>Revision History</h2>
131    <div class="section">
132      <dl class="history">
133        <dt>2011/10/04</dt>
134<dd>Initial version.<br />
135        </dd>
136      </dl>
137    </div>
138  <hr><p>CONFIDENTIAL</p></body>
139</html>
140