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=utf-8">
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>Standard Controller (WPAD) API Function List</H1>
14<H2><a name="Wpad">Wii Remote</a></H2>
15<TABLE class="api_list" border="1">
16  <TBODY>
17    <TR>
18<TH><A href="./WPADInit.html">WPADInit</A></TH>
19<TD>Initializes the WPAD library.</TD>
20    </TR>
21    <TR>
22<TH><A href="./WPADRegisterAllocator.html">WPADRegisterAllocator</A></TH>
23<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.
24    </TD>
25    </TR>
26    <TR>
27<TH><A href="./WPADGetWorkMemorySize.html">WPADGetWorkMemorySize</A></TH>
28<TD>Returns the size of the work memory allocated by the library.
29    </TD>
30    </TR>
31    <TR>
32<TH><A href="./WPADProbe.html">WPADProbe</A></TH>
33<TD>Checks the specified channel's status and controller type.</TD>
34    </TR>
35    <TR>
36<TH><A href="./WPADGetStatus.html">WPADGetStatus</A></TH>
37<TD>Gets the usage status of the library.</TD>
38    </TR>
39    <TR>
40<TH><A href="./WPADGetDataFormat.html">WPADGetDataFormat</A></TH>
41<TD>Gets the data format type of the received data.</TD>
42    </TR>
43    <TR>
44<TH><A href="./WPADSetDataFormat.html">WPADSetDataFormat</A></TH>
45<TD>Specifies the data format type of the received data. Some time is required before the received data format is changed.</TD>
46    </TR>
47    <TR>
48<TH><A href="./WPADRead.html">WPADRead</A></TH>
49<TD>Gets the most recent controller status of the Wii Remote of the specified channel.</TD>
50    </TR>
51    <TR>
52<TH><A href="./WPADSetAutoSamplingBuf.html">WPADSetAutoSamplingBuf</A></TH>
53<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>
54    </TR>
55    <TR>
56<TH><A href="./WPADGetLatestIndexInBuf.html">WPADGetLatestIndexInBuf</A></TH>
57<TD>Obtains the index of the ring buffer where the most recent standard controller status is stored.</TD>
58    </TR>
59    <TR>
60<TH><A href="./WPADSetSamplingCallback.html">WPADSetSamplingCallback</A></TH>
61<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>
62    </TR>
63    <TR>
64<TH><A href="./WPADSetConnectCallback.html">WPADSetConnectCallback</A></TH>
65<TD>Registers the callback function that is called when the Wii Remote for the specified channel is connected or disconnected.</TD>
66    </TR>
67    <TR>
68<TH><A href="./WPADSetExtensionCallback.html">WPADSetExtensionCallback</A></TH>
69<TD>Registers the callback function that is called when an external extension controller is inserted or removed from a Wii Remote on the specified channel.</TD>
70    </TR>
71    <TR>
72<TH><A href="./WPADButtonDown.html">WPADButtonDown</A></TH>
73<TD>Detects whether button(s) have been pressed.</TD>
74    </TR>
75    <TR>
76<TH><A href="./WPADButtonUp.html">WPADButtonUp</A></TH>
77<TD>Detects whether button(s) have been released.</TD>
78    </TR>
79    <TR>
80<TH><A href="./WPADGetInfo.html">WPADGetInfo</A></TH>
81<TD>Gets the current information of the Wii Remote.</TD>
82    </TR>
83    <TR>
84<TH><A href="./WPADGetInfoAsync.html">WPADGetInfoAsync</A></TH>
85<TD>Gets the current information of the Wii Remote.</TD>
86    </TR>
87    <TR>
88<TH><A href="./WPADGetAddress.html">WPADGetAddress</A></TH>
89<TD>Gets the unique ID of the Wii Remote for the specified channel.</TD>
90    </TR>
91    <TR>
92<TH><A href="./WPADGetSyncType.html">WPADGetSyncType</A></TH>
93<TD>Gets the pairing type of the Wii Remote on the specified channel.</TD>
94    </TR>
95    <TR>
96<TH><A href="./WPADGetRadioSensitivity.html">WPADGetRadioSensitivity</A></TH>
97<TD>Gets the radio sensitivity of the Wii Remote on the specified channel.</TD>
98    </TR>
99    <TR>
100<TH><A href="./WPADGetAccGravityUnit.html">WPADGetAccGravityUnit</A></TH>
101<TD>Gets the per-unit quantity of gravity acceleration for the Motion Sensor for either the Wii Remote or the Nunchuk for the specified channel.</TD>
102    </TR>
103    <TR>
104<TH><A href="./WPADGetCLTriggerThreshold.html">WPADGetCLTriggerThreshold</A></TH>
105<TD>Gets the lower limit when clamping the L and R trigger buttons of the Classic Controller on the specified channel.</TD>
106    </TR>
107    <TR>
108<TH><A href="./WPADClampStick.html">WPADClampStick</A></TH>
109<TD>Clamps analog stick input of the Nunchuk and the Classic Controller.</TD>
110    </TR>
111    <TR>
112<TH><A href="./WPADClampTrigger.html">WPADClampTrigger</A></TH>
113<TD>Clamps the analog trigger inputs of a Classic Controller.</TD>
114    </TR>
115    <TR>
116<TH><A href="./WPADClampAcc.html">WPADClampAcc</A></TH>
117<TD>Clamps the motion sensor inputs of the Nunchuk and the Wii Remote.</TD>
118    </TR>
119    <TR>
120<TH><A href="./WPADControlExtGimmick.html">WPADControlExtGimmick</A></TH>
121<TD>Controls the gimmicks (mechanisms) of the external extension controller plugged into the Wii Remote of the specified channel.</TD>
122    </TR>
123  </TBODY>
124</TABLE>
125
126<H2><a name="Wbc">Wii Balance Board</a></H2>
127<TABLE class="api_list" border="1">
128  <TBODY>
129    <TR>
130<TH><A href="./WPADControlBLC.html">WPADControlBLC</A></TH>
131<TD>Controls the specified Wii Balance Board.</TD>
132    </TR>
133    <TR>
134<TH><A href="./WPADGetBLCalibration.html">WPADGetBLCalibration</A></TH>
135<TD>Gets the calibration values for the specified Wii Balance Board.</TD>
136    </TR>
137    <TR>
138<TH><A href="./WPADIsRegisteredBLC.html">WPADIsRegisteredBLC</A></TH>
139<TD>Checks whether a Wii Balance Board has been paired with the Wii console.</TD>
140    </TR>
141    <TR>
142<TH><A href="./WPADRegisterBLCWorkarea.html">WPADRegisterBLCWorkarea</A></TH>
143<TD>In the library, configures a work buffer required for sharing the pairing information between the Wii Balance Board and the Japanese version of WiiFit.</TD>
144    </TR>
145  </TBODY>
146</TABLE>
147
148<H2><a name="Dpd">Pointer</a></H2>
149<TABLE class="api_list" border="1">
150  <TBODY>
151    <TR>
152<TH><A href="./WPADIsDpdEnabled.html">WPADIsDpdEnabled</A></TH>
153<TD>Checks whether the pointer for the Wii Remote for the specified channel is working.</TD>
154    </TR>
155    <TR>
156<TH><A href="./WPADControlDpd.html">WPADControlDpd</A></TH>
157<TD>Controls the pointer for the Wii Remote of the specified channel.</TD>
158    </TR>
159    <TR>
160<TH><A href="./WPADGetDpdFormat.html">WPADGetDpdFormat</A></TH>
161<TD>Gets the data format of the Pointer of the Wii Remote on the specified channel.</TD>
162    </TR>
163    <TR>
164<TH><A href="./WPADGetDpdSensitivity.html">WPADGetDpdSensitivity</A></TH>
165<TD>Gets the sensitivity of the Pointer of the Wii Remote on the specified channel.</TD>
166    </TR>
167  </TBODY>
168</TABLE>
169
170<H2><a name="Motor">Rumble Feature</a></H2>
171<TABLE class="api_list" border="1">
172  <TBODY>
173    <TR>
174<TH><A href="./WPADControlMotor.html">WPADControlMotor</A></TH>
175<TD>Controls the Rumble Feature of the Wii Remote for the specified channel.</TD>
176    </TR>
177    <TR>
178<TH><A href="./WPADStartMotor.html">WPADStartMotor</A></TH>
179<TD>Starts the Rumble Feature on the Wii Remote of the specified channel.</TD>
180    </TR>
181    <TR>
182<TH><A href="./WPADStopMotor.html">WPADStopMotor</A></TH>
183<TD>Stops Rumble Feature on the Wii Remote for the specified channel.</TD>
184    </TR>
185    <TR>
186<TH><A href="./WPADIsMotorEnabled.html">WPADIsMotorEnabled</A></TH>
187<TD>Gets the current ON/OFF status of the Rumble Feature of the Wii Remote.</TD>
188    </TR>
189  </TBODY>
190</TABLE>
191
192<H2><a name="Speaker">Speaker</a></H2>
193<TABLE class="api_list" border="1">
194  <TBODY>
195    <TR>
196<TH><A href="./WPADIsSpeakerEnabled.html">WPADIsSpeakerEnabled</A></TH>
197<TD>Checks whether the speaker of the Wii Remote on the specified channel is operational.</TD>
198    </TR>
199    <TR>
200<TH><A href="./WPADControlSpeaker.html">WPADControlSpeaker</A></TH>
201<TD>Controls the speaker of the Wii Remote Control on the specified channel.</TD>
202    </TR>
203    <TR>
204<TH><A href="./WPADSendStreamData.html">WPADSendStreamData</A></TH>
205<TD>Sends audio data to the Wii Remote on the specified channel.</TD>
206    </TR>
207    <TR>
208<TH><A href="./WPADCanSendStreamData.html">WPADCanSendStreamData</A></TH>
209<TD>Checks whether audio data can be sent to the Wii Remote on the specified channel.</TD>
210    </TR>
211  </TBODY>
212</TABLE>
213
214<H2><a name="Memory">Wii Remote Memory</a></H2>
215<TABLE class="api_list" border="1">
216  <TBODY>
217    <TR>
218<TH><A href="./WPADReadGameData.html">WPADReadGameData</A></TH>
219<TD>Reads game data stored in the Wii Remote memory.</TD>
220    </TR>
221    <TR>
222<TH><A href="./WPADWriteGameData.html">WPADWriteGameData</A></TH>
223<TD>Saves game data in the Wii Remote memory.</TD>
224    </TR>
225    <TR>
226<TH><A href="./WPADSetGameTitleUtf16.html">WPADSetGameTitleUtf16</A></TH>
227<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>
228    </TR>
229    <TR>
230<TH><A href="./WPADGetGameTitleUtf16.html">WPADGetGameTitleUtf16</A></TH>
231<TD>Gets the game title from the file information for game data saved in the Wii Remote memory.</TD>
232    </TR>
233    <TR>
234<TH><A href="./WPADGetGameDataTimeStamp.html">WPADGetGameDataTimeStamp</A></TH>
235<TD>Gets the saved date/time stamp from the file information for game data saved in the Wii Remote memory.</TD>
236    </TR>
237  </TBODY>
238</TABLE>
239
240<H2><a name="MotionPlus">Wii MotionPlus</a></H2>
241<TABLE class="api_list" border="1">
242  <TBODY>
243    <TR>
244<TH><A href="./WPADControlMpls.html"><code>WPADControlMpls</code></a></TH>
245<TD>Controls the Wii MotionPlus connected to the Wii Remote on the specified channel. </TD>
246    </TR>
247    <TR>
248<TH><A href="./WPADGetMplsCalibration.html"><code>WPADGetMplsCalibration</code></a></TH>
249<TD>Gets the calibration values for the Wii MotionPlus connected to the Wii Remote on the specified channel.</TD>
250    </TR>
251    <TR>
252<TH><A href="./WPADGetMplsStatus.html"><code>WPADGetMplsStatus</code></a></TH>
253<TD>Gets whether a running Wii MotionPlus is plugged into the Wii Remote on the specified channel, and if so, whether it is the only device in operation. </TD>
254    </TR>
255    <TR>
256<TH><A href="./WPADSetMplsCalibration.html"><code>WPADSetMplsCalibration</code></a></TH>
257<TD>Sets each axis's zero-point calibration values for the Wii MotionPlus connected to the Wii Remote on the specified channel.</TD>
258    </TR>
259  </TBODY>
260</TABLE>
261
262<H2><a name="Sync">Pairing</a></H2>
263<TABLE class="api_list" border="1">
264  <TBODY>
265    <TR>
266<TH><A href="./WPADGetRegisteredDevNum.html">WPADGetRegisteredDevNum</A></TH>
267<TD>Gets the number of Wii Remotes paired with the Wii console.</TD>
268    </TR>
269    <TR>
270<TH><A href="./WPADGetTemporaryDevNum.html">WPADGetTemporaryDevNum</A></TH>
271<TD>Gets the number of Wii Remotes that have been simple-paired with the Wii console.</TD>
272    </TR>
273    <TR>
274<TH><A href="./WPADStartSyncDevice.html">WPADStartSyncDevice</A></TH>
275<TD>Begins the pairing process required to use the Wii Remote.</TD>
276    </TR>
277    <TR>
278<TH><A href="./WPADStartFastSyncDevice.html">WPADStartFastSyncDevice</A></TH>
279<TD>Quickly executes the pairing process required to use the Wii Remote.</TD>
280    </TR>
281    <TR>
282<TH><A href="./WPADStartClearDevice.html">WPADStartClearDevice</A></TH>
283<TD>Deletes all the information on the Wii Remotes paired with the Wii console.</TD>
284    </TR>
285    <TR>
286<TH><A href="./WPADStartSimpleSync.html">WPADStartSimpleSync</A></TH>
287<TD>Begins the simple pairing process required to use the Wii Remote temporarily.</TD>
288    </TR>
289    <TR>
290<TH><A href="./WPADStartFastSimpleSync.html">WPADStartFastSimpleSync</A></TH>
291<TD>Quickly executes the simple pairing process required to use the Wii Remote temporarily.</TD>
292    </TR>
293    <TR>
294<TH><A href="./WPADStopSimpleSync.html">WPADStopSimpleSync</A></TH>
295<TD>Terminates simple pairing.</TD>
296    </TR>
297    <TR>
298<TH><A href="./WPADSetSyncDeviceCallback.html">WPADSetSyncDeviceCallback</A></TH>
299<TD>Sets the callback called when SYNCHRO is pressed and when pairing is completed. If no callback is set, <A href="./WPADStartSyncDevice.html"><CODE>WPADStartSyncDevice</CODE></a> is automatically called.</TD>
300    </TR>
301    <TR>
302<TH><A href="./WPADSetClearDeviceCallback.html">WPADSetClearDeviceCallback</A></TH>
303<TD>Sets the callback called when SYNCHRO 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>
304    </TR>
305    <TR>
306<TH><A href="./WPADSetSimpleSyncCallback.html">WPADSetSimpleSyncCallback</A></TH>
307<TD>Sets the callback to be called when simple pairing has ended.</TD>
308    </TR>
309  </TBODY>
310</TABLE>
311
312<H2><a name="Connect">Connection / Disconnection</a></H2>
313<TABLE class="api_list" border="1">
314  <TBODY>
315    <TR>
316<TH><A href="./WPADDisconnect.html">WPADDisconnect</A></TH>
317<TD>Disconnects the controller for the specified channel.</TD>
318    </TR>
319    <TR>
320<TH><A href="./WPADGetAcceptConnection.html">WPADGetAcceptConnection</A></TH>
321<TD>Gets whether the Wii console is accepting connections from Wii Remotes.</TD>
322    </TR>
323    <TR>
324<TH><A href="./WPADSetAcceptConnection.html">WPADSetAcceptConnection</A></TH>
325<TD>Sets whether the Wii console will accept a connection from a Wii Remote.</TD>
326    </TR>
327  </TBODY>
328</TABLE>
329
330<H2><a name="BatterySave">Automatic Disconnect</a></H2>
331<TABLE class="api_list" border="1">
332  <TBODY>
333    <TR>
334<TH><A href="./WPADSetAutoSleepTime.html">WPADSetAutoSleepTime</A></TH>
335<TD>Sets the timeout for automatically disconnecting a Wii Remote that is not sending input to the Wii console.</TD>
336    </TR>
337    <TR>
338<TH><A href="./WPADGetAutoSleepTimeCount.html">WPADGetAutoSleepTimeCount</A></TH>
339<TD>Gets the timer for automatic disconnection.</TD>
340    </TR>
341    <TR>
342<TH><A href="./WPADResetAutoSleepTimeCount.html">WPADResetAutoSleepTimeCount</A></TH>
343<TD>Resets the timer for automatic disconnection.</TD>
344    </TR>
345  </TBODY>
346</TABLE>
347
348<H2><a name="Config">Wii Console Settings-Related</a></H2>
349<TABLE class="api_list" border="1">
350  <TBODY>
351    <TR>
352<TH><A href="./WPADEnableMotor.html">WPADEnableMotor</A></TH>
353<TD>Turns the Rumble Feature of the Wii Remote on and off. <font color="red">Note: In product versions, do not call this function from applications other than the HOME button menu.</font></TD>
354    </TR>
355    <TR>
356<TH><A href="./WPADGetSpeakerVolume.html">WPADGetSpeakerVolume</A></TH>
357<TD>Gets the volume of the Wii Remote speaker.</TD>
358    </TR>
359    <TR>
360<TH><A href="./WPADSetSpeakerVolume.html">WPADSetSpeakerVolume</A></TH>
361<TD>Sets the volume of the Wii Remote speaker. <font color="red">Note: In product versions, do not call this function from applications other than the HOME button menu.</font></TD>
362    </TR>
363    <TR>
364<TH><A href="./WPADGetSensorBarPosition.html">WPADGetSensorBarPosition</A></TH>
365<TD>Determines whether the sensor bar is placed above or below the television.</TD>
366    </TR>
367    <TR>
368<TH><A href="./WPADSaveConfig.html">WPADSaveConfig</A></TH>
369<TD>Records the Rumble Feature setting and speaker volume setting of the Wii Remote on the specified channel in Wii console NAND memory. <font color="red">Note: In product versions, do not call this function from applications other than the HOME button menu.</font></TD>
370    </TR>
371  </TBODY>
372</TABLE>
373
374<H2><a name="debug">Debug</a></H2>
375<TABLE class="api_list" border="1">
376  <TBODY>
377    <TR>
378<TH><A href="./WPADAttachDummyExtension.html">WPADAttachDummyExtension</A></TH>
379<TD>Changes the Wii Remote device type for the specified channel without actually plugging in an external extension controller to the Wii Remote assigned to the specified channel. <STRONG>Note:</STRONG> Only the debug version of the library can call this function.</TD>
380    </TR>
381    <TR>
382<TH><A href="./WPADDetachDummyExtension.html">WPADDetachDummyExtension</A></TH>
383<TD>For the Wii Remote 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>
384    </TR>
385  </TBODY>
386</TABLE>
387
388<H2><a name="struct">Types and Structures</a></H2>
389<TABLE class="api_list" border="1">
390  <TBODY>
391    <TR>
392<TH><A href="./WPADStatus.html">WPADStatus</A></TH>
393<TD>Structure for the controller status of the Wii Remote.</TD>
394    </TR>
395    <TR>
396<TH><A href="./WPADInfo.html">WPADInfo</A></TH>
397<TD>Structure for the Wii Remote status.</TD>
398    </TR>
399  </TBODY>
400</TABLE>
401
402<H2><a name="obsolete">Deprecated Functions</a></H2>
403<TABLE class="api_list" border="1">
404  <TBODY>
405    <TR>
406<TH><A href="./WPADShutdown.html"><s><CODE>WPADShutdown</CODE></s></A> (obsolete)</TH>
407<TD>Deprecated.</TD>
408    </TR>
409    <TR>
410<TH><A href="./WPADReconnect.html"><s><CODE>WPADReconnect</CODE></s></A> (obsolete)</TH>
411<TD>Deprecated.</TD>
412    </TR>
413    <TR>
414<TH><A href="./WPADSetDisableChannel.html"><s><CODE>WPADSetDisableChannel</CODE></s></A> (obsolete)</TH>
415<TD>Deprecated.</TD>
416    </TR>
417    <TR>
418<TH><A href="./WPADClearPortMapTable.html"><s><CODE>WPADClearPortMapTable</CODE></s></A> (obsolete)</TH>
419<TD>Deprecated.</TD>
420    </TR>
421  </TBODY>
422</TABLE>
423
424
425<br><br>
426
427<hr><p>CONFIDENTIAL</p></body>
428</HTML>
429