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