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>SetClamp</title>
8  </head>
9  <body>
10<h1><CODE>nn::mic::CTR::SetClamp</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">Result</a> SetClamp(
15     bool enable
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>enable</th>
32<td>When <CODE>true</CODE>, clamping is enabled. (The default is <CODE>true</CODE>.)</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36<div class="section">Returns the result of the operation. <br />
37      <table class="arguments">
38        <thead>
39          <tr>
40<th>Value</th>
41<td>Description</td>
42          </tr>
43        </thead>
44        <tr>
45<th><CODE>ResultSuccess</CODE></th>
46<td>Process succeeded.</td>
47        </tr>
48      </table> </div>
49<h2>Description</h2>
50    <div class="section">
51<p>Configures whether microphone data will be clamped.</p><p>The ideal is for the full range of microphone data input to be accepted, but in actual practice variations in microphones occur. A microphone's guaranteed input range is defined as the range for which input is guaranteed, regardless of the microphone.</p><p>When this function is called with a <CODE>true</CODE> argument, clamping is performed for the value of the microphone's guaranteed input range. Always use clamping to avoid problems that could be caused by differences in microphones.</p><p>When a broader range is necessary, you can disable clamping. In that case, note that it is possible that you may be unable to get values outside the microphone's guaranteed input range.</p><p>See the following for the microphone's guaranteed input range based on the sampling type. <br /><CODE><a href="../../../nn/mic/CTR/TYPE_8BIT_GUARANTEED_INPUT_MIN.html">nn::mic::CTR::TYPE_8BIT_GUARANTEED_INPUT_MIN</a></CODE>, <br /><CODE><a href="../../../nn/mic/CTR/TYPE_8BIT_GUARANTEED_INPUT_MAX.html">nn::mic::CTR::TYPE_8BIT_GUARANTEED_INPUT_MAX</a></CODE>, <br /><CODE><a href="../../../nn/mic/CTR/TYPE_16BIT_GUARANTEED_INPUT_MIN.html">nn::mic::CTR::TYPE_16BIT_GUARANTEED_INPUT_MIN</a></CODE>, <br /><CODE><a href="../../../nn/mic/CTR/TYPE_16BIT_GUARANTEED_INPUT_MAX.html">nn::mic::CTR::TYPE_16BIT_GUARANTEED_INPUT_MAX</a></CODE>, <br /><CODE><a href="../../../nn/mic/CTR/TYPE_SIGNED_8BIT_GUARANTEED_INPUT_MIN.html">nn::mic::CTR::TYPE_SIGNED_8BIT_GUARANTEED_INPUT_MIN</a></CODE>, <br /><CODE><a href="../../../nn/mic/CTR/TYPE_SIGNED_8BIT_GUARANTEED_INPUT_MAX.html">nn::mic::CTR::TYPE_SIGNED_8BIT_GUARANTEED_INPUT_MAX</a></CODE>, <br /><CODE><a href="../../../nn/mic/CTR/TYPE_SIGNED_16BIT_GUARANTEED_INPUT_MIN.html">nn::mic::CTR::TYPE_SIGNED_16BIT_GUARANTEED_INPUT_MIN</a></CODE>, <br /><CODE><a href="../../../nn/mic/CTR/TYPE_SIGNED_16BIT_GUARANTEED_INPUT_MAX.html">nn::mic::CTR::TYPE_SIGNED_16BIT_GUARANTEED_INPUT_MAX</a></CODE>, <br /></p><p>If this function is called while sampling is already under way, the settings are applied to the position currently being written and to all later positions.</p><!-- write here --></div>
52<h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2010/12/18</dt>
56<dd>Revised the description of the return values.
57        </dd>
58        <dt>2010/10/15</dt>
59<dd>Initial version.<br />
60        </dd>
61      </dl>
62    </div>
63  <hr><p>CONFIDENTIAL</p></body>
64</html>