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</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>Performs the WPAD library end process. Be sure to call this function when exiting a game. <font color="red">* Eliminated.</font></TD>
24    </TR>
25    <TR>
26      <TD><A href="./WPADReconnect.html"><code>WPADReconnect</code></A></TD>
27      <TD>Performs the WPAD library end process. Be sure to call this function when you want to automatically reconnect from the Wii Remote after restarting a game. <font color="red">* Eliminated.</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 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 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 for either the Wii Remote or the Nunchuk 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 and R trigger buttons 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 (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 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 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 analog stick input of the Nunchuk and the Classic Controller.</TD>
98    </TR>
99    <TR>
100      <TD><A href="./WPADClampTrigger.html"><code>WPADClampTrigger</code></A></TD>
101      <TD>Clamps the analog trigger 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 and the Wii Remote.</TD>
106    </TR>
107    <TR>
108      <TD><A href="./WPADIsDpdEnabled.html"><code>WPADIsDpdEnabled</code></A></TD>
109      <TD>Checks whether the pointer for the Wii Remote 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 for the Wii Remote 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 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 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 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 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 the current information of the Wii Remote.</TD>
138    </TR>
139    <TR>
140      <TD><A href="./WPADGetInfoAsync.html"><code>WPADGetInfoAsync</code></A></TD>
141      <TD>Gets the current information of the Wii Remote.</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 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 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 Remotes 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 Remotes 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 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.</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.</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 Remotes 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 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 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 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>
194    </TR>
195    <TR>
196      <TD><A href="./WPADSetClearDeviceCallback.html"><code>WPADSetClearDeviceCallback</code></A></TD>
197      <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>
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 Remotes.</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.</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 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 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 for the specified channel.</TD>
228    </TR>
229    <TR>
230      <TD><A href="./WPADIsMotorEnabled.html"><code>WPADIsMotorEnabled</code></A></TD>
231      <TD>Gets the current ON/OFF status of the Rumble Feature of the Wii Remote.</TD>
232    </TR>
233  </TBODY>
234</TABLE>
235
236<H3><a name="Speaker">Speaker</a></H3>
237<TABLE border="1">
238  <TBODY>
239    <TR>
240      <TD><A href="./WPADIsSpeakerEnabled.html"><code>WPADIsSpeakerEnabled</code></A></TD>
241      <TD>Checks whether the speaker of the Wii Remote on the specified channel is operational.</TD>
242    </TR>
243    <TR>
244      <TD><A href="./WPADControlSpeaker.html"><code>WPADControlSpeaker</code></A></TD>
245      <TD>Controls the speaker of the Wii Remote Control on the specified channel.</TD>
246    </TR>
247    <TR>
248      <TD><A href="./WPADGetSpeakerVolume.html"><code>WPADGetSpeakerVolume</code></A></TD>
249      <TD>Gets the volume of the Wii Remote speaker.</TD>
250    </TR>
251    <TR>
252      <TD><A href="./WPADSendStreamData.html"><code>WPADSendStreamData</code></A></TD>
253      <TD>Sends audio data to the Wii Remote on the specified channel.</TD>
254    </TR>
255    <TR>
256      <TD><a href="./WPADCanSendStreamData.html"><code>WPADCanSendStreamData</code></a></TD>
257      <TD>Checks whether audio data can be sent to the Wii Remote on the specified channel.</TD>
258    </TR>
259  </TBODY>
260</TABLE>
261
262<H3><a name="Memory">Wii Remote Memory</a></H3>
263<TABLE border="1">
264  <TBODY>
265    <TR>
266      <TD><A href="./WPADReadGameData.html"><code>WPADReadGameData</code></A></TD>
267      <TD>Reads game data stored in the Wii Remote memory.</TD>
268    </TR>
269    <TR>
270      <TD><A href="./WPADWriteGameData.html"><code>WPADWriteGameData</code></A></TD>
271      <TD>Saves game data in the Wii Remote memory.</TD>
272    </TR>
273    <TR>
274      <TD><A href="./WPADSetGameTitleUtf16.html"><code>WPADSetGameTitleUtf16</code></A></TD>
275      <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>
276    </TR>
277    <TR>
278      <TD><A href="./WPADGetGameTitleUtf16.html"><code>WPADGetGameTitleUtf16</code></A></TD>
279      <TD>Gets the game title from the file information for game data saved in the Wii Remote memory.</TD>
280    </TR>
281    <TR>
282      <TD><A href="./WPADGetGameDataTimeStamp.html"><code>WPADGetGameDataTimeStamp</code></A></TD>
283      <TD>Gets the saved date/time stamp from the file information for game data saved in the Wii Remote memory.</TD>
284    </TR>
285  </TBODY>
286</TABLE>
287
288<H3><a name="Config">Config</a></H3>
289<TABLE border="1">
290  <TBODY>
291    <TR>
292      <TD><A href="./WPADSetAutoSleepTime.html"><code>WPADSetAutoSleepTime</code></A></TD>
293      <TD>Sets the timeout for automatically disconnecting a Wii Remote that is not sending input to the Wii console.</TD>
294    </TR>
295    <TR>
296      <TD><A href="./WPADGetSensorBarPosition.html"><code>WPADGetSensorBarPosition</code></A></TD>
297      <TD>Determines whether the sensor bar is placed above or below the television.</TD>
298    </TR>
299    <TR>
300      <TD><A href="./WPADClearPortMapTable.html"><code>WPADClearPortMapTable</code></A></TD>
301      <TD>Clears the mapping table for the Wii Remote's External Extension Connector. <font color="red">* Eliminated.</font></TD>
302    </TR>
303  </TBODY>
304</TABLE>
305
306<H3>Debug</H3>
307<TABLE border="1">
308  <TBODY>
309    <TR>
310      <TD><A href="./WPADAttachDummyExtension.html"><code>WPADAttachDummyExtension</code></A></TD>
311      <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. <font color="red"><B>Note:</B> Only the debug version of the library can be called.</font></TD>
312    </TR>
313    <TR>
314      <TD><A href="./WPADDetachDummyExtension.html"><code>WPADDetachDummyExtension</code></A></TD>
315      <TD>For the Wii Remote on the specified channel, changes the device type to <code>WPAD_DEV_CORE</code>. <font color="red"><B>Note:</B> Only the debug version of the library can be called.</font></TD>
316    </TR>
317  </TBODY>
318</TABLE>
319
320<H3><a name="struct">Types and Structures</a></H3>
321<TABLE border="1">
322  <TBODY>
323    <TR>
324      <TD><A href="./WPADStatus.html"><code>WPADStatus</code></A></TD>
325      <TD>Structure for the controller status of the Wii Remote.</TD>
326    </TR>
327    <TR>
328      <TD><A href="./WPADFSStatus.html"><code>WPADFSStatus</code></A></TD>
329      <TD>Structure for the Nunchuk status.</TD>
330    </TR>
331    <TR>
332      <TD><A href="./WPADCLStatus.html"><code>WPADCLStatus</code></A></TD>
333      <TD>Structure for the Classic Controller status.</TD>
334    </TR>
335    <TR>
336      <TD><A href="./WPADStatusEx.html"><code>WPADStatusEx</code></A></TD>
337      <TD>Structure for the External Extension Controller status of the Wii Remote.</TD>
338    </TR>
339    <TR>
340      <TD><A href="./WPADInfo.html"><code>WPADInfo</code></A></TD>
341      <TD>Structure for the Wii Remote status.</TD>
342    </TR>
343  </TBODY>
344</TABLE>
345<br>
346<hr>
347
348<hr><p>CONFIDENTIAL</p></body>
349</HTML>
350