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::mic::CTR</title> 51 </head> 52 <body> 53<h1><CODE>nn::mic::CTR</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>Namespace for the CTR's microphone. <br />(This namespace can also be written without the <CODE>::CTR</CODE> portion.)</p><!-- write here --></div> 57 <a name="enum" id="enum"> 58<h2>Enumerated Types</h2> 59 <div class="section"> 60 <table class="members"> 61 <tr> 62 <td width="100"> </td> 63 <th> 64<a href="../../../nn/mic/CTR/SamplingType.html"><CODE>SamplingType</CODE></a> 65 </th> 66<td>Enumerated type that indicates the microphone sampling type.</td> 67 </tr> 68 <tr> 69 <td width="100"> </td> 70 <th> 71<a href="../../../nn/mic/CTR/SamplingRate.html"><CODE>SamplingRate</CODE></a> 72 </th> 73<td>Enumerated type that indicates the microphone sampling rate.</td> 74 </tr> </table> 75 </div> 76 </a> <a name="constant" id="constant"> 77<h2>Constants</h2> 78 <div class="section"> 79 <table class="members"> 80 <tr> 81 <td width="100"> </td> 82 <th> 83<span class="argument"><a href="../../../nn/mic/CTR/AMP_GAIN_MAX.html"><CODE>AMP_GAIN_MAX</CODE></a></span> 84 </th> 85<td>Constant that indicates the maximum gain for the microphone amp. Defined as <CODE>119</CODE> (70.0 dB).</td> 86 </tr> 87 <tr> 88 <td width="100"> </td> 89 <th> 90<span class="argument"><a href="../../../nn/mic/CTR/AMP_GAIN_MIN.html"><CODE>AMP_GAIN_MIN</CODE></a></span> 91 </th> 92<td>Constant that indicates the maximum gain for the microphone amp. Defined as <CODE>0</CODE> (10.5 dB).</td> 93 </tr> 94 <tr> 95 <td width="100"> </td> 96 <th> 97<span class="argument"><a href="../../../nn/mic/CTR/BUFFER_ALIGNMENT_ADDRESS.html"><CODE>BUFFER_ALIGNMENT_ADDRESS</CODE></a></span> 98 </th> 99<td>Constant that indicates the alignment of the address of the memory region set using <CODE>SetBuffer</CODE>. It is defined as 4096 bytes.</td> 100 </tr> 101 <tr> 102 <td width="100"> </td> 103 <th> 104<span class="argument"><a href="../../../nn/mic/CTR/BUFFER_ALIGNMENT_SIZE.html"><CODE>BUFFER_ALIGNMENT_SIZE</CODE></a></span> 105 </th> 106<td>Constant that indicates the alignment of the size of the memory region set using <CODE>SetBuffer</CODE>. It is defined as 4096 bytes.</td> 107 </tr> 108 <tr> 109 <td width="100"> </td> 110 <th> 111<span class="argument"><a href="../../../nn/mic/CTR/SAMPLING_TYPE_8BIT_SILENT_DATA.html"><CODE>SAMPLING_TYPE_8BIT_SILENT_DATA</CODE></a></span> 112 </th> 113<td>Constant representing the silence value for <CODE>SAMPLING_TYPE_8BIT</CODE>.</td> 114 </tr> 115 <tr> 116 <td width="100"> </td> 117 <th> 118<span class="argument"><a href="../../../nn/mic/CTR/SAMPLING_TYPE_16BIT_SILENT_DATA.html"><CODE>SAMPLING_TYPE_16BIT_SILENT_DATA</CODE></a></span> 119 </th> 120<td>Constant representing the silence value for <CODE>SAMPLING_TYPE_16BIT</CODE>.</td> 121 </tr> 122 <tr> 123 <td width="100"> </td> 124 <th> 125<span class="argument"><a href="../../../nn/mic/CTR/SAMPLING_TYPE_SIGNED_8BIT_SILENT_DATA.html"><CODE>SAMPLING_TYPE_SIGNED_8BIT_SILENT_DATA</CODE></a></span> 126 </th> 127<td>Constant representing the silence value for <CODE>SAMPLING_TYPE_SIGNED_8BIT</CODE>.</td> 128 </tr> 129 <tr> 130 <td width="100"> </td> 131 <th> 132<span class="argument"><a href="../../../nn/mic/CTR/SAMPLING_TYPE_SIGNED_16BIT_SILENT_DATA.html"><CODE>SAMPLING_TYPE_SIGNED_16BIT_SILENT_DATA</CODE></a></span> 133 </th> 134<td>Constant representing the silence value for <CODE>SAMPLING_TYPE_SIGNED_16BIT</CODE>.</td> 135 </tr> 136 <tr> 137 <td width="100"> </td> 138 <th> 139<span class="argument"><a href="../../../nn/mic/CTR/TYPE_8BIT_GUARANTEED_INPUT_MIN.html"><CODE>TYPE_8BIT_GUARANTEED_INPUT_MIN</CODE></a></span> 140 </th> 141<td>Constant representing the minimum value of the guaranteed input range for microphone input values obtained with <CODE>SAMPLING_TYPE_8BIT</CODE>. It has a value of <CODE>27</CODE>.</td> 142 </tr> 143 <tr> 144 <td width="100"> </td> 145 <th> 146<span class="argument"><a href="../../../nn/mic/CTR/TYPE_8BIT_GUARANTEED_INPUT_MAX.html"><CODE>TYPE_8BIT_GUARANTEED_INPUT_MAX</CODE></a></span> 147 </th> 148<td>Constant representing the maximum value of the guaranteed input range for microphone input values obtained with <CODE>SAMPLING_TYPE_8BIT</CODE>. It has a value of <CODE>228</CODE>.</td> 149 </tr> 150 <tr> 151 <td width="100"> </td> 152 <th> 153<span class="argument"><a href="../../../nn/mic/CTR/TYPE_16BIT_GUARANTEED_INPUT_MIN.html"><CODE>TYPE_16BIT_GUARANTEED_INPUT_MIN</CODE></a></span> 154 </th> 155<td>Constant representing the minimum value of the guaranteed input range for microphone input values obtained with <CODE>SAMPLING_TYPE_16BIT</CODE>. It has a value of <CODE>7105</CODE>.</td> 156 </tr> 157 <tr> 158 <td width="100"> </td> 159 <th> 160<span class="argument"><a href="../../../nn/mic/CTR/TYPE_16BIT_GUARANTEED_INPUT_MAX.html"><CODE>TYPE_16BIT_GUARANTEED_INPUT_MAX</CODE></a></span> 161 </th> 162<td>Constant representing the maximum value of the guaranteed input range for microphone input values obtained with <CODE>SAMPLING_TYPE_16BIT</CODE>. It has a value of <CODE>58415</CODE>.</td> 163 </tr> 164 <tr> 165 <td width="100"> </td> 166 <th> 167<span class="argument"><a href="../../../nn/mic/CTR/TYPE_SIGNED_8BIT_GUARANTEED_INPUT_MIN.html"><CODE>TYPE_SIGNED_8BIT_GUARANTEED_INPUT_MIN</CODE></a></span> 168 </th> 169<td>Constant representing the minimum value of the guaranteed input range for microphone input values obtained with <CODE>SAMPLING_TYPE_SIGNED_8BIT</CODE>. It has a value of <CODE>-101</CODE>.</td> 170 </tr> 171 <tr> 172 <td width="100"> </td> 173 <th> 174<span class="argument"><a href="../../../nn/mic/CTR/TYPE_SIGNED_8BIT_GUARANTEED_INPUT_MAX.html"><CODE>TYPE_SIGNED_8BIT_GUARANTEED_INPUT_MAX</CODE></a></span> 175 </th> 176<td>Constant representing the maximum value of the guaranteed input range for microphone input values obtained with <CODE>SAMPLING_TYPE_SIGNED_8BIT</CODE>. It has a value of <CODE>100</CODE>.</td> 177 </tr> 178 <tr> 179 <td width="100"> </td> 180 <th> 181<span class="argument"><a href="../../../nn/mic/CTR/TYPE_SIGNED_16BIT_GUARANTEED_INPUT_MIN.html"><CODE>TYPE_SIGNED_16BIT_GUARANTEED_INPUT_MIN</CODE></a></span> 182 </th> 183<td>Constant representing the minimum value of the guaranteed input range for microphone input values obtained with <CODE>SAMPLING_TYPE_SIGNED_16BIT</CODE>. It has a value of <CODE>-25663</CODE>.</td> 184 </tr> 185 <tr> 186 <td width="100"> </td> 187 <th> 188<span class="argument"><a href="../../../nn/mic/CTR/TYPE_SIGNED_16BIT_GUARANTEED_INPUT_MAX.html"><CODE>TYPE_SIGNED_16BIT_GUARANTEED_INPUT_MAX</CODE></a></span> 189 </th> 190<td>Constant representing the maximum value of the guaranteed input range for microphone input values obtained with <CODE>SAMPLING_TYPE_SIGNED_16BIT</CODE>. It has a value of <CODE>25647</CODE>.</td> 191 </tr> 192 <tr> 193 <td width="100"> </td> 194 <th> 195<span class="argument"><a href="../../../nn/mic/CTR/AMP_GAIN_DEFAULT_VALUE.html"><CODE>AMP_GAIN_DEFAULT_VALUE</CODE></a></span> 196 </th> 197<td>Constant that indicates the initial value configured for microphone amp gain. Defined as <CODE>43</CODE> (32 dB). This value is configured even after calling the <a href="../../../nn/mic/CTR/Finalize.html"><CODE>nn::mic::CTR::Finalize</CODE></a> function.</td> 198 </tr> </table> 199 </div> 200 </a> <a name="function" id="function"> 201<h2>Functions</h2> 202 <div class="section"> 203 <table class="members"> 204 <tr> 205<th class="category" colspan="3">Other</th> 206 </tr> 207 <tr> 208 <td width="100"> </td> 209 <th> 210<a href="../../../nn/mic/CTR/Initialize.html"><CODE>Initialize</CODE></a> 211 </th> 212<td>Initializes the MIC library and enables the microphone for use.</td> 213 </tr> 214 <tr> 215 <td width="100"> </td> 216 <th> 217<a href="../../../nn/mic/CTR/Finalize.html"><CODE>Finalize</CODE></a> 218 </th> 219<td>Finalizes the MIC library.</td> 220 </tr> 221 <tr> 222 <td width="100"> </td> 223 <th> 224<a href="../../../nn/mic/CTR/SetBuffer.html"><CODE>SetBuffer</CODE></a> 225 </th> 226<td>Sets the memory region in which to store the sampling results.</td> 227 </tr> 228 <tr> 229 <td width="100"> </td> 230 <th> 231<a href="../../../nn/mic/CTR/ResetBuffer.html"><CODE>ResetBuffer</CODE></a> 232 </th> 233<td>Prevents the memory region that was set using <a href="../../../nn/mic/CTR/SetBuffer.html">nn::mic::CTR::SetBuffer</a> from being used by the mic library.</td> 234 </tr> 235 <tr> 236 <td width="100"> </td> 237 <th> 238<a href="../../../nn/mic/CTR/GetSamplingBufferSize.html"><CODE>GetSamplingBufferSize</CODE></a> 239 </th> 240<td>Returns the size of the sampling results that will be saved within the memory region set using <a href="../../../nn/mic/CTR/SetBuffer.html"><CODE>nn::mic::CTR::SetBuffer</CODE></a>.</td> 241 </tr> 242 <tr> 243 <td width="100"> </td> 244 <th> 245<a href="../../../nn/mic/CTR/StartSampling.html"><CODE>StartSampling</CODE></a> 246 </th> 247<td>Starts microphone auto-sampling.</td> 248 </tr> 249 <tr> 250 <td width="100"> </td> 251 <th> 252<a href="../../../nn/mic/CTR/StopSampling.html"><CODE>StopSampling</CODE></a> 253 </th> 254<td>Stops microphone auto-sampling.</td> 255 </tr> 256 <tr> 257 <td width="100"> </td> 258 <th> 259<a href="../../../nn/mic/CTR/AdjustSampling.html"><CODE>AdjustSampling</CODE></a> 260 </th> 261<td>Changes sampling rate in microphone auto-sampling.</td> 262 </tr> 263 <tr> 264 <td width="100"> </td> 265 <th> 266<a href="../../../nn/mic/CTR/IsSampling.html"><CODE>IsSampling</CODE></a> 267 </th> 268<td>Determines whether microphone sampling is currently under way.</td> 269 </tr> 270 <tr> 271 <td width="100"> </td> 272 <th> 273<a href="../../../nn/mic/CTR/GetLastSamplingAddress.html"><CODE>GetLastSamplingAddress</CODE></a> 274 </th> 275<td>Gets the address at which the most recent microphone sampling results are stored.</td> 276 </tr> 277 <tr> 278 <td width="100"> </td> 279 <th> 280<a href="../../../nn/mic/CTR/GetBufferFullEvent.html"><CODE>GetBufferFullEvent</CODE></a> 281 </th> 282<td>Gets the manually resetting event used to detect when the microphone buffer is full.</td> 283 </tr> 284 <tr> 285 <td width="100"> </td> 286 <th> 287<a href="../../../nn/mic/CTR/SetAmpGain.html"><CODE>SetAmpGain</CODE></a> 288 </th> 289<td>Sets the microphone amp's gain.</td> 290 </tr> 291 <tr> 292 <td width="100"> </td> 293 <th> 294<a href="../../../nn/mic/CTR/GetAmpGain.html"><CODE>GetAmpGain</CODE></a> 295 </th> 296<td>Gets the microphone amp's gain.</td> 297 </tr> 298 <tr> 299 <td width="100"> </td> 300 <th> 301<a href="../../../nn/mic/CTR/SetAmp.html"><CODE>SetAmp</CODE></a> 302 </th> 303<td>Sets the ON/OFF setting for power to the microphone.</td> 304 </tr> 305 <tr> 306 <td width="100"> </td> 307 <th> 308<a href="../../../nn/mic/CTR/GetAmp.html"><CODE>GetAmp</CODE></a> 309 </th> 310<td>Gets the ON/OFF setting for power to the microphone.</td> 311 </tr> 312 <tr> 313 <td width="100"> </td> 314 <th> 315<a href="../../../nn/mic/CTR/GetForbiddenArea.html"><CODE>GetForbiddenArea</CODE></a> 316 </th> 317<td>Gets the maximum and minimum values for the region within which it is prohibited to determine if there is microphone input. Avoid determining microphone input between these limits.</td> 318 </tr> 319 <tr> 320 <td width="100"> </td> 321 <th> 322<a href="../../../nn/mic/CTR/SetLowPassFilter.html"><CODE>SetLowPassFilter</CODE></a> 323 </th> 324<td>Sets the low-pass filter to apply to microphone input data.</td> 325 </tr> 326 <tr> 327 <td width="100"> </td> 328 <th> 329<a href="../../../nn/mic/CTR/SetClamp.html">SetClamp</a> 330 </th> 331<td>Configures whether microphone data will be clamped.</td> 332 </tr> 333 <tr> 334 <td width="100"> </td> 335 <th> 336<a href="../../../nn/mic/CTR/GetClamp.html">GetClamp</a> 337 </th> 338<td>Gets the clamping settings for microphone data.</td> 339 </tr> </table> 340 </div> 341 </a> 342<h2>Revision History</h2> 343 <div class="section"> 344 <dl class="history"> 345 <dt>2010/10/15</dt> 346<dd>Added SetClamp, GetClamp.<br /> 347 </dd> 348 <dt>2010/06/23</dt> 349<dd>Deleted <CODE>AllocateBuffer</CODE> and <CODE>FreeBuffer</CODE>. Added <CODE>SetBuffer</CODE>, <CODE>ResetBuffer</CODE>, and <CODE>GetSamplingBufferSize</CODE>.<br /> 350 </dd> 351 <dt>2010/01/07</dt> 352<dd>Initial version.<br /> 353 </dd> 354 </dl> 355 </div> 356 <hr><p>CONFIDENTIAL</p></body> 357</html>