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
22      span.virtual_style
23      {
24        font-size			 : 8pt;
25        color				 : white;
26        font-weight			: bold;
27        background			: #0a0;
28        border-left			: solid 1px #0f0;
29        border-top			: solid 1px #0f0;
30        border-right		: solid 1px #060;
31        border-bottom		: solid 1px #060;
32        padding-left		: 2px;
33        padding-right		: 2px;
34      }
35
36      span.protected_style
37      {
38        font-size			 : 8pt;
39        color				 : white;
40        font-weight			: bold;
41        background			: #444;
42        border-left			: solid 1px #ccc;
43        border-top			: solid 1px #ccc;
44        border-right		: solid 1px #222;
45        border-bottom		: solid 1px #222;
46        padding-left		: 2px;
47        padding-right		: 2px;
48      }
49        --></style>
50<title>nn::snd::CTR::FxDelay::Param</title>
51  </head>
52  <body>
53<h1><CODE>nn::snd::CTR::FxDelay::Param</CODE> Structure</h1>
54<h2>Syntax</h2>
55    <div class="section">
56      <pre class="definition">struct Param
57{
58   u32 m_DelayTime;
59   f32 m_FeedbackGain;
60   f32 m_Damping;
61   bool m_IsEnableSurround;
62};
63</pre>
64    </div>
65<h2>Description</h2>
66    <div class="section">
67<p>A structure for delay parameters.</p><p><CODE>m_DelayTime</CODE> expresses the delay time. In units of milliseconds. Increasing the value of <CODE>m_DelayTime</CODE> increases the time by which echoes are delayed. In addition, when you increase the size of <CODE>m_DelayTime</CODE>, you need to increase the size of memory that can be obtained by the <CODE><a href="../../../../../nn/snd/CTR/FxDelay/GetRequiredMemSize.html">GetRequiredMemSize</a></CODE> function. The initial value is 250.</p><p><CODE>m_FeedbackGain</CODE> expresses the feedback gain for the delay sound. It needs to be set in 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 0.0f (no feedback) indicates a one-shot delay. This value is initially 0.4f.</p><p>The value of <CODE>m_Damping</CODE> affects the behavior of low-pass filters. It needs to be set in 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. This value is initially 0.5f.</p><p>When <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. On the other hand, when <CODE>true</CODE>, the processing load increases, and the amount of needed memory to be obtained from the <CODE><a href="../../../../../nn/snd/CTR/FxDelay/GetRequiredMemSize.html">GetRequiredMemSize</a></CODE> function increases.</p><p>When you change <CODE>m_DelayTime</CODE> while an effect is executing, there is the possibility that noise will occur.</p><p>In addition, if you continually change m_FeedbackGain and m_Damping even while an effect is executing, noise will not occur.</p><p>To change a parameter while an effect is executing, call the <CODE><a href="../../../../../nn/snd/CTR/FxDelay/SetParam.html">SetParam</a></CODE> function.</p><!-- write here --></div>
68    <a name="variable" id="variable">
69<h2>Member Variables</h2>
70      <div class="section">
71        <table class="members">
72          <tr>
73            <td width="100"> </td>
74            <th>
75<span class="argument"><CODE>m_DelayTime</CODE></span>
76            </th>
77<td>The delay time (in milliseconds). The initial value is 250.</td>
78          </tr>
79          <tr>
80            <td width="100"> </td>
81            <th>
82<span class="argument"><CODE>m_FeedbackGain</CODE></span>
83            </th>
84<td>Feedback gain. Specify a value between 0.0f and 1.0f. This value is initially 0.4f.</td>
85          </tr>
86          <tr>
87            <td width="100"> </td>
88            <th>
89<span class="argument"><CODE>m_Damping</CODE></span>
90            </th>
91<td>The behavior of low-pass filters. Specify a value between 0.0f and 1.0f. This value is initially 0.5f.</td>
92          </tr>
93          <tr>
94            <td width="100"> </td>
95            <th>
96<span class="argument"><CODE>m_IsEnableSurround</CODE></span>
97            </th>
98<td>A flag that determines whether to enable delays for surround channels as well. The initial value is <CODE>false</CODE>.</td>
99          </tr> </table>
100      </div>
101    </a> <a name="function" id="function">
102<h2>Member Functions</h2>
103      <div class="section">
104        <table class="members">
105          <tr>
106            <td width="100">  </td>
107            <th>
108<a href="../../../../../nn/snd/CTR/FxDelay/Param/Param.html"><CODE>Param</CODE></a>
109            </th>
110<td>Constructor.</td>
111          </tr> </table>
112      </div>
113    </a>
114<h2>Revision History</h2>
115    <div class="section">
116      <dl class="history">
117        <dt>2010/11/10</dt>
118<dd>Initial version.<br />
119        </dd>
120      </dl>
121    </div>
122  <hr><p>CONFIDENTIAL</p></body>
123</html>