1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>MIC_StartAutoSampling</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">MIC_StartAutoSampling <img src="../../image/NTR.gif"></h1>
15
16<h2>Syntax</h2>
17<dl>
18  <dd>
19<CODE>#include &lt;nitro/spi.h&gt;</CODE><BR>
20  <PRE><CODE><A href="MICResult.html">MICResult</A> MIC_StartAutoSampling(
21            const <CODE><A href="MICAutoParam.html">MICAutoParam</A></CODE>*    param );</CODE></PRE>
22  </dd>
23</dl>
24
25<h2>Arguments</h2>
26<TABLE border="1" width="100%">
27  <TBODY>
28    <TR>
29      <TD width="300"><em><strong><font face="Courier New">param</font></strong></em></TD>
30      <TD width="700">Specifies a pointer to a <CODE><A href="MICAutoParam.html">MICAutoParam</A></CODE>-type auto-sampling settings structure.</TD>
31    </TR>
32  </TBODY>
33</TABLE>
34
35<h2>Return Values</h2>
36<P>
37Returns the processing result as a <CODE><A href="MICResult.html">MICResult</A></CODE> enumerated type. Returns <CODE>MIC_RESULT_SUCCESS</CODE> if processing completes successfully, and some other value if the process fails for some reason.
38</P>
39
40<H2>Description</H2>
41<P>
42Starts microphone auto-sampling. This function issues a request to the ARM7 processor to start auto-sampling, waits for ARM7 to respond, and returns the process result. This is a synchronous version of the <CODE><A href="MIC_StartAutoSamplingAsync.html">MIC_StartAutoSamplingAsync</A></CODE> function. Where the input volume exceeds the minimum or maximum value, the output data will be clamped. It is possible to use the <CODE><A href="../pm/PM_SetAmpGain.html">PM_SetAmpGain*</A></CODE> functions to adjust the input volume that can be sampled.
43</P>
44<P>
45This function will return <CODE>MIC_RESULT_INVALID_COMMAND</CODE> when the CODEC is running in CODEC-TWL mode, because auto-sampling cannot be run at an arbitrary frequency in CODEC-TWL mode.
46</P>
47
48<H2>Note</H2>
49<P>
50<FONT color=red>This function waits for a PXI interrupt for synchronization purposes. Do not call it when PXI interrupts are prohibited.<BR> <BR> It is possible to operate other ARM7 processor peripherals (SPI device) during microphone auto-sampling. However, note that if another SPI device had taken over the access for a long time, the microphone would keep returning a certain value during that time.</FONT><FONT color=red><BR></FONT>
51</P>
52
53<H2>See Also</H2>
54<P>
55<a href="MIC_StartAutoSampling.html"><code>MIC_StartAutoSampling</code></a>, <a href="MIC_StopAutoSampling.html"><code>MIC_StopAutoSampling</code></a>, <a href="MIC_AdjustAutoSampling.html"><code>MIC_AdjustAutoSampling</code></a>, <a href="../pm/PM_SetAmpGain.html"><code>PM_SetAmpGain</code></a>
56</P>
57
58<H2>Revision History</H2>
59<P>
602008/01/09 Revised a description of differences in behavior due to the CODEC mode. <BR>2007/11/07 Added a description of operations on the TWL platform. <BR>2005/03/08 Standardized Japanese terminology for &quot;interrupt.&quot; <br>2005/01/11 Revised <B>Return Values</B> and <B>Description</B>, and added functions to <B>See Also</B>. <BR>2004/09/17 Changed the type of the <CODE>param</CODE> argument. <BR>2004/08/10 Added explanations related to input volume, and touch panel sampling during microphone auto-sampling. <BR>2004/06/01 Initial version.<BR>
61</P>
62<hr><p>CONFIDENTIAL</p></body>
63</html>
64