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>GetForbiddenArea</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/mic/Overview.html">mic</a>::<a href="../../../nn/mic/CTR/Overview.html">CTR</a>::GetForbiddenArea</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14bool GetForbiddenArea(
15     <a href="../../../nn_types/s32.html">s32</a> * upper,
16     <a href="../../../nn_types/s32.html">s32</a> * lower,
17     <a href="../../../nn/mic/CTR/SamplingType.html">SamplingType</a> type,
18     <a href="../../../nn_types/u8.html">u8</a> gain
19);
20</pre>
21    </div>
22<h2>Parameters</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>out</td>
34<th>upper</th>
35<td>Maximum value for the region within which it is prohibited to determine if there is microphone input.</td>
36        </tr>
37        <tr>
38<td>out</td>
39<th>lower</th>
40<td>Minimum value for the region within which it is prohibited to determine if there is microphone input.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>type</th>
45<td>Specifies the sampling type.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>gain</th>
50<td>Sets the microphone amp's gain. Specify a value in the range 0-119 (10.5-70.0 dB).</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<div class="section">Returns the result of the operation. <br />
55      <table class="arguments">
56        <thead>
57          <tr>
58<th>Value</th>
59<td>Description</td>
60          </tr>
61        </thead>
62        <tr>
63<th><CODE>true</CODE></th>
64<td>Successfully obtained a region.</td>
65        </tr>
66        <tr>
67<th><CODE>false</CODE></th>
68<td>Could not successfully obtain a region. Determine whether the input values are within the proper range.</td>
69        </tr>
70      </table> </div>
71<h2>Description</h2>
72    <div class="section">
73<p>Gets the maximum and minimum values for a region within which it is prohibited to determine that there is microphone input, given a gain and sampling type. Do not determine that there is microphone input between these upper and lower limits.</p><!-- write here --></div>
74<h2>Revision History</h2>
75    <div class="section">
76      <dl class="history">
77        <dt>2010/12/18</dt>
78<dd>Revised the description of the return values.
79        </dd>
80        <dt>2010/07/15</dt>
81<dd>Initial version.<br />
82        </dd>
83      </dl>
84    </div>
85  <hr><p>CONFIDENTIAL</p></body>
86</html>
87