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::mic::CTR</title> 49 </head> 50 <body> 51<h1><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/mic/Overview.html">mic</a>::CTR Namespace</h1> 52<h2>Description</h2> 53 <div class="section"> 54<p>The namespace of the <a href="../../../nn/mic/CTR/Overview.html">CTR</a> microphone library. (This namespace can also be written without the <CODE>::CTR</CODE> portion.)</p><p> 55If microphone sampling is running when the system is closed, it stops sampling automatically and will then resume sampling automatically when the system is opened. This behavior is unrelated to Sleep Mode: it is triggered when you open or close the system. 56 </p></div> 57 <a name="class" id="class"> 58<h2>Classes</h2> 59 <div class="section"> 60 <table class="members"> 61 <tr> 62<th class="category" colspan="2">Result</th> 63 </tr> 64 <tr> 65 <th> 66<a href="../../../nn/mic/CTR/ResultShellClose/Overview.html"><CODE>nn::mic::CTR::ResultShellClose</CODE></a> 67 </th> 68<td>The microphone cannot be used because the system is closed.</td> 69 </tr> 70 <tr> 71 <th> 72<a href="../../../nn/mic/CTR/ResultNotInitialized/Overview.html"><CODE>nn::mic::CTR::ResultNotInitialized</CODE></a> 73 </th> 74<td>A function was called prior to the requisite initialization.</td> 75 </tr> 76 <tr> 77 <th> 78<a href="../../../nn/mic/CTR/ResultAlreadyInitialized/Overview.html"><CODE>nn::mic::CTR::ResultAlreadyInitialized</CODE></a> 79 </th> 80<td>There was an attempt to run initialization even though this had already been done.</td> 81 </tr> 82 <tr> 83 <th> 84<a href="../../../nn/mic/CTR/ResultUsingOtherProcess/Overview.html"><CODE>nn::mic::CTR::ResultUsingOtherProcess</CODE></a> 85 </th> 86<td>The microphone library cannot be used because another process is using the microphone.</td> 87 </tr> 88 <tr> 89 <th> 90<a href="../../../nn/mic/CTR/ResultBusy/Overview.html"><CODE>nn::mic::CTR::ResultBusy</CODE></a> 91 </th> 92<td>Processing is not possible because microphone sampling is running.</td> 93 </tr> 94 <tr> 95 <th> 96<a href="../../../nn/mic/CTR/ResultMisalignedSize/Overview.html"><CODE>nn::mic::CTR::ResultMisalignedSize</CODE></a> 97 </th> 98<td>The specified size has an invalid alignment.</td> 99 </tr> 100 <tr> 101 <th> 102<a href="../../../nn/mic/CTR/ResultMisalignedAddress/Overview.html"><CODE>nn::mic::CTR::ResultMisalignedAddress</CODE></a> 103 </th> 104<td>The specified address has an invalid alignment.</td> 105 </tr> 106 <tr> 107 <th> 108<a href="../../../nn/mic/CTR/ResultOutOfMemory/Overview.html"><CODE>nn::mic::CTR::ResultOutOfMemory</CODE></a> 109 </th> 110<td>An invalid position was specified for the memory region that stores the sampling results.</td> 111 </tr> 112 <tr> 113 <th> 114<a href="../../../nn/mic/CTR/ResultInvalidSize/Overview.html"><CODE>nn::mic::CTR::ResultInvalidSize</CODE></a> 115 </th> 116<td>An invalid size was specified.</td> 117 </tr> 118 <tr> 119 <th> 120<a href="../../../nn/mic/CTR/ResultInvalidHandle/Overview.html"><CODE>nn::mic::CTR::ResultInvalidHandle</CODE></a> 121 </th> 122<td>The specified memory region is invalid.</td> 123 </tr> </table> 124 </div> 125 </a> <a name="enum" id="enum"> 126<h2>Enumerated Types</h2> 127 <div class="section"> 128 <table class="members"> 129 <tr> 130 <td width="100"> </td> 131 <th> 132<a href="../../../nn/mic/CTR/SamplingType.html"><CODE>SamplingType</CODE></a> 133 </th> 134<td>Enumerated type that indicates the microphone sampling type.</td> 135 </tr> 136 <tr> 137 <td width="100"> </td> 138 <th> 139<a href="../../../nn/mic/CTR/SamplingRate.html"><CODE>SamplingRate</CODE></a> 140 </th> 141<td>Enumerated type that indicates the microphone sampling rate.</td> 142 </tr> </table> 143 </div> 144 </a> <a name="constant" id="constant"> 145<h2>Constants</h2> 146 <div class="section"> 147 <table class="members"> 148 <tr> 149 <td width="100"> </td> 150 <th> 151<span class="argument"><a href="../../../nn/mic/CTR/AMP_GAIN_MAX.html"><CODE>AMP_GAIN_MAX</CODE></a></span> 152 </th> 153<td width="100"><CODE>const <a href="../../../nn_types/u8.html">u8</a></CODE></td> 154<td>Constant that indicates the maximum gain for the microphone amp. Defined as <CODE>119</CODE> (70.0 dB).</td> 155 </tr> 156 <tr> 157 <td width="100"> </td> 158 <th> 159<span class="argument"><a href="../../../nn/mic/CTR/AMP_GAIN_MIN.html"><CODE>AMP_GAIN_MIN</CODE></a></span> 160 </th> 161<td width="100"><CODE>const <a href="../../../nn_types/u8.html">u8</a></CODE></td> 162<td>Constant that indicates the maximum gain for the microphone amp. Defined as <CODE>0</CODE> (10.5 dB).</td> 163 </tr> 164 <tr> 165 <td width="100"> </td> 166 <th> 167<span class="argument"><a href="../../../nn/mic/CTR/BUFFER_ALIGNMENT_ADDRESS.html"><CODE>BUFFER_ALIGNMENT_ADDRESS</CODE></a></span> 168 </th> 169<td width="100"><CODE>const <a href="../../../nn_types/s32.html">s32</a></CODE></td> 170<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> 171 </tr> 172 <tr> 173 <td width="100"> </td> 174 <th> 175<span class="argument"><a href="../../../nn/mic/CTR/BUFFER_ALIGNMENT_SIZE.html"><CODE>BUFFER_ALIGNMENT_SIZE</CODE></a></span> 176 </th> 177<td width="100"><CODE>const <a href="../../../nn_types/s32.html">s32</a></CODE></td> 178<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> 179 </tr> 180 <tr> 181 <td width="100"> </td> 182 <th> 183<span class="argument"><a href="../../../nn/mic/CTR/SAMPLING_TYPE_8BIT_SILENT_DATA.html"><CODE>SAMPLING_TYPE_8BIT_SILENT_DATA</CODE></a></span> 184 </th> 185<td width="100"><CODE>const <a href="../../../nn_types/u8.html">u8</a></CODE></td> 186<td>Constant representing the silence value for <CODE>SAMPLING_TYPE_8BIT</CODE>.</td> 187 </tr> 188 <tr> 189 <td width="100"> </td> 190 <th> 191<span class="argument"><a href="../../../nn/mic/CTR/SAMPLING_TYPE_16BIT_SILENT_DATA.html"><CODE>SAMPLING_TYPE_16BIT_SILENT_DATA</CODE></a></span> 192 </th> 193<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 194<td>Constant representing the silence value for <CODE>SAMPLING_TYPE_16BIT</CODE>.</td> 195 </tr> 196 <tr> 197 <td width="100"> </td> 198 <th> 199<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> 200 </th> 201<td width="100"><CODE>const <a href="../../../nn_types/s8.html">s8</a></CODE></td> 202<td>Constant representing the silence value for <CODE>SAMPLING_TYPE_SIGNED_8BIT</CODE>.</td> 203 </tr> 204 <tr> 205 <td width="100"> </td> 206 <th> 207<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> 208 </th> 209<td width="100"><CODE>const <a href="../../../nn_types/s16.html">s16</a></CODE></td> 210<td>Constant representing the silence value for <CODE>SAMPLING_TYPE_SIGNED_16BIT</CODE>.</td> 211 </tr> 212 <tr> 213 <td width="100"> </td> 214 <th> 215<span class="argument"><a href="../../../nn/mic/CTR/TYPE_8BIT_GUARANTEED_INPUT_MIN.html"><CODE>TYPE_8BIT_GUARANTEED_INPUT_MIN</CODE></a></span> 216 </th> 217<td width="100"><CODE>const <a href="../../../nn_types/u8.html">u8</a></CODE></td> 218<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> 219 </tr> 220 <tr> 221 <td width="100"> </td> 222 <th> 223<span class="argument"><a href="../../../nn/mic/CTR/TYPE_8BIT_GUARANTEED_INPUT_MAX.html"><CODE>TYPE_8BIT_GUARANTEED_INPUT_MAX</CODE></a></span> 224 </th> 225<td width="100"><CODE>const <a href="../../../nn_types/u8.html">u8</a></CODE></td> 226<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> 227 </tr> 228 <tr> 229 <td width="100"> </td> 230 <th> 231<span class="argument"><a href="../../../nn/mic/CTR/TYPE_16BIT_GUARANTEED_INPUT_MIN.html"><CODE>TYPE_16BIT_GUARANTEED_INPUT_MIN</CODE></a></span> 232 </th> 233<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 234<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> 235 </tr> 236 <tr> 237 <td width="100"> </td> 238 <th> 239<span class="argument"><a href="../../../nn/mic/CTR/TYPE_16BIT_GUARANTEED_INPUT_MAX.html"><CODE>TYPE_16BIT_GUARANTEED_INPUT_MAX</CODE></a></span> 240 </th> 241<td width="100"><CODE>const <a href="../../../nn_types/u16.html">u16</a></CODE></td> 242<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> 243 </tr> 244 <tr> 245 <td width="100"> </td> 246 <th> 247<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> 248 </th> 249<td width="100"><CODE>const <a href="../../../nn_types/s8.html">s8</a></CODE></td> 250<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> 251 </tr> 252 <tr> 253 <td width="100"> </td> 254 <th> 255<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> 256 </th> 257<td width="100"><CODE>const <a href="../../../nn_types/s8.html">s8</a></CODE></td> 258<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> 259 </tr> 260 <tr> 261 <td width="100"> </td> 262 <th> 263<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> 264 </th> 265<td width="100"><CODE>const <a href="../../../nn_types/s16.html">s16</a></CODE></td> 266<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> 267 </tr> 268 <tr> 269 <td width="100"> </td> 270 <th> 271<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> 272 </th> 273<td width="100"><CODE>const <a href="../../../nn_types/s16.html">s16</a></CODE></td> 274<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> 275 </tr> 276 <tr> 277 <td width="100"> </td> 278 <th> 279<span class="argument"><a href="../../../nn/mic/CTR/AMP_GAIN_DEFAULT_VALUE.html"><CODE>AMP_GAIN_DEFAULT_VALUE</CODE></a></span> 280 </th> 281<td width="100"><CODE>const <a href="../../../nn_types/u8.html">u8</a></CODE></td> 282<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> 283 </tr> </table> 284 </div> 285 </a> <a name="function" id="function"> 286<h2>Functions</h2> 287 <div class="section"> 288 <table class="members"> 289 <tr> 290<th class="category" colspan="3">Other</th> 291 </tr> 292 <tr> 293 <td width="100"> </td> 294 <th> 295<a href="../../../nn/mic/CTR/Initialize.html"><CODE>Initialize</CODE></a> 296 </th> 297<td>Initializes the MIC library and enables the microphone for use.</td> 298 </tr> 299 <tr> 300 <td width="100"> </td> 301 <th> 302<a href="../../../nn/mic/CTR/Finalize.html"><CODE>Finalize</CODE></a> 303 </th> 304<td>Finalizes the MIC library.</td> 305 </tr> 306 <tr> 307 <td width="100"> </td> 308 <th> 309<a href="../../../nn/mic/CTR/SetBuffer.html"><CODE>SetBuffer</CODE></a> 310 </th> 311<td>Sets the memory region in which to store the sampling results.</td> 312 </tr> 313 <tr> 314 <td width="100"> </td> 315 <th> 316<a href="../../../nn/mic/CTR/ResetBuffer.html"><CODE>ResetBuffer</CODE></a> 317 </th> 318<td>Prevents the memory region set using <a href="../../../nn/mic/CTR/SetBuffer.html"><CODE>nn::mic::CTR::SetBuffer</CODE></a> from being used by the MIC library.</td> 319 </tr> 320 <tr> 321 <td width="100"> </td> 322 <th> 323<a href="../../../nn/mic/CTR/GetSamplingBufferSize.html"><CODE>GetSamplingBufferSize</CODE></a> 324 </th> 325<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> 326 </tr> 327 <tr> 328 <td width="100"> </td> 329 <th> 330<a href="../../../nn/mic/CTR/StartSampling.html"><CODE>StartSampling</CODE></a> 331 </th> 332<td>Starts microphone auto-sampling.</td> 333 </tr> 334 <tr> 335 <td width="100"> </td> 336 <th> 337<a href="../../../nn/mic/CTR/StopSampling.html"><CODE>StopSampling</CODE></a> 338 </th> 339<td>Stops microphone auto-sampling.</td> 340 </tr> 341 <tr> 342 <td width="100"> </td> 343 <th> 344<a href="../../../nn/mic/CTR/AdjustSampling.html"><CODE>AdjustSampling</CODE></a> 345 </th> 346<td>Changes the sampling rate for microphone auto-sampling.</td> 347 </tr> 348 <tr> 349 <td width="100"> </td> 350 <th> 351<a href="../../../nn/mic/CTR/IsSampling.html"><CODE>IsSampling</CODE></a> 352 </th> 353<td>Determines whether microphone sampling is currently under way.</td> 354 </tr> 355 <tr> 356 <td width="100"> </td> 357 <th> 358<a href="../../../nn/mic/CTR/GetLastSamplingAddress.html"><CODE>GetLastSamplingAddress</CODE></a> 359 </th> 360<td>Gets the address at which the most recent microphone sampling results are stored.</td> 361 </tr> 362 <tr> 363 <td width="100"> </td> 364 <th> 365<a href="../../../nn/mic/CTR/GetBufferFullEvent.html"><CODE>GetBufferFullEvent</CODE></a> 366 </th> 367<td>Gets the manually resetting event used to detect when the microphone buffer is full.</td> 368 </tr> 369 <tr> 370 <td width="100"> </td> 371 <th> 372<a href="../../../nn/mic/CTR/SetAmpGain.html"><CODE>SetAmpGain</CODE></a> 373 </th> 374<td>Sets the microphone amp's gain.</td> 375 </tr> 376 <tr> 377 <td width="100"> </td> 378 <th> 379<a href="../../../nn/mic/CTR/GetAmpGain.html"><CODE>GetAmpGain</CODE></a> 380 </th> 381<td>Gets the microphone amp's gain.</td> 382 </tr> 383 <tr> 384 <td width="100"> </td> 385 <th> 386<a href="../../../nn/mic/CTR/SetAmp.html"><CODE>SetAmp</CODE></a> 387 </th> 388<td>Sets the ON/OFF setting for power to the microphone.</td> 389 </tr> 390 <tr> 391 <td width="100"> </td> 392 <th> 393<a href="../../../nn/mic/CTR/GetAmp.html"><CODE>GetAmp</CODE></a> 394 </th> 395<td>Gets the ON/OFF setting for power to the microphone.</td> 396 </tr> 397 <tr> 398 <td width="100"> </td> 399 <th> 400<a href="../../../nn/mic/CTR/GetForbiddenArea.html"><CODE>GetForbiddenArea</CODE></a> 401 </th> 402<td>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.</td> 403 </tr> 404 <tr> 405 <td width="100"> </td> 406 <th> 407<a href="../../../nn/mic/CTR/SetLowPassFilter.html"><CODE>SetLowPassFilter</CODE></a> 408 </th> 409<td>Sets the low-pass filter to apply to microphone input data.</td> 410 </tr> 411 <tr> 412 <td width="100"> </td> 413 <th> 414<a href="../../../nn/mic/CTR/SetClamp.html"><CODE>SetClamp</CODE></a> 415 </th> 416<td>Configures whether to clamp microphone data.</td> 417 </tr> 418 <tr> 419 <td width="100"> </td> 420 <th> 421<a href="../../../nn/mic/CTR/GetClamp.html"><CODE>GetClamp</CODE></a> 422 </th> 423<td>Gets the clamping settings for microphone data.</td> 424 </tr> </table> 425 </div> 426 </a> 427<h2>Revision History</h2> 428 <div class="section"> 429 <dl class="history"> 430 <dt>2010/12/18</dt> 431<dd>Added <CODE>Result</CODE> values. Added a description of operations when the system is opened and closed. 432 </dd> 433 <dt>2010/10/15</dt> 434<dd>Added <CODE>SetClamp</CODE> and <CODE>GetClamp</CODE>.<br /> 435 </dd> 436 <dt>2010/06/23</dt> 437<dd>Deleted <CODE>AllocateBuffer</CODE> and <CODE>FreeBuffer</CODE>. Added <CODE>SetBuffer</CODE>, <CODE>ResetBuffer</CODE>, and <CODE>GetSamplingBufferSize</CODE>.<br /> 438 </dd> 439 <dt>2010/01/07</dt> 440<dd>Initial version.<br /> 441 </dd> 442 </dl> 443 </div> 444 <hr><p>CONFIDENTIAL</p></body> 445</html> 446