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>PMICSetEcReset</title>
9</head>
10
11<body>
12
13<h1>PMICSetEcReset</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 PMICSetEcReset(u16 state);
24</pre></dd></dl>
25
26<h2>Arguments</h2>
27<TABLE class="arguments" border="1" >
28  <tr>
29    <th>state</th>
30    <td>Sets the reset state (ON/OFF) for the Wii Speak's echo canceler.</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>PMIC_ERR_OK</th>
42    <td>The reset state was set successfully.</td>
43  </tr>
44  <tr>
45    <th>PMIC_ERR_INVALID_ARGUMENTS</th>
46    <td>The correct argument was not passed.</td>
47  </tr>
48  <tr>
49    <th>PMIC_ERR_NO_DEVICE</th>
50    <td>The Wii Speak has been unplugged.</td>
51  </tr>
52  <tr>
53    <th>PMIC_ERR_INVALID_STATE</th>
54    <td>The Wii Speak is not open.</td>
55  </tr>
56  <tr>
57    <th>PMIC_ERR_BUSY</th>
58    <td>Cannot register the command. Call the function again.</td>
59  </tr>
60  <tr>
61    <th>PMIC_ERR_USB_ERROR</th>
62    <td>An error occurred in USB communications. Call the function again.</td>
63  </tr>
64  <tr>
65    <th>PMIC_ERR_FATAL</th>
66    <td>A fatal error has occurred.</td>
67  </tr>
68</TABLE>
69
70<H2>Description</H2>
71<p>Synchronously sets the reset state (ON/OFF) for the Wii Speak's echo canceler.</p>
72
73<p>The echo canceler will be reset automatically if the <code>PMICStart</code> or <code>PMICStartAsync</code> function is called to start the Wii Speak, so you do not normally need to use this function.</p>
74
75<p>However, the echo canceler will sometimes stop functioning properly if, for example, packets are lost and the other party's voice is interrupted during voice chat. At such times, use this function to reset the echo canceler. This allows you to return the echo canceler to a normal state without stopping the Wii Speak.</p>
76
77<p>Call this function twice in the following order to reset the echo canceler.</p>
78
79<dl><dd><pre class="construction">
80(1) PMICSetEcReset(PMIC_EC_RESET_ON);
81(2) PMICSetEcReset(PMIC_EC_RESET_OFF);
82</pre></dd></dl>
83
84<p>After the echo canceler is reset, it will take several seconds to begin having an effect on the echoes.</p>
85
86<H2>See Also</H2>
87<p class="reference">
88<a href="PMICStartAsync.html"><CODE>PMICStartAsync</CODE></a><BR> <a href="PMICStart.html"><CODE>PMICStart</CODE></a>
89</p>
90
91<H2>Revision History</H2>
92<p>
932008/10/24 Added to <B>Return Values</B> and <B>Description</B>.<br> 2008/10/22 Initial version.
94</p>
95<hr><p>CONFIDENTIAL</p></body>
96</html>