1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META name="GENERATOR" content="Microsoft FrontPage 5.0">
6<META http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8<BASE target="main">
9<TITLE>WPAD API Function List</TITLE>
10</HEAD>
11<BODY>
12
13<H1>WPAD API Function List</H1>
14<TABLE border="1">
15  <TBODY>
16    <TR>
17<TD><A href="./WPADInit.html"><code>WPADInit</code></A></TD>
18<TD>Initializes the WPAD library.</TD>
19    </TR>
20    <TR>
21<TD><A href="./WPADShutdown.html"><code>WPADShutdown</code></A></TD>
22<TD>Performs the WPAD library end process. Be sure to call this function when ending a game.</TD>
23    </TR>
24    <TR>
25<TD><A href="./WPADRegisterAllocator.html"><code>WPADRegisterAllocator</code></A></TD>
26<TD>Registers the allocator used when the library allocates work memory. The library uses this registered allocator to allocate memory only at initialization.
27    </TD>
28    </TR>
29    <TR>
30      <TD><A href="./WPADGetWorkMemorySize.html"><code>WPADGetWorkMemorySize</code></A></TD>
31      <TD>Returns the size of the work memory allocated by the library.
32    </TD>
33    </TR>
34    <TR>
35<TD><A href="./WPADProbe.html"><code>WPADProbe</code></A></TD>
36<TD>Checks the specified channel's status and controller type.</TD>
37    </TR>
38    <TR>
39<TD><A href="./WPADGetStatus.html"><code>WPADGetStatus</code></A></TD>
40<TD>Gets the usage status of library.</TD>
41    </TR>
42    <TR>
43<TD><A href="./WPADSetSamplingCallback.html"><code>WPADSetSamplingCallback</code></A></TD>
44<TD>Registers a callback function that is called each time data is received from the Wii Remote (about every 5 milliseconds) at the specified channel.</TD>
45    </TR>
46<TD><A href="./WPADSetConnectCallback.html"><code>WPADSetConnectCallback</code></A></TD>
47<TD>Registers the callback function that is called when the Wii Remote for the specified channel is connected or disconnected.</TD>
48    </TR>
49<TD><A href="./WPADSetExtensionCallback.html"><code>WPADSetExtensionCallback</code></A></TD>
50<TD>Registers the callback function that is called when an external expansion controller is inserted into or removed from a Wii Remote at the specified channel.</TD>
51    </TR>
52    <TR>
53<TD><A href="./WPADButtonDown.html"><code>WPADButtonDown</code></A></TD>
54<TD>Detects whether button(s) have been pressed.</TD>
55    </TR>
56    <TR>
57<TD><A href="./WPADButtonUp.html"><code>WPADButtonUp</code></A></TD>
58<TD>Detects whether button(s) have been released.</TD>
59    </TR>
60    <TR>
61<TD><A href="./WPADGetDataFormat.html"><code>WPADGetDataFormat</code></A></TD>
62<TD>Gets the data format type of the received data.</TD>
63    </TR>
64    <TR>
65<TD><A href="./WPADSetDataFormat.html"><code>WPADSetDataFormat</code></A></TD>
66<TD>Specifies the data format type of the received data. Some time is required before the received data format is changed.</TD>
67    </TR>
68    <TR>
69<TD><A href="./WPADIsDpdEnabled.html"><code>WPADIsDpdEnabled</code></A></TD>
70<TD>Checks whether the pointer for the Wii Remote for the specified channel is working.</TD>
71    </TR>
72    <TR>
73<TD><A href="./WPADControlDpd.html"><code>WPADControlDpd</code></A></TD>
74<TD>Controls the pointer for the Wii Remote of the specified channel.</TD>
75    </TR>
76    <TR>
77<TD><A href="./WPADRead.html"><code>WPADRead</code></A></TD>
78<TD>Gets the most recent controller status of the Wii Remote of the specified channel.</TD>
79    </TR>
80    <TR>
81<TD><A href="./WPADSetAutoSamplingBuf.html"><code>WPADSetAutoSamplingBuf</code></A></TD>
82<TD>Registers a buffer to store the controller status of the Wii Remote for the specified channel each time data is received (about once every 5 milliseconds).</TD>
83    </TR>
84    <TR>
85<TD><A href="./WPADGetLatestIndexInBuf.html"><code>WPADGetLatestIndexInBuf</code></A></TD>
86<TD>Obtains the index of the ring buffer where the most recent standard controller status is stored.</TD>
87    </TR>
88    <TR>
89<TD><A href="./WPADGetAccGravityUnit.html"><code>WPADGetAccGravityUnit</code></A></TD>
90      <TD>Gets the per unit quantity of gravity acceleration for the motion sensor for either the Wii Remote or the Nunchuk unit for the specified channel.</TD>
91    </TR>
92    <TR>
93      <TD><A href="./WPADGetCLTriggerThreshold.html"><code>WPADGetCLTriggerThreshold</code></A></TD>
94      <TD>Gets the lower limit when clamping the L and R trigger buttons of the classic controller unit on the specified channel. </TD>
95    </TR>
96    <TR>
97<TD><A href="./WPADClampStick.html"><code>WPADClampStick</code></A></TD>
98      <TD>Clamps analog stick input of Nunchuk unit and the Classic controller unit.</TD>
99    </TR>
100    <TR>
101      <TD><A href="./WPADClampTrigger.html"><code>WPADClampTrigger</code></A></TD>
102      <TD>Clamps the analog trigger inputs of a Classic controller unit.</TD>
103    </TR>
104    <TR>
105      <TD><A href="./WPADClampAcc.html"><code>WPADClampAcc</code></A></TD>
106      <TD>Clamps the motion sensor inputs of the Nunchuk unit and the Wii Remote. </TD>
107    </TR>
108    <TR>
109<TD><A href="./WPADDisconnect.html"><code>WPADDisconnect</code></A></TD>
110<TD>Disconnects the controller for the specified channel.</TD>
111    </TR>
112    <TR>
113<TD><A href="./WPADGetInfo.html"><code>WPADGetInfo</code></A></TD>
114<TD>Gets the current information of the Wii Remote.</TD>
115    </TR>
116    <TR>
117<TD><A href="./WPADGetInfoAsync.html"><code>WPADGetInfoAsync</code></A></TD>
118<TD>Gets the current information of the Wii Remote.</TD>
119    </TR>
120    <TR>
121<TD><A href="./WPADGetAddress.html"><code>WPADGetAddress</code></A></TD>
122<TD>Gets the unique ID of the Wii Remote for the specified channel.</TD>
123    </TR>
124    <TR>
125      <TD><A href="./WPADGetRadioSensitivity.html"><code>WPADGetRadioSensitivity</code></A></TD>
126      <TD>Gets the radio sensitivity of the Wii Remote on the specified channel.</TD>
127    </TR>
128    <TR>
129<TD><A href="./WPADGetRegisteredDevNum.html"><code>WPADGetRegisteredDevNum</code></A></TD>
130<TD>Gets the number of Wii Remotes registered to the Wii console.</TD>
131    </TR>
132    <TR>
133<TD><A href="./WPADSetDisableChannel.html"><code>WPADSetDisableChannel</code></A></TD>
134<TD>Specifies a frequency not to be used for wireless communication for the controllers to avoid interference with wireless LANs.
135    </TR>
136    <TR>
137<TD><A href="./WPADStartSyncDevice.html"><code>WPADStartSyncDevice</code></A></TD>
138<TD>Begins the registration process required to use the Wii Remote.</TD>
139    </TR>
140    <TR>
141<TD><A href="./WPADStartClearDevice.html"><code>WPADStartClearDevice</code></A></TD>
142<TD>Deletes all the Wii Remote information registered on the Wii console.</TD>
143    </TR>
144    <TR>
145      <TD><A href="./WPADStartSimpleSync.html"><code>WPADStartSimpleSync</code></A></TD>
146      <TD>Begins the simple pairing process required to use the Wii Remote temporarily.</TD>
147    </TR>
148    <TR>
149      <TD><A href="./WPADStopSimpleSync.html"><code>WPADStopSimpleSync</code></A></TD>
150      <TD>Terminates simple pairing. </TD>
151    </TR>
152    <TR>
153<TD><A href="./WPADSetSyncDeviceCallback.html"><code>WPADSetSyncDeviceCallback</code></A></TD>
154<TD>Sets the callback called when the SYNCHRO button is pressed and when pairing is completed. If no callback is set, <A href="./WPADStartSyncDevice.html"><code>WPADStartSyncDevice</code></a> is automatically called.</TD>
155    </TR>
156    <TR>
157<TD><A href="./WPADSetClearDeviceCallback.html"><code>WPADSetClearDeviceCallback</code></A></TD>
158<TD>Sets the callback called when the SYNCHRO button is pressed for more than 10 seconds and when deletion completes. If no callback has been set, <A href="./WPADStartClearDevice.html"><code>WPADStartClearDevice</code></a> is automatically called.</TD>
159    </TR>
160    <TR>
161      <TD><A href="./WPADSetSimpleSyncCallback.html"><code>WPADSetSimpleSyncCallback</code></A></TD>
162      <TD>Sets the callback to be called when simple pairing has ended.</TD>
163    </TR>
164  </TBODY>
165</TABLE>
166
167<H3>Rumble Motor</H3>
168<TABLE border="1">
169  <TBODY>
170    <TR>
171<TD><A href="./WPADControlMotor.html"><code>WPADControlMotor</code></A></TD>
172<TD>Controls the rumble motor of the Wii Remote for the specified channel.</TD>
173    </TR>
174    <TR>
175<TD><A href="./WPADStartMotor.html"><code>WPADStartMotor</code></A></TD>
176<TD>Begins vibration on the Wii Remote of the specified channel.</TD>
177    </TR>
178    <TR>
179<TD><A href="./WPADStopMotor.html"><code>WPADStopMotor</code></A></TD>
180<TD>Stops vibration on the Wii Remote for the specified channel.</TD>
181    </TR>
182    <TR>
183      <TD><A href="./WPADEnableMotor.html"><code>WPADEnableMotor</code></A></TD>
184      <TD>Turns the Rumble Feature of the Wii Remote ON/OFF.</TD>
185    </TR>
186    <TR>
187      <TD><A href="./WPADIsMotorEnabled.html"><code>WPADIsMotorEnabled</code></A></TD>
188      <TD>Gets the current ON/OFF status of the Rumble Feature of the Wii Remote.</TD>
189    </TR>
190  </TBODY>
191</TABLE>
192
193<H3>Speaker</H3>
194<TABLE border="1">
195  <TBODY>
196    <TR>
197      <TD><A href="./WPADIsSpeakerEnabled.html"><code>WPADIsSpeakerEnabled</code></A></TD>
198      <TD>Checks whether the speaker of the Wii Remote on the specified channel is operational. </TD>
199    </TR>
200    <TR>
201      <TD><A href="./WPADControlSpeaker.html"><code>WPADControlSpeaker</code></A></TD>
202      <TD>Controls the speaker of the Wii Remote on the specified channel.</TD>
203    </TR>
204    <TR>
205      <TD><A href="./WPADGetSpeakerVolume.html"><code>WPADGetSpeakerVolume</code></A></TD>
206      <TD>Gets the volume of the Wii Remote speaker.</TD>
207    </TR>
208    <TR>
209      <TD><A href="./WPADSetSpeakerVolume.html"><code>WPADSetSpeakerVolume</code></A></TD>
210      <TD>Sets the volume of the Wii Remote speaker.</TD>
211    </TR>
212    <TR>
213      <TD><A href="./WPADSendStreamData.html"><code>WPADSendStreamData</code></A></TD>
214      <TD>Sends audio data to the Wii Remote on the specified channel. </TD>
215    </TR>
216  </TBODY>
217</TABLE>
218
219<H3>Internal Memory</H3>
220<TABLE border="1">
221  <TBODY>
222    <TR>
223      <TD><A href="./WPADReadGameData.html"><code>WPADReadGameData</code></A></TD>
224      <TD>Reads game data stored in internal memory.</TD>
225    </TR>
226    <TR>
227      <TD><A href="./WPADWriteGameData.html"><code>WPADWriteGameData</code></A></TD>
228      <TD>Saves game data in internal memory.</TD>
229    </TR>
230    <TR>
231      <TD><A href="./WPADSetGameTitle.html"><code>WPADSetGameTitle</code></A></TD>
232      <TD>Registers the game title in the file information for game data saved in internal memory. </TD>
233    </TR>
234    <TR>
235      <TD><A href="./WPADSetGameTitleWChar.html"><code>WPADSetGameTitleWChar</code></A></TD>
236      <TD>Registers the game title (two-byte character code) in the file information for game data saved in internal memory. </TD>
237    </TR>
238    <TR>
239      <TD><A href="./WPADGetGameTitle.html"><code>WPADGetGameTitle</code></A></TD>
240      <TD>Registers the game title from the file information for game data saved in internal memory. </TD>
241    </TR>
242    <TR>
243      <TD><A href="./WPADGetGameDataTimeStamp.html"><code>WPADGetGameDataTimeStamp</code></A></TD>
244      <TD>Gets the date/time stamp from the file information for game data saved in internal memory. </TD>
245    </TR>
246  </TBODY>
247</TABLE>
248
249<H3>Config</H3>
250<TABLE border="1">
251  <TBODY>
252    <TR>
253      <TD><A href="./WPADSaveConfig.html"><code>WPADSaveConfig</code></A></TD>
254      <TD>Records the Rumble Feature setting and speaker volume setting of the Wii Remote on the specified channel in the internal flash memory of the Wii Console.</TD>
255    </TR>
256    <TR>
257      <TD><A href="./WPADSetAutoSleepTime.html"><code>WPADSetAutoSleepTime</code></A></TD>
258      <TD>Sets the timeout for automatically disconnecting a Wii Remote that is not sending input to the Wii Console. </TD>
259    </TR>
260    <TR>
261      <TD><A href="./WPADGetSensorBarPosition.html"><code>WPADGetSensorBarPosition</code></A></TD>
262      <TD>Determines whether the sensor bar is installed above or below the television. </TD>
263    </TR>
264  </TBODY>
265</TABLE>
266
267<H3>Types and Structures</H3>
268<TABLE border="1">
269  <TBODY>
270    <TR>
271<TD><A href="./WPADStatus.html"><code>WPADStatus</code></A></TD>
272<TD>Structure for the controller status of the Wii Remote.</TD>
273    </TR>
274    <TR>
275<TD><A href="./WPADFSStatus.html"><code>WPADFSStatus</code></A></TD>
276<TD>Structure for the Nunchuk controller status.</TD>
277    </TR>
278    <TR>
279<TD><A href="./WPADCLStatus.html"><code>WPADCLStatus</code></A></TD>
280<TD>Structure for the Classic controller status.</TD>
281    </TR>
282    <TR>
283      <TD><A href="./WPADStatusEx.html"><code>WPADStatusEx</code></A></TD>
284      <TD>Structure for the extended controller status of the Wii Remote.</TD>
285    </TR>
286    <TR>
287      <TD><A href="./WPADInfo.html"><code>WPADInfo</code></A></TD>
288      <TD>Structure for the Wii Remote status.</TD>
289    </TR>
290  </TBODY>
291</TABLE>
292<br>
293<hr>
294
295<hr>
296<P>CONFIDENTIAL</p>
297</BODY>
298</HTML>
299