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 http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8<title>PMICGetEcReset</title>
9</head>
10
11<body>
12
13<h1>PMICGetEcReset</h1>
14
15<h2>Syntax</h2>
16<dl><dd><pre class="construction">
17#include &lt;revolution/pmic.h&gt;
18
19// Echo Canceller Reset State
20#define PMIC_EC_RESET_ON             0x0001
21#define PMIC_EC_RESET_OFF            0x0000
22
23PMIC_ERR PMICGetEcReset(u16* state);
24</pre></dd></dl>
25
26<h2>Arguments</h2>
27<TABLE class="arguments" border="1" >
28  <tr>
29<th><CODE>state</CODE></th>
30<td>Location to store the echo canceler's reset state (ON/OFF), which is received from the Wii Speak.</td>
31  </tr>
32</TABLE>
33
34<h2>Return Values</h2>
35<p>
36Returns one of the following.
37</p>
38
39<TABLE class="arguments" border="1">
40  <tr>
41<th><CODE>PMIC_ERR_OK</CODE></th>
42<td>The reset state was obtained successfully.</td>
43  </tr>
44  <tr>
45<th><CODE>PMIC_ERR_INVALID_ARGUMENTS</CODE></th>
46<td>The correct argument was not passed.</td>
47  </tr>
48  <tr>
49<th><CODE>PMIC_ERR_NO_DEVICE</CODE></th>
50<td>The Wii Speak has been unplugged.</td>
51  </tr>
52  <tr>
53<th><CODE>PMIC_ERR_INVALID_STATE</CODE></th>
54<td>The Wii Speak is not open.</td>
55  </tr>
56  <tr>
57<th><CODE>PMIC_ERR_BUSY</CODE></th>
58<td>Cannot register the command. Call the function again.</td>
59  </tr>
60  <tr>
61<th><CODE>PMIC_ERR_USB_ERROR</CODE></th>
62<td>An error occurred in USB communications. Call the function again.</td>
63  </tr>
64  <tr>
65<th><CODE>PMIC_ERR_FATAL</CODE></th>
66<td>A fatal error has occurred.</td>
67  </tr>
68</TABLE>
69
70<H2>Description</H2>
71<p>Synchronously gets the reset state (ON/OFF) for the Wii Speak's echo canceler.</p>
72
73<p>This function stores the reset state at the address specified by the <SPAN class="argument">state</SPAN> argument. A value of <code>PMIC_EC_RESET_ON</code> is stored if resets are enabled, and <code>PMIC_EC_RESET_OFF</code> is stored if resets are disabled. The Wii Speak's echo canceler runs normally when the state is <code>PMIC_EC_RESET_OFF</code>.</p>
74
75<H2>See Also</H2>
76
77<H2>Revision History</H2>
78<p>
792008/12/22 Standardized terminology.<br>2008/10/24 Revised <B>Description</B>.<br>2008/10/23 Revised return values.<br>2008/10/22 Initial version.
80</p>
81
82<hr><p>CONFIDENTIAL</p></body>
83
84</html>
85