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>PMICSetSpState</title>
9</head>
10
11<body>
12
13<h1>PMICSetSpState</h1>
14
15<h2>Syntax</h2>
16<dl><dd><pre class="construction">
17#include &lt;revolution/pmic.h&gt;
18
19// Signal processing state
20#define PMIC_SP_ON                   0x0000
21#define PMIC_SP_OFF                  0x0001
22
23PMIC_ERR PMICSetSpState(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 ON/OFF state of the Wii Speak's signal processor.</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 signal processor state has been 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 ON/OFF state of the Wii Speak's signal processor.</p>
72
73<p>Specify the state of the signal processor in the <SPAN class="argument">state</SPAN> argument. To enable the signal processor, set <SPAN class="argument">state</SPAN> to <code>PMIC_SP_ON</code>. To disable the signal processor, set it to <code>PMIC_SP_OFF</code>. When the signal processor is disabled, the echo canceler is disabled so you can get raw data. The default state of the signal processor is <code>PMIC_SP_ON</code>.</p>
74
75<p>This function can be called when the Wii Speak is in the STOP state.</p>
76
77<H2>See Also</H2>
78
79<H2>Revision History</H2>
80<p>
812009/06/11 Revised <B>Description</B>.<br>2008/10/24 Added to <B>Return Values</B> and <B>Description</B>.<br>2008/07/04 Revised the description of <code>PMIC_ERR_INVALID_STATE</code>.<br>2008/04/24 Initial version.
82</p>
83
84<hr><p>CONFIDENTIAL</p></body>
85
86</html>
87