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 Function List</TITLE>
10</HEAD>
11<BODY>
12
13<H1>WPAD Function List</H1>
14<H3><a name="Wpad">Wii Remote Controller</a></H3>
15<TABLE border="1">
16  <TBODY>
17    <TR>
18<TD><A href="./WPADInit.html"><code>WPADInit</code></A></TD>
19<TD>Initializes the WPAD library.</TD>
20    </TR>
21    <TR>
22<TD><A href="./WPADShutdown.html"><code>WPADShutdown</code></A></TD>
23<TD>Executes the WPAD library end process. Be sure to call this function when exiting a game.<font color="red">* Obsolete.</font></TD>
24    </TR>
25    <TR>
26<TD><A href="./WPADReconnect.html"><code>WPADReconnect</code></A></TD>
27<TD>Executes the WPAD library end process. Be sure to call this function when you want to automatically reconnect from the Wii Remote controller after restarting a game. <font color="red">* Obsolete.</font></TD>
28    </TR>
29    <TR>
30<TD><A href="./WPADRegisterAllocator.html"><code>WPADRegisterAllocator</code></A></TD>
31<TD>Registers the allocator used when the library allocates work memory. The library uses the allocator registered by this function to allocate memory only at initialization.
32  </TD>
33    </TR>
34    <TR>
35<TD><A href="./WPADGetWorkMemorySize.html"><code>WPADGetWorkMemorySize</code></A></TD>
36<TD>Returns the size of the work memory allocated by the library.
37  </TD>
38    </TR>
39    <TR>
40<TD><A href="./WPADProbe.html"><code>WPADProbe</code></A></TD>
41<TD>Checks the specified channel's status and controller type.</TD>
42    </TR>
43    <TR>
44<TD><A href="./WPADGetStatus.html"><code>WPADGetStatus</code></A></TD>
45<TD>Gets the usage status of the library.</TD>
46    </TR>
47    <TR>
48<TD><A href="./WPADGetDataFormat.html"><code>WPADGetDataFormat</code></A></TD>
49<TD>Gets the data format type of the received data.</TD>
50    </TR>
51    <TR>
52<TD><A href="./WPADSetDataFormat.html"><code>WPADSetDataFormat</code></A></TD>
53<TD>Specifies the data format type of the received data. Some time is required before the received data format is changed.</TD>
54    </TR>
55    <TR>
56<TD><A href="./WPADRead.html"><code>WPADRead</code></A></TD>
57<TD>Gets the most recent controller status of the Wii Remote controller of the specified channel.</TD>
58    </TR>
59    <TR>
60<TD><A href="./WPADSetAutoSamplingBuf.html"><code>WPADSetAutoSamplingBuf</code></A></TD>
61<TD>Registers a buffer to store the controller status of the Wii Remote controller for the specified channel each time data is received (about once every 5&nbsp;milliseconds).</TD>
62    </TR>
63    <TR>
64<TD><A href="./WPADGetLatestIndexInBuf.html"><code>WPADGetLatestIndexInBuf</code></A></TD>
65<TD>Obtains the index of the ring buffer where the most recent standard controller status is stored.</TD>
66    </TR>
67    <TR>
68<TD><A href="./WPADGetAccGravityUnit.html"><code>WPADGetAccGravityUnit</code></A></TD>
69<TD>Gets the per-unit quantity of gravity acceleration for the Motion Sensor of either the Wii Remote controller or the Nunchuk controller for the specified channel.</TD>
70    </TR>
71    <TR>
72<TD><A href="./WPADGetCLTriggerThreshold.html"><code>WPADGetCLTriggerThreshold</code></A></TD>
73<TD>Gets the lower limit when clamping the L Button and R Button of the Classic Controller on the specified channel.</TD>
74    </TR>
75    <TR>
76<TD><A href="./WPADSetSamplingCallback.html"><code>WPADSetSamplingCallback</code></A></TD>
77<TD>Registers a callback function that is called each time data is received from the Wii Remote controller (about every 5 milliseconds) at the specified channel.</TD>
78    </TR>
79    <TR>
80<TD><A href="./WPADSetConnectCallback.html"><code>WPADSetConnectCallback</code></A></TD>
81<TD>Registers the callback function that is called when the Wii Remote controller for the specified channel is connected or disconnected.</TD>
82    </TR>
83    <TR>
84<TD><A href="./WPADSetExtensionCallback.html"><code>WPADSetExtensionCallback</code></A></TD>
85<TD>Registers the callback function that is called when an external extension controller is plugged into or unplugged from a Wii Remote controller on the specified channel.</TD>
86    </TR>
87    <TR>
88<TD><A href="./WPADButtonDown.html"><code>WPADButtonDown</code></A></TD>
89<TD>Detects whether button(s) have been pressed.</TD>
90    </TR>
91    <TR>
92<TD><A href="./WPADButtonUp.html"><code>WPADButtonUp</code></A></TD>
93<TD>Detects whether button(s) have been released.</TD>
94    </TR>
95    <TR>
96<TD><A href="./WPADClampStick.html"><code>WPADClampStick</code></A></TD>
97<TD>Clamps Control Stick input of the Nunchuk controller and the L Button and R Button of the Classic Controller.</TD>
98    </TR>
99    <TR>
100<TD><A href="./WPADClampTrigger.html"><code>WPADClampTrigger</code></A></TD>
101<TD>Clamps the L Button and R Button inputs of a Classic Controller.</TD>
102    </TR>
103    <TR>
104<TD><A href="./WPADClampAcc.html"><code>WPADClampAcc</code></A></TD>
105<TD>Clamps the Motion Sensor inputs of the Nunchuk controller and the Wii Remote controller.</TD>
106    </TR>
107    <TR>
108<TD><A href="./WPADIsDpdEnabled.html"><code>WPADIsDpdEnabled</code></A></TD>
109<TD>Checks whether the Pointer of the Wii Remote controller for the specified channel is working.</TD>
110    </TR>
111    <TR>
112<TD><A href="./WPADControlDpd.html"><code>WPADControlDpd</code></A></TD>
113<TD>Controls the Pointer of the Wii Remote controller of the specified channel.</TD>
114    </TR>
115    <TR>
116<TD><A href="./WPADGetDpdFormat.html"><code>WPADGetDpdFormat</code></A></TD>
117<TD>Gets the data format of the Pointer of the Wii Remote controller on the specified channel.</TD>
118    </TR>
119    <TR>
120<TD><A href="./WPADGetDpdSensitivity.html"><code>WPADGetDpdSensitivity</code></A></TD>
121<TD>Gets the sensitivity of the Pointer of the Wii Remote controller on the specified channel.</TD>
122    </TR>
123    <TR>
124<TD><A href="./WPADSetDpdSensitivity.html"><code>WPADSetDpdSensitivity</code></A></TD>
125<TD>Sets the sensitivity of the Pointer of the Wii Remote controller on the specified channel.</TD>
126    </TR>
127    <TR>
128<TD><A href="./WPADControlExtGimmick.html"><code>WPADControlExtGimmick</code></A></TD>
129<TD>Controls the gimmicks (mechanisms) of the external extension controller plugged into the Wii Remote controller of the specified channel.</TD>
130    </TR>
131    <TR>
132<TD><A href="./WPADDisconnect.html"><code>WPADDisconnect</code></A></TD>
133<TD>Disconnects the controller for the specified channel.</TD>
134    </TR>
135    <TR>
136<TD><A href="./WPADGetInfo.html"><code>WPADGetInfo</code></A></TD>
137<TD>Gets Wii Remote controller's current information.</TD>
138    </TR>
139    <TR>
140<TD><A href="./WPADGetInfoAsync.html"><code>WPADGetInfoAsync</code></A></TD>
141<TD>Gets Wii Remote controller's current information.</TD>
142    </TR>
143    <TR>
144<TD><A href="./WPADGetAddress.html"><code>WPADGetAddress</code></A></TD>
145<TD>Gets the unique ID of the Wii Remote controller for the specified channel.</TD>
146    </TR>
147    <TR>
148<TD><A href="./WPADGetSyncType.html"><code>WPADGetSyncType</code></A></TD>
149<TD>Gets the pairing type of the Wii Remote controller on the specified channel.</TD>
150    </TR>
151    <TR>
152<TD><A href="./WPADGetRegisteredDevNum.html"><code>WPADGetRegisteredDevNum</code></A></TD>
153<TD>Gets the number of Wii Remote controllers paired with the Wii console.</TD>
154    </TR>
155    <TR>
156<TD><A href="./WPADGetTemporaryDevNum.html"><code>WPADGetTemporaryDevNum</code></A></TD>
157<TD>Gets the number of Wii Remote controllers that have been simple-paired with the Wii console.</TD>
158    </TR>
159    <TR>
160<TD><A href="./WPADGetRadioSensitivity.html"><code>WPADGetRadioSensitivity</code></A></TD>
161<TD>Gets the radio sensitivity of the Wii Remote controller on the specified channel.</TD>
162    </TR>
163    <TR>
164<TD><A href="./WPADSetDisableChannel.html"><code>WPADSetDisableChannel</code></A></TD>
165<TD>Specifies a frequency not to be used for wireless communication for the controllers to avoid interference with wireless LANs.
166  </TR>
167    <TR>
168<TD><A href="./WPADStartSyncDevice.html"><code>WPADStartSyncDevice</code></A></TD>
169<TD>Begins the pairing process required to use the Wii Remote controller.</TD>
170    </TR>
171    <TR>
172<TD><A href="./WPADStartFastSyncDevice.html"><code>WPADStartFastSyncDevice</code></A></TD>
173<TD>Quickly executes the pairing process required to use the Wii Remote controller.</TD>
174    </TR>
175    <TR>
176<TD><A href="./WPADStartClearDevice.html"><code>WPADStartClearDevice</code></A></TD>
177<TD>Deletes all the information on the Wii Remote controllers paired with the Wii console.</TD>
178    </TR>
179    <TR>
180<TD><A href="./WPADStartSimpleSync.html"><code>WPADStartSimpleSync</code></A></TD>
181<TD>Begins the simple pairing process required to use the Wii Remote controller temporarily.</TD>
182    </TR>
183    <TR>
184<TD><A href="./WPADStartFastSimpleSync.html"><code>WPADStartFastSimpleSync</code></A></TD>
185<TD>Quickly executes the simple pairing process required to use the Wii Remote controller temporarily.</TD>
186    </TR>
187    <TR>
188<TD><A href="./WPADStopSimpleSync.html"><code>WPADStopSimpleSync</code></A></TD>
189<TD>Terminates simple pairing.</TD>
190    </TR>
191    <TR>
192<TD><A href="./WPADSetSyncDeviceCallback.html"><code>WPADSetSyncDeviceCallback</code></A></TD>
193<TD>Sets the callback called when SYNC is pressed and when pairing is completed. If no callback is set, <A href="./WPADStartSyncDevice.html"><code>WPADStartSyncDevice</code></a> is automatically called.</TD>
194    </TR>
195    <TR>
196<TD><A href="./WPADSetClearDeviceCallback.html"><code>WPADSetClearDeviceCallback</code></A></TD>
197<TD>Sets the callback called when SYNC 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>
198    </TR>
199    <TR>
200<TD><A href="./WPADSetSimpleSyncCallback.html"><code>WPADSetSimpleSyncCallback</code></A></TD>
201<TD>Sets the callback to be called when simple pairing has ended.</TD>
202    </TR>
203    <TR>
204<TD><A href="./WPADGetAcceptConnection.html"><code>WPADGetAcceptConnection</code></A></TD>
205<TD>Gets whether the Wii console is accepting connections from Wii Remote controllers.</TD>
206    </TR>
207    <TR>
208<TD><A href="./WPADSetAcceptConnection.html"><code>WPADSetAcceptConnection</code></A></TD>
209<TD>Sets whether the Wii console will accept a connection from a Wii Remote controller.</TD>
210    </TR>
211  </TBODY>
212</TABLE>
213
214<H3><a name="Motor">Rumble Feature</a></H3>
215<TABLE border="1">
216  <TBODY>
217    <TR>
218<TD><A href="./WPADControlMotor.html"><code>WPADControlMotor</code></A></TD>
219<TD>Controls the rumble motor of the Wii Remote controller for the specified channel.</TD>
220    </TR>
221    <TR>
222<TD><A href="./WPADStartMotor.html"><code>WPADStartMotor</code></A></TD>
223<TD>Begins vibration on the Wii Remote controller of the specified channel.</TD>
224    </TR>
225    <TR>
226<TD><A href="./WPADStopMotor.html"><code>WPADStopMotor</code></A></TD>
227<TD>Stops vibration on the Wii Remote controller for the specified channel.</TD>
228    </TR>
229    <TR>
230<TD><A href="./WPADEnableMotor.html"><code>WPADEnableMotor</code></A></TD>
231<TD>Turns the Rumble Feature of the Wii Remote controller ON/OFF.</TD>
232    </TR>
233    <TR>
234<TD><A href="./WPADIsMotorEnabled.html"><code>WPADIsMotorEnabled</code></A></TD>
235<TD>Gets the current ON/OFF status of the Rumble Feature of the Wii Remote controller.</TD>
236    </TR>
237  </TBODY>
238</TABLE>
239
240<H3><a name="Speaker">Speaker</a></H3>
241<TABLE border="1">
242  <TBODY>
243    <TR>
244<TD><A href="./WPADIsSpeakerEnabled.html"><code>WPADIsSpeakerEnabled</code></A></TD>
245<TD>Checks whether the speaker of the Wii Remote controller on the specified channel is operational.</TD>
246    </TR>
247    <TR>
248<TD><A href="./WPADControlSpeaker.html"><code>WPADControlSpeaker</code></A></TD>
249<TD>Controls the speaker of the Wii Remote controller on the specified channel.</TD>
250    </TR>
251    <TR>
252<TD><A href="./WPADGetSpeakerVolume.html"><code>WPADGetSpeakerVolume</code></A></TD>
253<TD>Gets the volume of the Wii Remote speaker.</TD>
254    </TR>
255    <TR>
256<TD><A href="./WPADSetSpeakerVolume.html"><code>WPADSetSpeakerVolume</code></A></TD>
257<TD>Sets the volume of the Wii Remote speaker.</TD>
258    </TR>
259    <TR>
260<TD><A href="./WPADSendStreamData.html"><code>WPADSendStreamData</code></A></TD>
261<TD>Sends audio data to the Wii Remote controller on the specified channel.</TD>
262    </TR>
263    <TR>
264<TD><a href="./WPADCanSendStreamData.html"><code>WPADCanSendStreamData</code></a></TD>
265<TD>Checks whether audio data can be sent to the Wii Remote controller on the specified channel.</TD>
266    </TR>
267  </TBODY>
268</TABLE>
269
270<H3><a name="Memory">Wii Remote Memory</a></H3>
271<TABLE border="1">
272  <TBODY>
273    <TR>
274<TD><A href="./WPADReadGameData.html"><code>WPADReadGameData</code></A></TD>
275<TD>Reads game data stored in the Wii Remote memory.</TD>
276    </TR>
277    <TR>
278<TD><A href="./WPADWriteGameData.html"><code>WPADWriteGameData</code></A></TD>
279<TD>Saves game data in the Wii Remote memory.</TD>
280    </TR>
281    <TR>
282<TD><A href="./WPADSetGameTitleUtf16.html"><code>WPADSetGameTitleUtf16</code></A></TD>
283<TD>Registers a character string with UTF16 character code in the file information for the game data saved in the Wii Remote memory as the game title.</TD>
284    </TR>
285    <TR>
286<TD><A href="./WPADGetGameTitleUtf16.html"><code>WPADGetGameTitleUtf16</code></A></TD>
287<TD>Gets the game title from the file information for game data saved in the Wii Remote memory.</TD>
288    </TR>
289    <TR>
290<TD><A href="./WPADGetGameDataTimeStamp.html"><code>WPADGetGameDataTimeStamp</code></A></TD>
291<TD>Gets the saved date/time stamp from the file information for game data saved in the Wii Remote memory.</TD>
292    </TR>
293  </TBODY>
294</TABLE>
295
296<H3><a name="Config">Config</a></H3>
297<TABLE border="1">
298  <TBODY>
299    <TR>
300<TD><A href="./WPADSaveConfig.html"><code>WPADSaveConfig</code></A></TD>
301<TD>Records the Rumble Feature setting and speaker volume setting of the Wii Remote controller on the specified channel in the Wii console NAND memory.</TD>
302    </TR>
303    <TR>
304<TD><A href="./WPADSetAutoSleepTime.html"><code>WPADSetAutoSleepTime</code></A></TD>
305<TD>Sets the timeout for automatically disconnecting a Wii Remote controller that is not sending input to the Wii console.</TD>
306    </TR>
307    <TR>
308<TD><A href="./WPADGetSensorBarPosition.html"><code>WPADGetSensorBarPosition</code></A></TD>
309<TD>Determines whether the Sensor Bar is placed above or below the television.</TD>
310    </TR>
311    <TR>
312<TD><A href="./WPADClearPortMapTable.html"><code>WPADClearPortMapTable</code></A></TD>
313<TD>Clears the mapping table for the Wii Remote's Controller Sockets. <font color="red">* Obsolete.</font></TD>
314    </TR>
315  </TBODY>
316</TABLE>
317
318<h3><a name="WBC">Wii Balance Board Accessory</a></h3>
319<TABLE border="1">
320  <TBODY>
321    <TR>
322<TD><A href="./WPADControlBLC.html"><code>WPADControlBLC</code></A></TD>
323<TD>Controls the Wii Balance Board accessory.</TD>
324    </TR>
325    <TR>
326<TD><A href="./WPADGetBLCalibration.html"><code>WPADGetBLCalibration</code></A></TD>
327<TD>Gets the calibration values for the Wii Balance Board accessory.</TD>
328    </TR>
329    <TR>
330<TD><A href="./WPADIsRegisteredBLC.html"><code>WPADIsRegisteredBLC</code></A></TD>
331<TD>Checks if the Wii Balance Board accessory has been paired with the Wii console.</TD>
332    </TR>
333    <TR>
334<TD><A href="./WPADRegisterBLCWorkarea.html"><code>WPADRegisterBLCWorkarea</code></A></TD>
335<TD>In the library, configures a work buffer required for sharing the pairing information between Wii Balance Board accessory and the Japanese version of WiiFit.</TD>
336    </TR>
337  </TBODY>
338</TABLE>
339
340<H3>Debug</H3>
341<TABLE border="1">
342  <TBODY>
343    <TR>
344<TD><A href="./WPADAttachDummyExtension.html"><code>WPADAttachDummyExtension</code></A></TD>
345<TD>Changes the Wii Remote controller device type for the specified channel without actually plugging an external extension controller to that Wii Remote controller. <font color="red">Note: Can be called only with the debug version of the library.</font></TD>
346    </TR>
347    <TR>
348<TD><A href="./WPADDetachDummyExtension.html"><code>WPADDetachDummyExtension</code></A></TD>
349<TD>For a Wii Remote controller on the specified channel, changes the device type to <code>WPAD_DEV_CORE</code>. <font color="red">Note: Can be called only with the debug version of the library.</font></TD>
350    </TR>
351  </TBODY>
352</TABLE>
353
354<H3><a name="struct">Types, Structures</a></H3>
355<TABLE border="1">
356  <TBODY>
357    <TR>
358<TD><A href="./WPADStatus.html"><code>WPADStatus</code></A></TD>
359<TD>Structure for the controller status of the Wii Remote controller.</TD>
360    </TR>
361    <TR>
362<TD><A href="./WPADFSStatus.html"><code>WPADFSStatus</code></A></TD>
363<TD>Structure for the Nunchuk controller status.</TD>
364    </TR>
365    <TR>
366<TD><A href="./WPADCLStatus.html"><code>WPADCLStatus</code></A></TD>
367<TD>Structure for the Classic Controller status.</TD>
368    </TR>
369    <TR>
370<TD><A href="./WPADStatusEx.html"><code>WPADStatusEx</code></A></TD>
371<TD>Structure for the external extension controller status of the Wii Remote controller.</TD>
372    </TR>
373    <TR>
374<TD><A href="./WPADBLStatus.html"><code>WPADBLStatus</code></A></TD>
375<TD>Structure for the controller status of the Wii Balance Board accessory.</TD>
376    </TR>
377    <TR>
378<TD><A href="./WPADInfo.html"><code>WPADInfo</code></A></TD>
379<TD>Structure for the Wii Remote controller status.</TD>
380    </TR>
381  </TBODY>
382</TABLE>
383<br>
384<hr>
385
386<hr><p>CONFIDENTIAL</p></body>
387</HTML>
388