Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(284)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/apps/serial.html

Issue 10832260: Fix broken documentation link on API documentation page. (Closed) Base URL: http://git.chromium.org/git/chromium.git@trunk
Patch Set: removed devtools docs file as they are not needed Created 8 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « chrome/common/extensions/docs/apps/events.html ('k') | chrome/common/extensions/docs/extensions/events.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="../css/print.css" rel="stylesheet" type="text/css" media="print" > 12 <link href="../css/print.css" rel="stylesheet" type="text/css" media="print" >
13 <script type="text/javascript" src="../../../../third_party/jstemplate/jstem plate_compiled.js"> 13 <script type="text/javascript" src="../../../../third_party/jstemplate/jstem plate_compiled.js">
14 </script> 14 </script>
15 <script type="text/javascript" src="../../../../../third_party/json_minify/m inify-sans-regexp.js"> 15 <script type="text/javascript" src="../../../../../third_party/json_minify/m inify-sans-regexp.js">
16 </script> 16 </script>
17 <script type="text/javascript" src="../js/api_page_generator.js"></script> 17 <script type="text/javascript" src="../js/api_page_generator.js"></script>
18 <script type="text/javascript" src="../js/bootstrap.js"></script> 18 <script type="text/javascript" src="../js/bootstrap.js"></script>
19 <script type="text/javascript" src="../js/sidebar.js"></script> 19 <script type="text/javascript" src="../js/sidebar.js"></script>
20 <meta name="description" content="Documentation for the chrome.experimental.us b module, which is part of the Google Chrome extension APIs."><title>chrome.exp erimental.usb - Google Chrome Extensions - Google Code</title></head> 20 <meta name="description" content="Documentation for the chrome.serial module, which is part of the Google Chrome extension APIs."><title>chrome.serial - Goog le Chrome Extensions - Google Code</title></head>
21 <body doc-family="apps"> <link href="../css/ApiRefStyles.css" rel="stylesheet " type="text/css"> 21 <body doc-family="apps"> <link href="../css/ApiRefStyles.css" rel="stylesheet " type="text/css">
22 <link href="../css/prettify.css" rel="stylesheet" type="text/css"> 22 <link href="../css/prettify.css" rel="stylesheet" type="text/css">
23 <link href="../css/shared.css" rel="stylesheet" type="text/css"> 23 <link href="../css/shared.css" rel="stylesheet" type="text/css">
24 <div id="devModeWarning" class="displayModeWarning"> 24 <div id="devModeWarning" class="displayModeWarning">
25 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files. 25 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
26 </div> 26 </div>
27 <div id="branchWarning" class="displayModeWarning"> 27 <div id="branchWarning" class="displayModeWarning">
28 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. 28 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
29 It may not work with the stable release of Chrome.</span> 29 It may not work with the stable release of Chrome.</span>
30 <select id="branchChooser"> 30 <select id="branchChooser">
(...skipping 119 matching lines...) Expand 10 before | Expand all | Expand 10 after
150 </li> 150 </li>
151 <li><h2><a href="https://github.com/GoogleChrome/chrome-app-samples">S amples</a></h2></li> 151 <li><h2><a href="https://github.com/GoogleChrome/chrome-app-samples">S amples</a></h2></li>
152 <li><h2><a href="app_known_issues.html">Known Issues</a></h2></li> 152 <li><h2><a href="app_known_issues.html">Known Issues</a></h2></li>
153 </ul> 153 </ul>
154 </div> 154 </div>
155 <script> 155 <script>
156 initToggles(); 156 initToggles();
157 </script> 157 </script>
158 <div class="g-unit" id="gc-pagecontent"> 158 <div class="g-unit" id="gc-pagecontent">
159 <div id="pageTitle"> 159 <div id="pageTitle">
160 <h1 class="page_title">chrome.experimental.usb</h1> 160 <h1 class="page_title">chrome.serial</h1>
161 </div> 161 </div>
162 <!-- TABLE OF CONTENTS --> 162 <!-- TABLE OF CONTENTS -->
163 <div id="toc"> 163 <div id="toc">
164 <h2>Contents</h2> 164 <h2>Contents</h2>
165 <ol> 165 <ol>
166 <li> 166 <li>
167 <a href="#apiReference">API reference: chrome.experimental.usb</ a> 167 <a href="#apiReference">API reference: chrome.serial</a>
168 <ol> 168 <ol>
169 <li> 169 <li>
170 <a href="#global-methods">Methods</a> 170 <a href="#global-methods">Methods</a>
171 <ol> 171 <ol>
172 <li> 172 <li>
173 <a href="#method-bulkTransfer">bulkTransfer</a> 173 <a href="#method-close">close</a>
174 </li><li> 174 </li><li>
175 <a href="#method-closeDevice">closeDevice</a> 175 <a href="#method-flush">flush</a>
176 </li><li> 176 </li><li>
177 <a href="#method-controlTransfer">controlTransfer</a> 177 <a href="#method-getControlSignals">getControlSignals</a>
178 </li><li> 178 </li><li>
179 <a href="#method-findDevice">findDevice</a> 179 <a href="#method-getPorts">getPorts</a>
180 </li><li> 180 </li><li>
181 <a href="#method-interruptTransfer">interruptTransfer</a> 181 <a href="#method-open">open</a>
182 </li><li> 182 </li><li>
183 <a href="#method-isochronousTransfer">isochronousTransfer</a> 183 <a href="#method-read">read</a>
184 </li><li>
185 <a href="#method-setControlSignals">setControlSignals</a>
186 </li><li>
187 <a href="#method-write">write</a>
184 </li> 188 </li>
185 </ol> 189 </ol>
186 </li> 190 </li>
187 <li>
188 <a href="#global-events">Events</a>
189 <ol>
190 <li>
191 <a href="#event-onEvent">onEvent</a>
192 </li>
193 </ol>
194 </li>
195 <li> 191 <li>
196 <a href="#types">Types</a> 192 <a href="#types">Types</a>
197 <ol> 193 <ol>
198 <li> 194 <li>
199 <a href="#type-experimental.usb.Device">experimental.usb.Device< /a> 195 <a href="#type-serial.OpenOptions">serial.OpenOptions</a>
200 <ol> 196 <ol>
201 </ol> 197 </ol>
202 </li><li> 198 </li><li>
203 <a href="#type-experimental.usb.ControlTransferInfo">experimenta l.usb.ControlTransferInfo</a> 199 <a href="#type-serial.OpenInfo">serial.OpenInfo</a>
204 <ol> 200 <ol>
205 </ol> 201 </ol>
206 </li><li> 202 </li><li>
207 <a href="#type-experimental.usb.GenericTransferInfo">experimenta l.usb.GenericTransferInfo</a> 203 <a href="#type-serial.ReadInfo">serial.ReadInfo</a>
208 <ol> 204 <ol>
209 </ol> 205 </ol>
210 </li><li> 206 </li><li>
211 <a href="#type-experimental.usb.IsochronousTransferInfo">experim ental.usb.IsochronousTransferInfo</a> 207 <a href="#type-serial.WriteInfo">serial.WriteInfo</a>
212 <ol> 208 <ol>
213 </ol> 209 </ol>
214 </li><li> 210 </li><li>
215 <a href="#type-experimental.usb.UsbEvent">experimental.usb.UsbEv ent</a> 211 <a href="#type-serial.ControlSignalOptions">serial.ControlSignal Options</a>
216 <ol>
217 </ol>
218 </li><li>
219 <a href="#type-experimental.usb.DeviceOptions">experimental.usb. DeviceOptions</a>
220 <ol> 212 <ol>
221 </ol> 213 </ol>
222 </li> 214 </li>
223 </ol> 215 </ol>
224 </li> 216 </li>
225 </ol> 217 </ol>
226 </li> 218 </li>
227 </ol> 219 </ol>
228 </div> 220 </div>
229 <!-- /TABLE OF CONTENTS --> 221 <!-- /TABLE OF CONTENTS -->
230 <!-- Standard content lead-in for experimental API pages --> 222 <!-- Standard content lead-in for experimental API pages -->
231 <p id="classSummary"> 223 <p class="warning">
232 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page. 224 <!-- Standard content lead-in for APIs that are not yet available on
225 the stable channel. -->
226 <em>Warning:</em> This API is still under development. It is only
227 available for Chrome users on the
228 <span>
229 <strong>dev</strong>
230 <a href="http://www.chromium.org/getting-involved/dev-channel">ear ly
231 release channel</a>.</span>
232 <a href="TODO">Learn more</a>.
233 </p> 233 </p>
234 <!-- STATIC CONTENT PLACEHOLDER --> 234 <!-- STATIC CONTENT PLACEHOLDER -->
235 <div id="static"></div> 235 <div id="static"></div>
236 <!-- API PAGE --> 236 <!-- API PAGE -->
237 <div class="apiPage"> 237 <div class="apiPage">
238 <a name="apiReference"></a> 238 <a name="apiReference"></a>
239 <h2>API reference: chrome.experimental.usb</h2> 239 <h2>API reference: chrome.serial</h2>
240 <!-- PROPERTIES --> 240 <!-- PROPERTIES -->
241 <!-- /apiGroup --> 241 <!-- /apiGroup -->
242 <!-- METHODS --> 242 <!-- METHODS -->
243 <div id="methodsTemplate" class="apiGroup"> 243 <div id="methodsTemplate" class="apiGroup">
244 <a name="global-methods"></a> 244 <a name="global-methods"></a>
245 <h3>Methods</h3> 245 <h3>Methods</h3>
246 <!-- iterates over all functions --> 246 <!-- iterates over all functions -->
247 <div class="apiItem"> 247 <div class="apiItem">
248 <a name="method-bulkTransfer"></a> <!-- method-anchor --> 248 <a name="method-close"></a> <!-- method-anchor -->
249 <h4>bulkTransfer</h4> 249 <h4>close</h4>
250 <div class="summary"> 250 <div class="summary">
251 <!-- Note: intentionally longer 80 columns --> 251 <!-- Note: intentionally longer 80 columns -->
252 <span>chrome.experimental.usb.bulkTransfer</span>(<span class= "null"><span>experimental.usb.Device</span> 252 <span>chrome.serial.close</span>(<span class="null"><span>inte ger</span>
253 <var><span>device</span></var></span><span class="null"><s pan>, </span><span>experimental.usb.GenericTransferInfo</span> 253 <var><span>connectionId</span></var></span><span class="nu ll"><span>, </span><span>function</span>
254 <var><span>transferInfo</span></var></span><span class="op tional"><span>, </span><span>function</span> 254 <var><span>CloseCallback</span></var></span>)</div>
255 <var><span>TransferCallback</span></var></span>)</div>
256 <div class="description"> 255 <div class="description">
257 <p>Performs a bulk transfer on the specified device.</p> 256 <p>Closes an open connection.</p>
258 <!-- PARAMETERS --> 257 <!-- PARAMETERS -->
259 <h4>Parameters</h4> 258 <h4>Parameters</h4>
260 <dl> 259 <dl>
261 <div> 260 <div>
262 <div> 261 <div>
263 <dt> 262 <dt>
264 <var>device</var> 263 <var>connectionId</var>
265 <em> 264 <em>
266 <!-- TYPE --> 265 <!-- TYPE -->
267 <div style="display:inline"> 266 <div style="display:inline">
268 ( 267 (
269 <span id="typeTemplate"> 268 <span id="typeTemplate">
270 <span> 269 <span>
271 <a href="experimental.usb.html#type-experimental.usb.Dev ice">experimental.usb.Device</a> 270 <span>integer</span>
272 </span> 271 </span>
273 </span> 272 </span>
274 ) 273 )
275 </div> 274 </div>
276 </em> 275 </em>
277 </dt> 276 </dt>
278 <dd>An open device to make the transfer on.</dd> 277 <dd>The id of the opened connection.</dd>
279 <!-- OBJECT PROPERTIES --> 278 <!-- OBJECT PROPERTIES -->
280 <!-- OBJECT METHODS --> 279 <!-- OBJECT METHODS -->
281 <!-- OBJECT EVENT FIELDS --> 280 <!-- OBJECT EVENT FIELDS -->
282 <!-- FUNCTION PARAMETERS --> 281 <!-- FUNCTION PARAMETERS -->
283 </div> 282 </div>
284 </div><div> 283 </div><div>
285 <div> 284 <div>
286 <dt> 285 <dt>
287 <var>transferInfo</var> 286 <var>CloseCallback</var>
288 <em> 287 <em>
289 <!-- TYPE --> 288 <!-- TYPE -->
290 <div style="display:inline"> 289 <div style="display:inline">
291 ( 290 (
292 <span id="typeTemplate"> 291 <span id="typeTemplate">
293 <span> 292 <span>
294 <a href="experimental.usb.html#type-experimental.usb.Gen ericTransferInfo">experimental.usb.GenericTransferInfo</a> 293 <span>function</span>
295 </span> 294 </span>
296 </span> 295 </span>
297 ) 296 )
298 </div> 297 </div>
299 </em> 298 </em>
300 </dt> 299 </dt>
301 <dd>The paramters to the transfer. See GenericTransferInfo.</dd> 300 <dd>Returns true if operation was successful.</dd>
302 <!-- OBJECT PROPERTIES --> 301 <!-- OBJECT PROPERTIES -->
303 <!-- OBJECT METHODS --> 302 <!-- OBJECT METHODS -->
304 <!-- OBJECT EVENT FIELDS --> 303 <!-- OBJECT EVENT FIELDS -->
305 <!-- FUNCTION PARAMETERS --> 304 <!-- FUNCTION PARAMETERS -->
306 </div> 305 <dd>
307 </div><div> 306 <div>
308 <div> 307 <h5>Parameters</h5>
308 <dl>
309 <div>
310 <div>
309 <dt> 311 <dt>
310 <var>TransferCallback</var> 312 <var>result</var>
311 <em> 313 <em>
312 <!-- TYPE --> 314 <!-- TYPE -->
313 <div style="display:inline"> 315 <div style="display:inline">
314 ( 316 (
315 <span class="optional">optional</span>
316 <span id="typeTemplate"> 317 <span id="typeTemplate">
317 <span> 318 <span>
318 <span>function</span> 319 <span>boolean</span>
319 </span> 320 </span>
320 </span> 321 </span>
321 ) 322 )
322 </div> 323 </div>
323 </em> 324 </em>
324 </dt> 325 </dt>
325 <dd class="todo"> 326 <dd class="todo">
326 Undocumented. 327 Undocumented.
327 </dd> 328 </dd>
328 <!-- OBJECT PROPERTIES --> 329 <!-- OBJECT PROPERTIES -->
329 <!-- OBJECT METHODS --> 330 <!-- OBJECT METHODS -->
330 <!-- OBJECT EVENT FIELDS --> 331 <!-- OBJECT EVENT FIELDS -->
331 <!-- FUNCTION PARAMETERS --> 332 <!-- FUNCTION PARAMETERS -->
332 <dd> 333 </div>
334 </div>
335 </dl>
336 </div>
333 </dd> 337 </dd>
334 </div> 338 </div>
335 </div> 339 </div>
336 </dl> 340 </dl>
337 <!-- RETURNS -->
338 <dl>
339 </dl>
340 <!-- CALLBACK -->
341 <!-- MIN_VERSION -->
342 </div> <!-- /description -->
343 </div><div class="apiItem">
344 <a name="method-closeDevice"></a> <!-- method-anchor -->
345 <h4>closeDevice</h4>
346 <div class="summary">
347 <!-- Note: intentionally longer 80 columns -->
348 <span>chrome.experimental.usb.closeDevice</span>(<span class=" null"><span>experimental.usb.Device</span>
349 <var><span>device</span></var></span>)</div>
350 <div class="description">
351 <p>Closes an open device instance. Invoking operations on a devi ce after it has been closed is a safe operation, but causes no action to be take n.</p>
352 <!-- PARAMETERS -->
353 <h4>Parameters</h4>
354 <dl>
355 <div>
356 <div>
357 <dt>
358 <var>device</var>
359 <em>
360 <!-- TYPE -->
361 <div style="display:inline">
362 (
363 <span id="typeTemplate">
364 <span>
365 <a href="experimental.usb.html#type-experimental.usb.Dev ice">experimental.usb.Device</a>
366 </span>
367 </span>
368 )
369 </div>
370 </em>
371 </dt>
372 <dd>The device to close.</dd>
373 <!-- OBJECT PROPERTIES -->
374 <!-- OBJECT METHODS -->
375 <!-- OBJECT EVENT FIELDS -->
376 <!-- FUNCTION PARAMETERS -->
377 </div>
378 </div>
379 </dl>
380 <!-- RETURNS --> 341 <!-- RETURNS -->
381 <dl> 342 <dl>
382 </dl> 343 </dl>
383 <!-- CALLBACK --> 344 <!-- CALLBACK -->
384 <!-- MIN_VERSION --> 345 <!-- MIN_VERSION -->
385 </div> <!-- /description --> 346 </div> <!-- /description -->
386 </div><div class="apiItem"> 347 </div><div class="apiItem">
387 <a name="method-controlTransfer"></a> <!-- method-anchor --> 348 <a name="method-flush"></a> <!-- method-anchor -->
388 <h4>controlTransfer</h4> 349 <h4>flush</h4>
389 <div class="summary"> 350 <div class="summary">
390 <!-- Note: intentionally longer 80 columns --> 351 <!-- Note: intentionally longer 80 columns -->
391 <span>chrome.experimental.usb.controlTransfer</span>(<span cla ss="null"><span>experimental.usb.Device</span> 352 <span>chrome.serial.flush</span>(<span class="null"><span>inte ger</span>
392 <var><span>device</span></var></span><span class="null"><s pan>, </span><span>experimental.usb.ControlTransferInfo</span> 353 <var><span>connectionId</span></var></span><span class="nu ll"><span>, </span><span>function</span>
393 <var><span>transferInfo</span></var></span><span class="op tional"><span>, </span><span>function</span> 354 <var><span>FlushCallback</span></var></span>)</div>
394 <var><span>TransferCallback</span></var></span>)</div>
395 <div class="description"> 355 <div class="description">
396 <p>Performs a control transfer on the specified device. See the ControlTransferInfo structure for the parameters required to make a transfer.</p > 356 <p>Flushes all bytes in the given connection's input and output buffers.</p>
397 <!-- PARAMETERS --> 357 <!-- PARAMETERS -->
398 <h4>Parameters</h4> 358 <h4>Parameters</h4>
399 <dl> 359 <dl>
400 <div> 360 <div>
401 <div> 361 <div>
402 <dt> 362 <dt>
403 <var>device</var> 363 <var>connectionId</var>
404 <em> 364 <em>
405 <!-- TYPE --> 365 <!-- TYPE -->
406 <div style="display:inline"> 366 <div style="display:inline">
407 ( 367 (
408 <span id="typeTemplate"> 368 <span id="typeTemplate">
409 <span> 369 <span>
410 <a href="experimental.usb.html#type-experimental.usb.Dev ice">experimental.usb.Device</a> 370 <span>integer</span>
411 </span> 371 </span>
412 </span> 372 </span>
413 ) 373 )
414 </div> 374 </div>
415 </em> 375 </em>
416 </dt> 376 </dt>
417 <dd>An open device to make the transfer on.</dd> 377 <dd>The id of the connection.</dd>
418 <!-- OBJECT PROPERTIES --> 378 <!-- OBJECT PROPERTIES -->
419 <!-- OBJECT METHODS --> 379 <!-- OBJECT METHODS -->
420 <!-- OBJECT EVENT FIELDS --> 380 <!-- OBJECT EVENT FIELDS -->
421 <!-- FUNCTION PARAMETERS --> 381 <!-- FUNCTION PARAMETERS -->
422 </div> 382 </div>
423 </div><div> 383 </div><div>
424 <div> 384 <div>
425 <dt> 385 <dt>
426 <var>transferInfo</var> 386 <var>FlushCallback</var>
427 <em> 387 <em>
428 <!-- TYPE --> 388 <!-- TYPE -->
429 <div style="display:inline"> 389 <div style="display:inline">
430 ( 390 (
431 <span id="typeTemplate"> 391 <span id="typeTemplate">
432 <span> 392 <span>
433 <a href="experimental.usb.html#type-experimental.usb.Con trolTransferInfo">experimental.usb.ControlTransferInfo</a> 393 <span>function</span>
434 </span> 394 </span>
435 </span> 395 </span>
436 ) 396 )
437 </div> 397 </div>
438 </em> 398 </em>
439 </dt> 399 </dt>
440 <dd>The parameters to the transfer. See ControlTransferInfo.</dd> 400 <dd>Returns true if operation was successful.</dd>
441 <!-- OBJECT PROPERTIES --> 401 <!-- OBJECT PROPERTIES -->
442 <!-- OBJECT METHODS --> 402 <!-- OBJECT METHODS -->
443 <!-- OBJECT EVENT FIELDS --> 403 <!-- OBJECT EVENT FIELDS -->
444 <!-- FUNCTION PARAMETERS --> 404 <!-- FUNCTION PARAMETERS -->
445 </div> 405 <dd>
446 </div><div> 406 <div>
447 <div> 407 <h5>Parameters</h5>
408 <dl>
409 <div>
410 <div>
448 <dt> 411 <dt>
449 <var>TransferCallback</var> 412 <var>result</var>
450 <em> 413 <em>
451 <!-- TYPE --> 414 <!-- TYPE -->
452 <div style="display:inline"> 415 <div style="display:inline">
453 ( 416 (
454 <span class="optional">optional</span>
455 <span id="typeTemplate"> 417 <span id="typeTemplate">
456 <span> 418 <span>
457 <span>function</span> 419 <span>boolean</span>
458 </span> 420 </span>
459 </span> 421 </span>
460 ) 422 )
461 </div> 423 </div>
462 </em> 424 </em>
463 </dt> 425 </dt>
464 <dd class="todo"> 426 <dd class="todo">
465 Undocumented. 427 Undocumented.
466 </dd> 428 </dd>
467 <!-- OBJECT PROPERTIES --> 429 <!-- OBJECT PROPERTIES -->
468 <!-- OBJECT METHODS --> 430 <!-- OBJECT METHODS -->
469 <!-- OBJECT EVENT FIELDS --> 431 <!-- OBJECT EVENT FIELDS -->
470 <!-- FUNCTION PARAMETERS --> 432 <!-- FUNCTION PARAMETERS -->
471 <dd> 433 </div>
434 </div>
435 </dl>
436 </div>
472 </dd> 437 </dd>
473 </div> 438 </div>
474 </div> 439 </div>
475 </dl> 440 </dl>
476 <!-- RETURNS --> 441 <!-- RETURNS -->
477 <dl> 442 <dl>
478 </dl> 443 </dl>
479 <!-- CALLBACK --> 444 <!-- CALLBACK -->
480 <!-- MIN_VERSION --> 445 <!-- MIN_VERSION -->
481 </div> <!-- /description --> 446 </div> <!-- /description -->
482 </div><div class="apiItem"> 447 </div><div class="apiItem">
483 <a name="method-findDevice"></a> <!-- method-anchor --> 448 <a name="method-getControlSignals"></a> <!-- method-anchor -->
484 <h4>findDevice</h4> 449 <h4>getControlSignals</h4>
485 <div class="summary"> 450 <div class="summary">
486 <!-- Note: intentionally longer 80 columns --> 451 <!-- Note: intentionally longer 80 columns -->
487 <span>chrome.experimental.usb.findDevice</span>(<span class="n ull"><span>integer</span> 452 <span>chrome.serial.getControlSignals</span>(<span class="null "><span>integer</span>
488 <var><span>vendorId</span></var></span><span class="null"> <span>, </span><span>integer</span> 453 <var><span>connectionId</span></var></span><span class="nu ll"><span>, </span><span>function</span>
489 <var><span>productId</span></var></span><span class="null" ><span>, </span><span>experimental.usb.DeviceOptions</span> 454 <var><span>GetControlSignalsCallback</span></var></span>)< /div>
490 <var><span>options</span></var></span><span class="null">< span>, </span><span>function</span>
491 <var><span>FindDeviceCallback</span></var></span>)</div>
492 <div class="description"> 455 <div class="description">
493 <p>Finds the first instance of the USB device specified by the v endorId/ productId pair and, if permissions allow, opens it for use. Upon succes sfully opening a device the callback is invoked with a populated Device object. On failure, the callback is invoked with null.</p>
494 <!-- PARAMETERS --> 456 <!-- PARAMETERS -->
495 <h4>Parameters</h4> 457 <h4>Parameters</h4>
496 <dl> 458 <dl>
497 <div> 459 <div>
498 <div> 460 <div>
499 <dt> 461 <dt>
500 <var>vendorId</var> 462 <var>connectionId</var>
501 <em> 463 <em>
502 <!-- TYPE --> 464 <!-- TYPE -->
503 <div style="display:inline"> 465 <div style="display:inline">
504 ( 466 (
505 <span id="typeTemplate"> 467 <span id="typeTemplate">
506 <span> 468 <span>
507 <span>integer</span> 469 <span>integer</span>
508 </span> 470 </span>
509 </span> 471 </span>
510 ) 472 )
511 </div> 473 </div>
512 </em> 474 </em>
513 </dt> 475 </dt>
514 <dd>The vendor ID of the USB device to find.</dd> 476 <dd class="todo">
477 Undocumented.
478 </dd>
515 <!-- OBJECT PROPERTIES --> 479 <!-- OBJECT PROPERTIES -->
516 <!-- OBJECT METHODS --> 480 <!-- OBJECT METHODS -->
517 <!-- OBJECT EVENT FIELDS --> 481 <!-- OBJECT EVENT FIELDS -->
518 <!-- FUNCTION PARAMETERS --> 482 <!-- FUNCTION PARAMETERS -->
519 </div> 483 </div>
520 </div><div> 484 </div><div>
521 <div> 485 <div>
522 <dt> 486 <dt>
523 <var>productId</var> 487 <var>GetControlSignalsCallback</var>
524 <em> 488 <em>
525 <!-- TYPE --> 489 <!-- TYPE -->
526 <div style="display:inline"> 490 <div style="display:inline">
527 ( 491 (
528 <span id="typeTemplate"> 492 <span id="typeTemplate">
529 <span> 493 <span>
530 <span>integer</span> 494 <span>function</span>
531 </span> 495 </span>
532 </span> 496 </span>
533 ) 497 )
534 </div> 498 </div>
535 </em> 499 </em>
536 </dt> 500 </dt>
537 <dd>The product ID of the USB device to find.</dd> 501 <dd>Returns a snapshot of current control signals.</dd>
538 <!-- OBJECT PROPERTIES --> 502 <!-- OBJECT PROPERTIES -->
539 <!-- OBJECT METHODS --> 503 <!-- OBJECT METHODS -->
540 <!-- OBJECT EVENT FIELDS --> 504 <!-- OBJECT EVENT FIELDS -->
541 <!-- FUNCTION PARAMETERS --> 505 <!-- FUNCTION PARAMETERS -->
542 </div> 506 <dd>
543 </div><div> 507 <div>
544 <div> 508 <h5>Parameters</h5>
509 <dl>
510 <div>
511 <div>
545 <dt> 512 <dt>
546 <var>options</var> 513 <var>options</var>
547 <em> 514 <em>
548 <!-- TYPE --> 515 <!-- TYPE -->
549 <div style="display:inline"> 516 <div style="display:inline">
550 ( 517 (
551 <span id="typeTemplate"> 518 <span id="typeTemplate">
552 <span> 519 <span>
553 <a href="experimental.usb.html#type-experimental.usb.Dev iceOptions">experimental.usb.DeviceOptions</a> 520 <a href="serial.html#type-serial.ControlSignalOptions">s erial.ControlSignalOptions</a>
554 </span> 521 </span>
555 </span> 522 </span>
556 ) 523 )
557 </div> 524 </div>
558 </em> 525 </em>
559 </dt> 526 </dt>
560 <dd class="todo"> 527 <dd class="todo">
561 Undocumented. 528 Undocumented.
562 </dd> 529 </dd>
563 <!-- OBJECT PROPERTIES --> 530 <!-- OBJECT PROPERTIES -->
564 <!-- OBJECT METHODS --> 531 <!-- OBJECT METHODS -->
565 <!-- OBJECT EVENT FIELDS --> 532 <!-- OBJECT EVENT FIELDS -->
566 <!-- FUNCTION PARAMETERS --> 533 <!-- FUNCTION PARAMETERS -->
567 </div> 534 </div>
568 </div><div> 535 </div>
536 </dl>
537 </div>
538 </dd>
539 </div>
540 </div>
541 </dl>
542 <!-- RETURNS -->
543 <dl>
544 </dl>
545 <!-- CALLBACK -->
546 <!-- MIN_VERSION -->
547 </div> <!-- /description -->
548 </div><div class="apiItem">
549 <a name="method-getPorts"></a> <!-- method-anchor -->
550 <h4>getPorts</h4>
551 <div class="summary">
552 <!-- Note: intentionally longer 80 columns -->
553 <span>chrome.serial.getPorts</span>(<span class="null"><span>f unction</span>
554 <var><span>GetPortsCallback</span></var></span>)</div>
555 <div class="description">
556 <p>Returns names of valid ports on this machine, each of which i s likely to be valid to pass as the port argument to open(). The list is regener ated each time this method is called, as port validity is dynamic.</p>
557 <!-- PARAMETERS -->
558 <h4>Parameters</h4>
559 <dl>
560 <div>
569 <div> 561 <div>
570 <dt> 562 <dt>
571 <var>FindDeviceCallback</var> 563 <var>GetPortsCallback</var>
572 <em> 564 <em>
573 <!-- TYPE --> 565 <!-- TYPE -->
574 <div style="display:inline"> 566 <div style="display:inline">
575 ( 567 (
576 <span id="typeTemplate"> 568 <span id="typeTemplate">
577 <span> 569 <span>
578 <span>function</span> 570 <span>function</span>
579 </span> 571 </span>
580 </span> 572 </span>
581 ) 573 )
582 </div> 574 </div>
583 </em> 575 </em>
584 </dt> 576 </dt>
585 <dd class="todo"> 577 <dd class="todo">
586 Undocumented. 578 Undocumented.
587 </dd> 579 </dd>
588 <!-- OBJECT PROPERTIES --> 580 <!-- OBJECT PROPERTIES -->
589 <!-- OBJECT METHODS --> 581 <!-- OBJECT METHODS -->
590 <!-- OBJECT EVENT FIELDS --> 582 <!-- OBJECT EVENT FIELDS -->
591 <!-- FUNCTION PARAMETERS --> 583 <!-- FUNCTION PARAMETERS -->
592 <dd> 584 <dd>
593 <div> 585 <div>
594 <h5>Parameters</h5> 586 <h5>Parameters</h5>
595 <dl> 587 <dl>
596 <div> 588 <div>
597 <div> 589 <div>
598 <dt> 590 <dt>
599 <var>device</var> 591 <var>ports</var>
600 <em> 592 <em>
601 <!-- TYPE --> 593 <!-- TYPE -->
602 <div style="display:inline"> 594 <div style="display:inline">
603 ( 595 (
604 <span class="optional">optional</span>
605 <span id="typeTemplate"> 596 <span id="typeTemplate">
606 <span> 597 <span>
607 <a href="experimental.usb.html#type-experimental.usb.Dev ice">experimental.usb.Device</a> 598 <span>
599 array of <span><span>
600 <span>
601 <span>string</span>
602 </span>
603 </span></span>
604 </span>
608 </span> 605 </span>
609 </span> 606 </span>
610 ) 607 )
611 </div> 608 </div>
612 </em> 609 </em>
613 </dt> 610 </dt>
614 <dd class="todo"> 611 <dd class="todo">
615 Undocumented. 612 Undocumented.
616 </dd> 613 </dd>
617 <!-- OBJECT PROPERTIES --> 614 <!-- OBJECT PROPERTIES -->
618 <!-- OBJECT METHODS --> 615 <!-- OBJECT METHODS -->
619 <!-- OBJECT EVENT FIELDS --> 616 <!-- OBJECT EVENT FIELDS -->
620 <!-- FUNCTION PARAMETERS --> 617 <!-- FUNCTION PARAMETERS -->
621 </div> 618 </div>
622 </div> 619 </div>
623 </dl> 620 </dl>
624 </div> 621 </div>
625 </dd> 622 </dd>
626 </div> 623 </div>
627 </div> 624 </div>
628 </dl> 625 </dl>
629 <!-- RETURNS --> 626 <!-- RETURNS -->
630 <dl> 627 <dl>
631 </dl> 628 </dl>
632 <!-- CALLBACK --> 629 <!-- CALLBACK -->
633 <!-- MIN_VERSION --> 630 <!-- MIN_VERSION -->
634 </div> <!-- /description --> 631 </div> <!-- /description -->
635 </div><div class="apiItem"> 632 </div><div class="apiItem">
636 <a name="method-interruptTransfer"></a> <!-- method-anchor --> 633 <a name="method-open"></a> <!-- method-anchor -->
637 <h4>interruptTransfer</h4> 634 <h4>open</h4>
638 <div class="summary"> 635 <div class="summary">
639 <!-- Note: intentionally longer 80 columns --> 636 <!-- Note: intentionally longer 80 columns -->
640 <span>chrome.experimental.usb.interruptTransfer</span>(<span c lass="null"><span>experimental.usb.Device</span> 637 <span>chrome.serial.open</span>(<span class="null"><span>strin g</span>
641 <var><span>device</span></var></span><span class="null"><s pan>, </span><span>experimental.usb.GenericTransferInfo</span> 638 <var><span>port</span></var></span><span class="optional"> <span>, </span><span>serial.OpenOptions</span>
642 <var><span>transferInfo</span></var></span><span class="op tional"><span>, </span><span>function</span> 639 <var><span>options</span></var></span><span class="null">< span>, </span><span>function</span>
643 <var><span>TransferCallback</span></var></span>)</div> 640 <var><span>OpenCallback</span></var></span>)</div>
644 <div class="description"> 641 <div class="description">
645 <p>Performs an interrupt transfer on the specified device.</p> 642 <p>Opens a connection to the given serial port.</p>
646 <!-- PARAMETERS --> 643 <!-- PARAMETERS -->
647 <h4>Parameters</h4> 644 <h4>Parameters</h4>
648 <dl> 645 <dl>
649 <div> 646 <div>
650 <div> 647 <div>
651 <dt> 648 <dt>
652 <var>device</var> 649 <var>port</var>
653 <em> 650 <em>
654 <!-- TYPE --> 651 <!-- TYPE -->
655 <div style="display:inline"> 652 <div style="display:inline">
656 ( 653 (
657 <span id="typeTemplate"> 654 <span id="typeTemplate">
658 <span> 655 <span>
659 <a href="experimental.usb.html#type-experimental.usb.Dev ice">experimental.usb.Device</a> 656 <span>string</span>
660 </span> 657 </span>
661 </span> 658 </span>
662 ) 659 )
663 </div> 660 </div>
664 </em> 661 </em>
665 </dt> 662 </dt>
666 <dd>An open device to make the transfer on.</dd> 663 <dd>The name of the serial port to open.</dd>
667 <!-- OBJECT PROPERTIES --> 664 <!-- OBJECT PROPERTIES -->
668 <!-- OBJECT METHODS --> 665 <!-- OBJECT METHODS -->
669 <!-- OBJECT EVENT FIELDS --> 666 <!-- OBJECT EVENT FIELDS -->
670 <!-- FUNCTION PARAMETERS --> 667 <!-- FUNCTION PARAMETERS -->
671 </div> 668 </div>
672 </div><div> 669 </div><div>
673 <div> 670 <div>
674 <dt> 671 <dt>
675 <var>transferInfo</var> 672 <var>options</var>
676 <em> 673 <em>
677 <!-- TYPE --> 674 <!-- TYPE -->
678 <div style="display:inline"> 675 <div style="display:inline">
679 ( 676 (
677 <span class="optional">optional</span>
680 <span id="typeTemplate"> 678 <span id="typeTemplate">
681 <span> 679 <span>
682 <a href="experimental.usb.html#type-experimental.usb.Gen ericTransferInfo">experimental.usb.GenericTransferInfo</a> 680 <a href="serial.html#type-serial.OpenOptions">serial.Ope nOptions</a>
683 </span> 681 </span>
684 </span> 682 </span>
685 ) 683 )
686 </div> 684 </div>
687 </em> 685 </em>
688 </dt> 686 </dt>
689 <dd>The paramters to the transfer. See GenericTransferInfo.</dd> 687 <dd>Connection options.</dd>
690 <!-- OBJECT PROPERTIES --> 688 <!-- OBJECT PROPERTIES -->
691 <!-- OBJECT METHODS --> 689 <!-- OBJECT METHODS -->
692 <!-- OBJECT EVENT FIELDS --> 690 <!-- OBJECT EVENT FIELDS -->
693 <!-- FUNCTION PARAMETERS --> 691 <!-- FUNCTION PARAMETERS -->
694 </div> 692 </div>
695 </div><div> 693 </div><div>
696 <div> 694 <div>
697 <dt> 695 <dt>
698 <var>TransferCallback</var> 696 <var>OpenCallback</var>
699 <em> 697 <em>
700 <!-- TYPE --> 698 <!-- TYPE -->
701 <div style="display:inline"> 699 <div style="display:inline">
702 ( 700 (
703 <span class="optional">optional</span>
704 <span id="typeTemplate"> 701 <span id="typeTemplate">
705 <span> 702 <span>
706 <span>function</span> 703 <span>function</span>
707 </span> 704 </span>
708 </span> 705 </span>
709 ) 706 )
710 </div> 707 </div>
711 </em> 708 </em>
712 </dt> 709 </dt>
713 <dd class="todo"> 710 <dd class="todo">
714 Undocumented. 711 Undocumented.
715 </dd> 712 </dd>
716 <!-- OBJECT PROPERTIES --> 713 <!-- OBJECT PROPERTIES -->
717 <!-- OBJECT METHODS --> 714 <!-- OBJECT METHODS -->
718 <!-- OBJECT EVENT FIELDS --> 715 <!-- OBJECT EVENT FIELDS -->
719 <!-- FUNCTION PARAMETERS --> 716 <!-- FUNCTION PARAMETERS -->
720 <dd> 717 <dd>
718 <div>
719 <h5>Parameters</h5>
720 <dl>
721 <div>
722 <div>
723 <dt>
724 <var>openInfo</var>
725 <em>
726 <!-- TYPE -->
727 <div style="display:inline">
728 (
729 <span id="typeTemplate">
730 <span>
731 <a href="serial.html#type-serial.OpenInfo">serial.OpenIn fo</a>
732 </span>
733 </span>
734 )
735 </div>
736 </em>
737 </dt>
738 <dd class="todo">
739 Undocumented.
740 </dd>
741 <!-- OBJECT PROPERTIES -->
742 <!-- OBJECT METHODS -->
743 <!-- OBJECT EVENT FIELDS -->
744 <!-- FUNCTION PARAMETERS -->
745 </div>
746 </div>
747 </dl>
748 </div>
721 </dd> 749 </dd>
722 </div> 750 </div>
723 </div> 751 </div>
724 </dl> 752 </dl>
725 <!-- RETURNS --> 753 <!-- RETURNS -->
726 <dl> 754 <dl>
727 </dl> 755 </dl>
728 <!-- CALLBACK --> 756 <!-- CALLBACK -->
729 <!-- MIN_VERSION --> 757 <!-- MIN_VERSION -->
730 </div> <!-- /description --> 758 </div> <!-- /description -->
731 </div><div class="apiItem"> 759 </div><div class="apiItem">
732 <a name="method-isochronousTransfer"></a> <!-- method-anchor --> 760 <a name="method-read"></a> <!-- method-anchor -->
733 <h4>isochronousTransfer</h4> 761 <h4>read</h4>
734 <div class="summary"> 762 <div class="summary">
735 <!-- Note: intentionally longer 80 columns --> 763 <!-- Note: intentionally longer 80 columns -->
736 <span>chrome.experimental.usb.isochronousTransfer</span>(<span class="null"><span>experimental.usb.Device</span> 764 <span>chrome.serial.read</span>(<span class="null"><span>integ er</span>
737 <var><span>device</span></var></span><span class="null"><s pan>, </span><span>experimental.usb.IsochronousTransferInfo</span> 765 <var><span>connectionId</span></var></span><span class="nu ll"><span>, </span><span>integer</span>
738 <var><span>transferInfo</span></var></span><span class="op tional"><span>, </span><span>function</span> 766 <var><span>bytesToRead</span></var></span><span class="nul l"><span>, </span><span>function</span>
739 <var><span>TransferCallback</span></var></span>)</div> 767 <var><span>ReadCallback</span></var></span>)</div>
740 <div class="description"> 768 <div class="description">
741 <p>Performs an isochronous transfer on the specific device.</p> 769 <p>Reads a byte from the given connection.</p>
742 <!-- PARAMETERS --> 770 <!-- PARAMETERS -->
743 <h4>Parameters</h4> 771 <h4>Parameters</h4>
744 <dl> 772 <dl>
745 <div> 773 <div>
746 <div> 774 <div>
747 <dt> 775 <dt>
748 <var>device</var> 776 <var>connectionId</var>
749 <em> 777 <em>
750 <!-- TYPE --> 778 <!-- TYPE -->
751 <div style="display:inline"> 779 <div style="display:inline">
752 ( 780 (
753 <span id="typeTemplate"> 781 <span id="typeTemplate">
754 <span> 782 <span>
755 <a href="experimental.usb.html#type-experimental.usb.Dev ice">experimental.usb.Device</a> 783 <span>integer</span>
756 </span> 784 </span>
757 </span> 785 </span>
758 ) 786 )
759 </div> 787 </div>
760 </em> 788 </em>
761 </dt> 789 </dt>
762 <dd>An open device to make the transfer on.</dd> 790 <dd>The id of the connection.</dd>
763 <!-- OBJECT PROPERTIES --> 791 <!-- OBJECT PROPERTIES -->
764 <!-- OBJECT METHODS --> 792 <!-- OBJECT METHODS -->
765 <!-- OBJECT EVENT FIELDS --> 793 <!-- OBJECT EVENT FIELDS -->
766 <!-- FUNCTION PARAMETERS --> 794 <!-- FUNCTION PARAMETERS -->
767 </div> 795 </div>
768 </div><div> 796 </div><div>
769 <div> 797 <div>
770 <dt> 798 <dt>
771 <var>transferInfo</var> 799 <var>bytesToRead</var>
772 <em> 800 <em>
773 <!-- TYPE --> 801 <!-- TYPE -->
774 <div style="display:inline"> 802 <div style="display:inline">
775 ( 803 (
776 <span id="typeTemplate"> 804 <span id="typeTemplate">
777 <span> 805 <span>
778 <a href="experimental.usb.html#type-experimental.usb.Iso chronousTransferInfo">experimental.usb.IsochronousTransferInfo</a> 806 <span>integer</span>
779 </span> 807 </span>
780 </span> 808 </span>
781 ) 809 )
782 </div> 810 </div>
783 </em> 811 </em>
784 </dt> 812 </dt>
785 <dd>The parameters to the transfer. See IsochronousTransferInfo.</dd> 813 <dd>The number of bytes to read.</dd>
786 <!-- OBJECT PROPERTIES --> 814 <!-- OBJECT PROPERTIES -->
787 <!-- OBJECT METHODS --> 815 <!-- OBJECT METHODS -->
788 <!-- OBJECT EVENT FIELDS --> 816 <!-- OBJECT EVENT FIELDS -->
789 <!-- FUNCTION PARAMETERS --> 817 <!-- FUNCTION PARAMETERS -->
790 </div> 818 </div>
791 </div><div> 819 </div><div>
792 <div> 820 <div>
793 <dt> 821 <dt>
794 <var>TransferCallback</var> 822 <var>ReadCallback</var>
795 <em> 823 <em>
796 <!-- TYPE --> 824 <!-- TYPE -->
797 <div style="display:inline"> 825 <div style="display:inline">
798 ( 826 (
799 <span class="optional">optional</span>
800 <span id="typeTemplate"> 827 <span id="typeTemplate">
801 <span> 828 <span>
802 <span>function</span> 829 <span>function</span>
803 </span> 830 </span>
804 </span> 831 </span>
805 ) 832 )
806 </div> 833 </div>
807 </em> 834 </em>
808 </dt> 835 </dt>
809 <dd class="todo"> 836 <dd class="todo">
810 Undocumented. 837 Undocumented.
811 </dd> 838 </dd>
812 <!-- OBJECT PROPERTIES --> 839 <!-- OBJECT PROPERTIES -->
813 <!-- OBJECT METHODS --> 840 <!-- OBJECT METHODS -->
814 <!-- OBJECT EVENT FIELDS --> 841 <!-- OBJECT EVENT FIELDS -->
815 <!-- FUNCTION PARAMETERS --> 842 <!-- FUNCTION PARAMETERS -->
816 <dd> 843 <dd>
817 </dd> 844 <div>
818 </div> 845 <h5>Parameters</h5>
819 </div> 846 <dl>
820 </dl> 847 <div>
821 <!-- RETURNS --> 848 <div>
822 <dl>
823 </dl>
824 <!-- CALLBACK -->
825 <!-- MIN_VERSION -->
826 </div> <!-- /description -->
827 </div> <!-- /apiItem -->
828 </div> <!-- /apiGroup -->
829 <!-- EVENTS -->
830 <div id="eventsTemplate" class="apiGroup">
831 <a name="global-events"></a>
832 <h3>Events</h3>
833 <!-- iterates over all events -->
834 <div class="apiItem">
835 <a name="event-onEvent"></a>
836 <h4>onEvent</h4>
837 <div class="summary">
838 <!-- Note: intentionally longer 80 columns -->
839 <span class="subdued">chrome.experimental.usb.</span><span>onEve nt</span><span class="subdued">.addListener</span>(function(<span>experimental.u sb.UsbEvent event</span>) <span class="subdued">{...}</span><span></span>);
840 </div>
841 <div class="description">
842 <!-- LISTENER PARAMETERS -->
843 <div>
844 <h4>Listener parameters</h4>
845 <dl>
846 <div>
847 <div>
848 <dt> 849 <dt>
849 <var>event</var> 850 <var>readInfo</var>
850 <em> 851 <em>
851 <!-- TYPE --> 852 <!-- TYPE -->
852 <div style="display:inline"> 853 <div style="display:inline">
853 ( 854 (
854 <span id="typeTemplate"> 855 <span id="typeTemplate">
855 <span> 856 <span>
856 <a href="experimental.usb.html#type-experimental.usb.Usb Event">experimental.usb.UsbEvent</a> 857 <a href="serial.html#type-serial.ReadInfo">serial.ReadIn fo</a>
857 </span> 858 </span>
858 </span> 859 </span>
859 ) 860 )
860 </div> 861 </div>
861 </em> 862 </em>
862 </dt> 863 </dt>
863 <dd class="todo"> 864 <dd class="todo">
864 Undocumented. 865 Undocumented.
865 </dd> 866 </dd>
866 <!-- OBJECT PROPERTIES --> 867 <!-- OBJECT PROPERTIES -->
867 <!-- OBJECT METHODS --> 868 <!-- OBJECT METHODS -->
868 <!-- OBJECT EVENT FIELDS --> 869 <!-- OBJECT EVENT FIELDS -->
869 <!-- FUNCTION PARAMETERS --> 870 <!-- FUNCTION PARAMETERS -->
870 </div> 871 </div>
871 </div> 872 </div>
872 </dl> 873 </dl>
873 </div> 874 </div>
874 <!-- EXTRA PARAMETERS --> 875 </dd>
875 <!-- LISTENER RETURN VALUE --> 876 </div>
877 </div>
878 </dl>
879 <!-- RETURNS -->
876 <dl> 880 <dl>
877 </dl> 881 </dl>
882 <!-- CALLBACK -->
883 <!-- MIN_VERSION -->
878 </div> <!-- /description --> 884 </div> <!-- /description -->
879 <!-- /description --> 885 </div><div class="apiItem">
880 </div> <!-- /apiItem --> 886 <a name="method-setControlSignals"></a> <!-- method-anchor -->
881 </div> <!-- /apiGroup --> 887 <h4>setControlSignals</h4>
882 <!-- TYPES --> 888 <div class="summary">
883 <div class="apiGroup"> 889 <!-- Note: intentionally longer 80 columns -->
884 <a name="types"></a> 890 <span>chrome.serial.setControlSignals</span>(<span class="null "><span>integer</span>
885 <h3 id="types">Types</h3> 891 <var><span>connectionId</span></var></span><span class="nu ll"><span>, </span><span>serial.ControlSignalOptions</span>
886 <!-- iterates over all types --> 892 <var><span>options</span></var></span><span class="null">< span>, </span><span>function</span>
887 <div class="apiItem"> 893 <var><span>SetControlSignalsCallback</span></var></span>)< /div>
888 <a name="type-experimental.usb.Device"></a> 894 <div class="description">
889 <h4>experimental.usb.Device</h4> 895 <!-- PARAMETERS -->
890 <div> 896 <h4>Parameters</h4>
897 <dl>
898 <div>
899 <div>
891 <dt> 900 <dt>
901 <var>connectionId</var>
892 <em> 902 <em>
893 <!-- TYPE --> 903 <!-- TYPE -->
894 <div style="display:inline"> 904 <div style="display:inline">
895 ( 905 (
896 <span id="typeTemplate"> 906 <span id="typeTemplate">
897 <span> 907 <span>
898 <span>object</span> 908 <span>integer</span>
899 </span> 909 </span>
900 </span> 910 </span>
901 ) 911 )
902 </div> 912 </div>
903 </em> 913 </em>
904 </dt> 914 </dt>
905 <dd class="todo"> 915 <dd class="todo">
906 Undocumented. 916 Undocumented.
907 </dd> 917 </dd>
908 <!-- OBJECT PROPERTIES --> 918 <!-- OBJECT PROPERTIES -->
909 <dd> 919 <!-- OBJECT METHODS -->
910 <dl> 920 <!-- OBJECT EVENT FIELDS -->
911 <div> 921 <!-- FUNCTION PARAMETERS -->
912 <div> 922 </div>
923 </div><div>
924 <div>
913 <dt> 925 <dt>
914 <var>handle</var> 926 <var>options</var>
915 <em> 927 <em>
916 <!-- TYPE --> 928 <!-- TYPE -->
917 <div style="display:inline"> 929 <div style="display:inline">
918 ( 930 (
919 <span id="typeTemplate"> 931 <span id="typeTemplate">
920 <span> 932 <span>
921 <span>integer</span> 933 <a href="serial.html#type-serial.ControlSignalOptions">s erial.ControlSignalOptions</a>
922 </span> 934 </span>
923 </span> 935 </span>
924 ) 936 )
925 </div> 937 </div>
926 </em> 938 </em>
927 </dt> 939 </dt>
928 <dd class="todo"> 940 <dd class="todo">
929 Undocumented. 941 Undocumented.
930 </dd> 942 </dd>
931 <!-- OBJECT PROPERTIES --> 943 <!-- OBJECT PROPERTIES -->
932 <!-- OBJECT METHODS --> 944 <!-- OBJECT METHODS -->
933 <!-- OBJECT EVENT FIELDS --> 945 <!-- OBJECT EVENT FIELDS -->
934 <!-- FUNCTION PARAMETERS --> 946 <!-- FUNCTION PARAMETERS -->
935 </div> 947 </div>
936 </div><div> 948 </div><div>
937 <div> 949 <div>
938 <dt> 950 <dt>
939 <var>productId</var> 951 <var>SetControlSignalsCallback</var>
940 <em> 952 <em>
941 <!-- TYPE --> 953 <!-- TYPE -->
942 <div style="display:inline"> 954 <div style="display:inline">
943 ( 955 (
944 <span id="typeTemplate"> 956 <span id="typeTemplate">
945 <span> 957 <span>
946 <span>integer</span> 958 <span>function</span>
947 </span> 959 </span>
948 </span> 960 </span>
949 ) 961 )
950 </div> 962 </div>
951 </em> 963 </em>
952 </dt> 964 </dt>
953 <dd class="todo"> 965 <dd>Returns true if operation was successful.</dd>
954 Undocumented.
955 </dd>
956 <!-- OBJECT PROPERTIES --> 966 <!-- OBJECT PROPERTIES -->
957 <!-- OBJECT METHODS --> 967 <!-- OBJECT METHODS -->
958 <!-- OBJECT EVENT FIELDS --> 968 <!-- OBJECT EVENT FIELDS -->
959 <!-- FUNCTION PARAMETERS --> 969 <!-- FUNCTION PARAMETERS -->
960 </div> 970 <dd>
961 </div><div> 971 <div>
962 <div> 972 <h5>Parameters</h5>
973 <dl>
974 <div>
975 <div>
963 <dt> 976 <dt>
964 <var>vendorId</var> 977 <var>result</var>
965 <em> 978 <em>
966 <!-- TYPE --> 979 <!-- TYPE -->
967 <div style="display:inline"> 980 <div style="display:inline">
968 ( 981 (
969 <span id="typeTemplate"> 982 <span id="typeTemplate">
970 <span> 983 <span>
971 <span>integer</span> 984 <span>boolean</span>
972 </span> 985 </span>
973 </span> 986 </span>
974 ) 987 )
975 </div> 988 </div>
976 </em> 989 </em>
977 </dt> 990 </dt>
978 <dd class="todo"> 991 <dd class="todo">
979 Undocumented. 992 Undocumented.
980 </dd> 993 </dd>
981 <!-- OBJECT PROPERTIES --> 994 <!-- OBJECT PROPERTIES -->
982 <!-- OBJECT METHODS --> 995 <!-- OBJECT METHODS -->
983 <!-- OBJECT EVENT FIELDS --> 996 <!-- OBJECT EVENT FIELDS -->
984 <!-- FUNCTION PARAMETERS --> 997 <!-- FUNCTION PARAMETERS -->
985 </div> 998 </div>
986 </div> 999 </div>
987 </dl> 1000 </dl>
1001 </div>
988 </dd> 1002 </dd>
989 <!-- OBJECT METHODS -->
990 <!-- OBJECT EVENT FIELDS -->
991 <!-- FUNCTION PARAMETERS -->
992 </div> 1003 </div>
1004 </div>
1005 </dl>
1006 <!-- RETURNS -->
1007 <dl>
1008 </dl>
1009 <!-- CALLBACK -->
1010 <!-- MIN_VERSION -->
1011 </div> <!-- /description -->
993 </div><div class="apiItem"> 1012 </div><div class="apiItem">
994 <a name="type-experimental.usb.ControlTransferInfo"></a> 1013 <a name="method-write"></a> <!-- method-anchor -->
995 <h4>experimental.usb.ControlTransferInfo</h4> 1014 <h4>write</h4>
996 <div> 1015 <div class="summary">
1016 <!-- Note: intentionally longer 80 columns -->
1017 <span>chrome.serial.write</span>(<span class="null"><span>inte ger</span>
1018 <var><span>connectionId</span></var></span><span class="nu ll"><span>, </span><span>ArrayBuffer</span>
1019 <var><span>data</span></var></span><span class="null"><spa n>, </span><span>function</span>
1020 <var><span>WriteCallback</span></var></span>)</div>
1021 <div class="description">
1022 <p>Writes a string to the given connection.</p>
1023 <!-- PARAMETERS -->
1024 <h4>Parameters</h4>
1025 <dl>
1026 <div>
1027 <div>
997 <dt> 1028 <dt>
998 <em> 1029 <var>connectionId</var>
999 <!-- TYPE -->
1000 <div style="display:inline">
1001 (
1002 <span id="typeTemplate">
1003 <span>
1004 <span>object</span>
1005 </span>
1006 </span>
1007 )
1008 </div>
1009 </em>
1010 </dt>
1011 <dd class="todo">
1012 Undocumented.
1013 </dd>
1014 <!-- OBJECT PROPERTIES -->
1015 <dd>
1016 <dl>
1017 <div>
1018 <div>
1019 <dt>
1020 <var>data</var>
1021 <em>
1022 <!-- TYPE -->
1023 <div style="display:inline">
1024 (
1025 <span class="optional">optional</span>
1026 <span id="typeTemplate">
1027 <span>
1028 <span>ArrayBuffer</span>
1029 </span>
1030 </span>
1031 )
1032 </div>
1033 </em>
1034 </dt>
1035 <dd>The data payload carried by this transfer. If this is an output tr anfer then this field must be set.</dd>
1036 <!-- OBJECT PROPERTIES -->
1037 <!-- OBJECT METHODS -->
1038 <!-- OBJECT EVENT FIELDS -->
1039 <!-- FUNCTION PARAMETERS -->
1040 </div>
1041 </div><div>
1042 <div>
1043 <dt>
1044 <var>direction</var>
1045 <em>
1046 <!-- TYPE -->
1047 <div style="display:inline">
1048 (
1049 <span id="typeTemplate">
1050 <span>
1051 <span>string</span>
1052 </span>
1053 </span>
1054 )
1055 </div>
1056 </em>
1057 </dt>
1058 <dd>The direction of this transfer. Must be one of either in or out.</ dd>
1059 <!-- OBJECT PROPERTIES -->
1060 <!-- OBJECT METHODS -->
1061 <!-- OBJECT EVENT FIELDS -->
1062 <!-- FUNCTION PARAMETERS -->
1063 </div>
1064 </div><div>
1065 <div>
1066 <dt>
1067 <var>index</var>
1068 <em> 1030 <em>
1069 <!-- TYPE --> 1031 <!-- TYPE -->
1070 <div style="display:inline"> 1032 <div style="display:inline">
1071 ( 1033 (
1072 <span id="typeTemplate"> 1034 <span id="typeTemplate">
1073 <span> 1035 <span>
1074 <span>integer</span> 1036 <span>integer</span>
1075 </span> 1037 </span>
1076 </span> 1038 </span>
1077 ) 1039 )
1040 </div>
1041 </em>
1042 </dt>
1043 <dd>The id of the connection.</dd>
1044 <!-- OBJECT PROPERTIES -->
1045 <!-- OBJECT METHODS -->
1046 <!-- OBJECT EVENT FIELDS -->
1047 <!-- FUNCTION PARAMETERS -->
1048 </div>
1049 </div><div>
1050 <div>
1051 <dt>
1052 <var>data</var>
1053 <em>
1054 <!-- TYPE -->
1055 <div style="display:inline">
1056 (
1057 <span id="typeTemplate">
1058 <span>
1059 <span>ArrayBuffer</span>
1060 </span>
1061 </span>
1062 )
1063 </div>
1064 </em>
1065 </dt>
1066 <dd>The string to write.</dd>
1067 <!-- OBJECT PROPERTIES -->
1068 <!-- OBJECT METHODS -->
1069 <!-- OBJECT EVENT FIELDS -->
1070 <!-- FUNCTION PARAMETERS -->
1071 </div>
1072 </div><div>
1073 <div>
1074 <dt>
1075 <var>WriteCallback</var>
1076 <em>
1077 <!-- TYPE -->
1078 <div style="display:inline">
1079 (
1080 <span id="typeTemplate">
1081 <span>
1082 <span>function</span>
1083 </span>
1084 </span>
1085 )
1078 </div> 1086 </div>
1079 </em> 1087 </em>
1080 </dt> 1088 </dt>
1081 <dd class="todo"> 1089 <dd class="todo">
1082 Undocumented. 1090 Undocumented.
1083 </dd> 1091 </dd>
1084 <!-- OBJECT PROPERTIES --> 1092 <!-- OBJECT PROPERTIES -->
1085 <!-- OBJECT METHODS --> 1093 <!-- OBJECT METHODS -->
1086 <!-- OBJECT EVENT FIELDS --> 1094 <!-- OBJECT EVENT FIELDS -->
1087 <!-- FUNCTION PARAMETERS --> 1095 <!-- FUNCTION PARAMETERS -->
1088 </div> 1096 <dd>
1089 </div><div> 1097 <div>
1090 <div> 1098 <h5>Parameters</h5>
1099 <dl>
1100 <div>
1101 <div>
1091 <dt> 1102 <dt>
1092 <var>length</var> 1103 <var>writeInfo</var>
1093 <em> 1104 <em>
1094 <!-- TYPE --> 1105 <!-- TYPE -->
1095 <div style="display:inline"> 1106 <div style="display:inline">
1096 ( 1107 (
1097 <span class="optional">optional</span>
1098 <span id="typeTemplate"> 1108 <span id="typeTemplate">
1099 <span> 1109 <span>
1100 <span>integer</span> 1110 <a href="serial.html#type-serial.WriteInfo">serial.Write Info</a>
1101 </span> 1111 </span>
1102 </span> 1112 </span>
1103 ) 1113 )
1104 </div> 1114 </div>
1105 </em> 1115 </em>
1106 </dt> 1116 </dt>
1107 <dd>If this transfer is an input transfer, then this field must be set to indicate the expected data length. If this is an output transfer, then this field is ignored.</dd> 1117 <dd class="todo">
1118 Undocumented.
1119 </dd>
1108 <!-- OBJECT PROPERTIES --> 1120 <!-- OBJECT PROPERTIES -->
1109 <!-- OBJECT METHODS --> 1121 <!-- OBJECT METHODS -->
1110 <!-- OBJECT EVENT FIELDS --> 1122 <!-- OBJECT EVENT FIELDS -->
1111 <!-- FUNCTION PARAMETERS --> 1123 <!-- FUNCTION PARAMETERS -->
1112 </div> 1124 </div>
1113 </div><div> 1125 </div>
1114 <div> 1126 </dl>
1127 </div>
1128 </dd>
1129 </div>
1130 </div>
1131 </dl>
1132 <!-- RETURNS -->
1133 <dl>
1134 </dl>
1135 <!-- CALLBACK -->
1136 <!-- MIN_VERSION -->
1137 </div> <!-- /description -->
1138 </div> <!-- /apiItem -->
1139 </div> <!-- /apiGroup -->
1140 <!-- EVENTS -->
1141 <!-- /apiGroup -->
1142 <!-- TYPES -->
1143 <div class="apiGroup">
1144 <a name="types"></a>
1145 <h3 id="types">Types</h3>
1146 <!-- iterates over all types -->
1147 <div class="apiItem">
1148 <a name="type-serial.OpenOptions"></a>
1149 <h4>serial.OpenOptions</h4>
1150 <div>
1115 <dt> 1151 <dt>
1116 <var>recipient</var>
1117 <em> 1152 <em>
1118 <!-- TYPE --> 1153 <!-- TYPE -->
1119 <div style="display:inline"> 1154 <div style="display:inline">
1120 ( 1155 (
1121 <span id="typeTemplate"> 1156 <span id="typeTemplate">
1122 <span> 1157 <span>
1123 <span>string</span> 1158 <span>object</span>
1124 </span> 1159 </span>
1125 </span> 1160 </span>
1126 ) 1161 )
1127 </div>
1128 </em>
1129 </dt>
1130 <dd>The intended recipient for this transfer. Must be one of device, i nterface, endpoint, or other.</dd>
1131 <!-- OBJECT PROPERTIES -->
1132 <!-- OBJECT METHODS -->
1133 <!-- OBJECT EVENT FIELDS -->
1134 <!-- FUNCTION PARAMETERS -->
1135 </div>
1136 </div><div>
1137 <div>
1138 <dt>
1139 <var>request</var>
1140 <em>
1141 <!-- TYPE -->
1142 <div style="display:inline">
1143 (
1144 <span id="typeTemplate">
1145 <span>
1146 <span>integer</span>
1147 </span>
1148 </span>
1149 )
1150 </div> 1162 </div>
1151 </em> 1163 </em>
1152 </dt> 1164 </dt>
1153 <dd class="todo"> 1165 <dd class="todo">
1154 Undocumented. 1166 Undocumented.
1155 </dd> 1167 </dd>
1156 <!-- OBJECT PROPERTIES --> 1168 <!-- OBJECT PROPERTIES -->
1157 <!-- OBJECT METHODS --> 1169 <dd>
1158 <!-- OBJECT EVENT FIELDS --> 1170 <dl>
1159 <!-- FUNCTION PARAMETERS --> 1171 <div>
1160 </div>
1161 </div><div>
1162 <div> 1172 <div>
1163 <dt> 1173 <dt>
1164 <var>requestType</var> 1174 <var>bitrate</var>
1165 <em> 1175 <em>
1166 <!-- TYPE --> 1176 <!-- TYPE -->
1167 <div style="display:inline"> 1177 <div style="display:inline">
1168 (
1169 <span id="typeTemplate">
1170 <span>
1171 <span>string</span>
1172 </span>
1173 </span>
1174 )
1175 </div>
1176 </em>
1177 </dt>
1178 <dd>The type of this request. Must be one of standard, class, vendor, or reserved.</dd>
1179 <!-- OBJECT PROPERTIES -->
1180 <!-- OBJECT METHODS -->
1181 <!-- OBJECT EVENT FIELDS -->
1182 <!-- FUNCTION PARAMETERS -->
1183 </div>
1184 </div><div>
1185 <div>
1186 <dt>
1187 <var>value</var>
1188 <em>
1189 <!-- TYPE -->
1190 <div style="display:inline">
1191 ( 1178 (
1192 <span id="typeTemplate"> 1179 <span id="typeTemplate">
1193 <span> 1180 <span>
1194 <span>integer</span> 1181 <span>integer</span>
1195 </span> 1182 </span>
1196 </span> 1183 </span>
1197 ) 1184 )
1198 </div> 1185 </div>
1199 </em> 1186 </em>
1200 </dt> 1187 </dt>
1201 <dd class="todo"> 1188 <dd>The requested bitrate of the connection to be opened. For compatib ility with the widest range of hardware, this number should match one of commonl y-available bitrates, such as 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38 400, 57600, 115200. There is no guarantee, of course, that the device connected to the serial port will support the requested bitrate, even if the port itself s upports that bitrate.</dd>
1202 Undocumented.
1203 </dd>
1204 <!-- OBJECT PROPERTIES --> 1189 <!-- OBJECT PROPERTIES -->
1205 <!-- OBJECT METHODS --> 1190 <!-- OBJECT METHODS -->
1206 <!-- OBJECT EVENT FIELDS --> 1191 <!-- OBJECT EVENT FIELDS -->
1207 <!-- FUNCTION PARAMETERS --> 1192 <!-- FUNCTION PARAMETERS -->
1208 </div> 1193 </div>
1209 </div> 1194 </div>
1210 </dl> 1195 </dl>
1211 </dd> 1196 </dd>
1212 <!-- OBJECT METHODS --> 1197 <!-- OBJECT METHODS -->
1213 <!-- OBJECT EVENT FIELDS --> 1198 <!-- OBJECT EVENT FIELDS -->
1214 <!-- FUNCTION PARAMETERS --> 1199 <!-- FUNCTION PARAMETERS -->
1215 </div> 1200 </div>
1216 </div><div class="apiItem"> 1201 </div><div class="apiItem">
1217 <a name="type-experimental.usb.GenericTransferInfo"></a> 1202 <a name="type-serial.OpenInfo"></a>
1218 <h4>experimental.usb.GenericTransferInfo</h4> 1203 <h4>serial.OpenInfo</h4>
1219 <div> 1204 <div>
1220 <dt> 1205 <dt>
1221 <em> 1206 <em>
1222 <!-- TYPE --> 1207 <!-- TYPE -->
1223 <div style="display:inline"> 1208 <div style="display:inline">
1224 ( 1209 (
1225 <span id="typeTemplate"> 1210 <span id="typeTemplate">
1226 <span> 1211 <span>
1227 <span>object</span> 1212 <span>object</span>
1228 </span> 1213 </span>
1229 </span> 1214 </span>
1230 ) 1215 )
1231 </div> 1216 </div>
1232 </em> 1217 </em>
1233 </dt> 1218 </dt>
1234 <dd class="todo"> 1219 <dd class="todo">
1235 Undocumented. 1220 Undocumented.
1236 </dd> 1221 </dd>
1237 <!-- OBJECT PROPERTIES --> 1222 <!-- OBJECT PROPERTIES -->
1238 <dd> 1223 <dd>
1239 <dl> 1224 <dl>
1240 <div> 1225 <div>
1241 <div> 1226 <div>
1242 <dt> 1227 <dt>
1243 <var>data</var> 1228 <var>connectionId</var>
1244 <em> 1229 <em>
1245 <!-- TYPE --> 1230 <!-- TYPE -->
1246 <div style="display:inline"> 1231 <div style="display:inline">
1247 ( 1232 (
1248 <span class="optional">optional</span>
1249 <span id="typeTemplate"> 1233 <span id="typeTemplate">
1250 <span> 1234 <span>
1251 <span>ArrayBuffer</span> 1235 <span>integer</span>
1252 </span> 1236 </span>
1253 </span> 1237 </span>
1254 ) 1238 )
1255 </div> 1239 </div>
1256 </em> 1240 </em>
1257 </dt> 1241 </dt>
1258 <dd>If this is an output transfer then this field must be populated. O therwise, it will be ignored.</dd> 1242 <dd>The id of the opened connection.</dd>
1259 <!-- OBJECT PROPERTIES --> 1243 <!-- OBJECT PROPERTIES -->
1260 <!-- OBJECT METHODS --> 1244 <!-- OBJECT METHODS -->
1261 <!-- OBJECT EVENT FIELDS --> 1245 <!-- OBJECT EVENT FIELDS -->
1262 <!-- FUNCTION PARAMETERS --> 1246 <!-- FUNCTION PARAMETERS -->
1263 </div> 1247 </div>
1264 </div><div> 1248 </div>
1265 <div> 1249 </dl>
1250 </dd>
1251 <!-- OBJECT METHODS -->
1252 <!-- OBJECT EVENT FIELDS -->
1253 <!-- FUNCTION PARAMETERS -->
1254 </div>
1255 </div><div class="apiItem">
1256 <a name="type-serial.ReadInfo"></a>
1257 <h4>serial.ReadInfo</h4>
1258 <div>
1266 <dt> 1259 <dt>
1267 <var>direction</var>
1268 <em> 1260 <em>
1269 <!-- TYPE --> 1261 <!-- TYPE -->
1270 <div style="display:inline"> 1262 <div style="display:inline">
1271 ( 1263 (
1272 <span id="typeTemplate"> 1264 <span id="typeTemplate">
1273 <span> 1265 <span>
1274 <span>string</span> 1266 <span>object</span>
1275 </span> 1267 </span>
1276 </span> 1268 </span>
1277 ) 1269 )
1278 </div> 1270 </div>
1279 </em> 1271 </em>
1280 </dt> 1272 </dt>
1281 <dd>The direction of this transfer. Must be one of in or out.</dd> 1273 <dd class="todo">
1274 Undocumented.
1275 </dd>
1282 <!-- OBJECT PROPERTIES --> 1276 <!-- OBJECT PROPERTIES -->
1283 <!-- OBJECT METHODS --> 1277 <dd>
1284 <!-- OBJECT EVENT FIELDS --> 1278 <dl>
1285 <!-- FUNCTION PARAMETERS --> 1279 <div>
1286 </div>
1287 </div><div>
1288 <div> 1280 <div>
1289 <dt> 1281 <dt>
1290 <var>endpoint</var> 1282 <var>bytesRead</var>
1291 <em> 1283 <em>
1292 <!-- TYPE --> 1284 <!-- TYPE -->
1293 <div style="display:inline"> 1285 <div style="display:inline">
1294 ( 1286 (
1295 <span id="typeTemplate"> 1287 <span id="typeTemplate">
1296 <span> 1288 <span>
1297 <span>integer</span> 1289 <span>integer</span>
1298 </span> 1290 </span>
1299 </span> 1291 </span>
1300 ) 1292 )
1301 </div> 1293 </div>
1302 </em> 1294 </em>
1303 </dt> 1295 </dt>
1304 <dd class="todo"> 1296 <dd>The number of bytes received, or a negative number if an error occ urred. This number will be smaller than the number of bytes requested in the ori ginal read call if the call would need to block to read that number of bytes.</d d>
1305 Undocumented.
1306 </dd>
1307 <!-- OBJECT PROPERTIES --> 1297 <!-- OBJECT PROPERTIES -->
1308 <!-- OBJECT METHODS --> 1298 <!-- OBJECT METHODS -->
1309 <!-- OBJECT EVENT FIELDS --> 1299 <!-- OBJECT EVENT FIELDS -->
1310 <!-- FUNCTION PARAMETERS --> 1300 <!-- FUNCTION PARAMETERS -->
1311 </div> 1301 </div>
1312 </div><div> 1302 </div><div>
1313 <div> 1303 <div>
1314 <dt> 1304 <dt>
1315 <var>length</var> 1305 <var>data</var>
1316 <em> 1306 <em>
1317 <!-- TYPE --> 1307 <!-- TYPE -->
1318 <div style="display:inline"> 1308 <div style="display:inline">
1319 ( 1309 (
1320 <span class="optional">optional</span>
1321 <span id="typeTemplate"> 1310 <span id="typeTemplate">
1322 <span> 1311 <span>
1323 <span>integer</span> 1312 <span>ArrayBuffer</span>
1324 </span> 1313 </span>
1325 </span> 1314 </span>
1326 ) 1315 )
1327 </div> 1316 </div>
1328 </em> 1317 </em>
1329 </dt> 1318 </dt>
1330 <dd>If this is an input transfer then this field indicates the size of the input buffer. If this is an output transfer then this field is ignored.</dd > 1319 <dd>The data received.</dd>
1331 <!-- OBJECT PROPERTIES --> 1320 <!-- OBJECT PROPERTIES -->
1332 <!-- OBJECT METHODS --> 1321 <!-- OBJECT METHODS -->
1333 <!-- OBJECT EVENT FIELDS --> 1322 <!-- OBJECT EVENT FIELDS -->
1334 <!-- FUNCTION PARAMETERS --> 1323 <!-- FUNCTION PARAMETERS -->
1335 </div> 1324 </div>
1336 </div> 1325 </div>
1337 </dl> 1326 </dl>
1338 </dd> 1327 </dd>
1339 <!-- OBJECT METHODS --> 1328 <!-- OBJECT METHODS -->
1340 <!-- OBJECT EVENT FIELDS --> 1329 <!-- OBJECT EVENT FIELDS -->
1341 <!-- FUNCTION PARAMETERS --> 1330 <!-- FUNCTION PARAMETERS -->
1342 </div> 1331 </div>
1343 </div><div class="apiItem"> 1332 </div><div class="apiItem">
1344 <a name="type-experimental.usb.IsochronousTransferInfo"></a> 1333 <a name="type-serial.WriteInfo"></a>
1345 <h4>experimental.usb.IsochronousTransferInfo</h4> 1334 <h4>serial.WriteInfo</h4>
1346 <div> 1335 <div>
1347 <dt> 1336 <dt>
1348 <em> 1337 <em>
1349 <!-- TYPE --> 1338 <!-- TYPE -->
1350 <div style="display:inline"> 1339 <div style="display:inline">
1351 ( 1340 (
1352 <span id="typeTemplate"> 1341 <span id="typeTemplate">
1353 <span> 1342 <span>
1354 <span>object</span> 1343 <span>object</span>
1355 </span> 1344 </span>
1356 </span> 1345 </span>
1357 ) 1346 )
1358 </div> 1347 </div>
1359 </em> 1348 </em>
1360 </dt> 1349 </dt>
1361 <dd class="todo"> 1350 <dd class="todo">
1362 Undocumented. 1351 Undocumented.
1363 </dd> 1352 </dd>
1364 <!-- OBJECT PROPERTIES --> 1353 <!-- OBJECT PROPERTIES -->
1365 <dd> 1354 <dd>
1366 <dl> 1355 <dl>
1367 <div> 1356 <div>
1368 <div> 1357 <div>
1369 <dt> 1358 <dt>
1370 <var>packetLength</var> 1359 <var>bytesWritten</var>
1371 <em> 1360 <em>
1372 <!-- TYPE --> 1361 <!-- TYPE -->
1373 <div style="display:inline"> 1362 <div style="display:inline">
1374 (
1375 <span id="typeTemplate">
1376 <span>
1377 <span>integer</span>
1378 </span>
1379 </span>
1380 )
1381 </div>
1382 </em>
1383 </dt>
1384 <dd>The length of each of the packets in this transfer.</dd>
1385 <!-- OBJECT PROPERTIES -->
1386 <!-- OBJECT METHODS -->
1387 <!-- OBJECT EVENT FIELDS -->
1388 <!-- FUNCTION PARAMETERS -->
1389 </div>
1390 </div><div>
1391 <div>
1392 <dt>
1393 <var>packets</var>
1394 <em>
1395 <!-- TYPE -->
1396 <div style="display:inline">
1397 ( 1363 (
1398 <span id="typeTemplate"> 1364 <span id="typeTemplate">
1399 <span> 1365 <span>
1400 <span>integer</span> 1366 <span>integer</span>
1401 </span> 1367 </span>
1402 </span> 1368 </span>
1403 ) 1369 )
1404 </div> 1370 </div>
1405 </em> 1371 </em>
1406 </dt> 1372 </dt>
1407 <dd>The total number of packets in this transfer.</dd> 1373 <dd>The number of bytes written.</dd>
1408 <!-- OBJECT PROPERTIES --> 1374 <!-- OBJECT PROPERTIES -->
1409 <!-- OBJECT METHODS --> 1375 <!-- OBJECT METHODS -->
1410 <!-- OBJECT EVENT FIELDS --> 1376 <!-- OBJECT EVENT FIELDS -->
1411 <!-- FUNCTION PARAMETERS -->
1412 </div>
1413 </div><div>
1414 <div>
1415 <dt>
1416 <var>transferInfo</var>
1417 <em>
1418 <!-- TYPE -->
1419 <div style="display:inline">
1420 (
1421 <span id="typeTemplate">
1422 <span>
1423 <a href="experimental.usb.html#type-experimental.usb.Gen ericTransferInfo">experimental.usb.GenericTransferInfo</a>
1424 </span>
1425 </span>
1426 )
1427 </div>
1428 </em>
1429 </dt>
1430 <dd>All of the normal transfer parameters are encapsulated in the tran sferInfo parameters. Note that the data specified in this parameter block is spl it along packetLength boundaries to form the individual packets of the transfer. </dd>
1431 <!-- OBJECT PROPERTIES -->
1432 <!-- OBJECT METHODS -->
1433 <!-- OBJECT EVENT FIELDS -->
1434 <!-- FUNCTION PARAMETERS --> 1377 <!-- FUNCTION PARAMETERS -->
1435 </div> 1378 </div>
1436 </div> 1379 </div>
1437 </dl> 1380 </dl>
1438 </dd> 1381 </dd>
1439 <!-- OBJECT METHODS --> 1382 <!-- OBJECT METHODS -->
1440 <!-- OBJECT EVENT FIELDS --> 1383 <!-- OBJECT EVENT FIELDS -->
1441 <!-- FUNCTION PARAMETERS --> 1384 <!-- FUNCTION PARAMETERS -->
1442 </div> 1385 </div>
1443 </div><div class="apiItem"> 1386 </div><div class="apiItem">
1444 <a name="type-experimental.usb.UsbEvent"></a> 1387 <a name="type-serial.ControlSignalOptions"></a>
1445 <h4>experimental.usb.UsbEvent</h4> 1388 <h4>serial.ControlSignalOptions</h4>
1446 <div> 1389 <div>
1447 <dt> 1390 <dt>
1448 <em> 1391 <em>
1449 <!-- TYPE --> 1392 <!-- TYPE -->
1450 <div style="display:inline"> 1393 <div style="display:inline">
1451 ( 1394 (
1452 <span id="typeTemplate"> 1395 <span id="typeTemplate">
1453 <span> 1396 <span>
1454 <span>object</span> 1397 <span>object</span>
1455 </span> 1398 </span>
1456 </span> 1399 </span>
1457 ) 1400 )
1458 </div> 1401 </div>
1459 </em> 1402 </em>
1460 </dt> 1403 </dt>
1461 <dd class="todo"> 1404 <dd class="todo">
1462 Undocumented. 1405 Undocumented.
1463 </dd> 1406 </dd>
1464 <!-- OBJECT PROPERTIES --> 1407 <!-- OBJECT PROPERTIES -->
1465 <dd> 1408 <dd>
1466 <dl> 1409 <dl>
1467 <div> 1410 <div>
1468 <div> 1411 <div>
1469 <dt> 1412 <dt>
1470 <var>data</var> 1413 <var>cts</var>
1471 <em> 1414 <em>
1472 <!-- TYPE --> 1415 <!-- TYPE -->
1473 <div style="display:inline"> 1416 <div style="display:inline">
1474 ( 1417 (
1475 <span class="optional">optional</span> 1418 <span class="optional">optional</span>
1476 <span id="typeTemplate"> 1419 <span id="typeTemplate">
1477 <span> 1420 <span>
1478 <span>ArrayBuffer</span> 1421 <span>boolean</span>
1479 </span> 1422 </span>
1480 </span> 1423 </span>
1481 ) 1424 )
1482 </div> 1425 </div>
1483 </em> 1426 </em>
1484 </dt> 1427 </dt>
1485 <dd>If the transfer was an input transfer then this field will contain all of the input data requested.</dd> 1428 <dd class="todo">
1429 Undocumented.
1430 </dd>
1486 <!-- OBJECT PROPERTIES --> 1431 <!-- OBJECT PROPERTIES -->
1487 <!-- OBJECT METHODS --> 1432 <!-- OBJECT METHODS -->
1488 <!-- OBJECT EVENT FIELDS --> 1433 <!-- OBJECT EVENT FIELDS -->
1489 <!-- FUNCTION PARAMETERS --> 1434 <!-- FUNCTION PARAMETERS -->
1490 </div> 1435 </div>
1491 </div><div> 1436 </div><div>
1492 <div> 1437 <div>
1493 <dt> 1438 <dt>
1494 <var>error</var> 1439 <var>dcd</var>
1495 <em> 1440 <em>
1496 <!-- TYPE --> 1441 <!-- TYPE -->
1497 <div style="display:inline"> 1442 <div style="display:inline">
1498 ( 1443 (
1499 <span class="optional">optional</span> 1444 <span class="optional">optional</span>
1500 <span id="typeTemplate"> 1445 <span id="typeTemplate">
1501 <span> 1446 <span>
1502 <span>string</span> 1447 <span>boolean</span>
1503 </span> 1448 </span>
1504 </span> 1449 </span>
1505 ) 1450 )
1506 </div> 1451 </div>
1507 </em> 1452 </em>
1508 </dt> 1453 </dt>
1509 <dd>If resultCode is not 0, this field will contain a textual descript ion of the error that occurred during the transfer.</dd> 1454 <dd>Serial control signals that your machine can receive. If a get ope ration fails, success will be false, and these fields will be absent. DCD (Data Carrier Detect) is equivalent to RLSD (Receive Line Signal Detect) on some platf orms.</dd>
1510 <!-- OBJECT PROPERTIES --> 1455 <!-- OBJECT PROPERTIES -->
1511 <!-- OBJECT METHODS --> 1456 <!-- OBJECT METHODS -->
1512 <!-- OBJECT EVENT FIELDS --> 1457 <!-- OBJECT EVENT FIELDS -->
1513 <!-- FUNCTION PARAMETERS --> 1458 <!-- FUNCTION PARAMETERS -->
1514 </div> 1459 </div>
1515 </div><div> 1460 </div><div>
1516 <div> 1461 <div>
1517 <dt> 1462 <dt>
1518 <var>resultCode</var> 1463 <var>dtr</var>
1519 <em> 1464 <em>
1520 <!-- TYPE --> 1465 <!-- TYPE -->
1521 <div style="display:inline"> 1466 <div style="display:inline">
1522 ( 1467 (
1523 <span class="optional">optional</span> 1468 <span class="optional">optional</span>
1524 <span id="typeTemplate"> 1469 <span id="typeTemplate">
1525 <span> 1470 <span>
1526 <span>integer</span> 1471 <span>boolean</span>
1527 </span> 1472 </span>
1528 </span> 1473 </span>
1529 ) 1474 )
1530 </div> 1475 </div>
1531 </em> 1476 </em>
1532 </dt> 1477 </dt>
1533 <dd>A value of 0 indicates that the transfer was a success. Other valu es indicate failure.</dd> 1478 <dd>Serial control signals that your machine can send. Missing fields will be set to false.</dd>
1534 <!-- OBJECT PROPERTIES --> 1479 <!-- OBJECT PROPERTIES -->
1535 <!-- OBJECT METHODS --> 1480 <!-- OBJECT METHODS -->
1536 <!-- OBJECT EVENT FIELDS --> 1481 <!-- OBJECT EVENT FIELDS -->
1537 <!-- FUNCTION PARAMETERS --> 1482 <!-- FUNCTION PARAMETERS -->
1538 </div> 1483 </div>
1539 </div><div> 1484 </div><div>
1540 <div> 1485 <div>
1541 <dt> 1486 <dt>
1542 <var>type</var> 1487 <var>rts</var>
1543 <em> 1488 <em>
1544 <!-- TYPE --> 1489 <!-- TYPE -->
1545 <div style="display:inline"> 1490 <div style="display:inline">
1546 (
1547 <span id="typeTemplate">
1548 <span>
1549 <span>string</span>
1550 </span>
1551 </span>
1552 )
1553 </div>
1554 </em>
1555 </dt>
1556 <dd>A string indicating the type of the event. Currently will only con tain the value 'transferResult'.</dd>
1557 <!-- OBJECT PROPERTIES -->
1558 <!-- OBJECT METHODS -->
1559 <!-- OBJECT EVENT FIELDS -->
1560 <!-- FUNCTION PARAMETERS -->
1561 </div>
1562 </div>
1563 </dl>
1564 </dd>
1565 <!-- OBJECT METHODS -->
1566 <!-- OBJECT EVENT FIELDS -->
1567 <!-- FUNCTION PARAMETERS -->
1568 </div>
1569 </div><div class="apiItem">
1570 <a name="type-experimental.usb.DeviceOptions"></a>
1571 <h4>experimental.usb.DeviceOptions</h4>
1572 <div>
1573 <dt>
1574 <em>
1575 <!-- TYPE -->
1576 <div style="display:inline">
1577 (
1578 <span id="typeTemplate">
1579 <span>
1580 <span>object</span>
1581 </span>
1582 </span>
1583 )
1584 </div>
1585 </em>
1586 </dt>
1587 <dd class="todo">
1588 Undocumented.
1589 </dd>
1590 <!-- OBJECT PROPERTIES -->
1591 <dd>
1592 <dl>
1593 <div>
1594 <div>
1595 <dt>
1596 <var>onEvent</var>
1597 <em>
1598 <!-- TYPE -->
1599 <div style="display:inline">
1600 ( 1491 (
1601 <span class="optional">optional</span> 1492 <span class="optional">optional</span>
1602 <span id="typeTemplate"> 1493 <span id="typeTemplate">
1603 <span> 1494 <span>
1604 <span>function</span> 1495 <span>boolean</span>
1605 </span> 1496 </span>
1606 </span> 1497 </span>
1607 ) 1498 )
1608 </div>
1609 </em>
1610 </dt>
1611 <dd>Invoked by the extension API whenever an event occurs for the devi ce(s) that this DeviceOptions is associated with.</dd>
1612 <!-- OBJECT PROPERTIES -->
1613 <!-- OBJECT METHODS -->
1614 <!-- OBJECT EVENT FIELDS -->
1615 <!-- FUNCTION PARAMETERS -->
1616 <dd>
1617 <div>
1618 <h5>Parameters</h5>
1619 <dl>
1620 <div>
1621 <div>
1622 <dt>
1623 <var>event</var>
1624 <em>
1625 <!-- TYPE -->
1626 <div style="display:inline">
1627 (
1628 <span id="typeTemplate">
1629 <span>
1630 <a href="experimental.usb.html#type-experimental.usb.Usb Event">experimental.usb.UsbEvent</a>
1631 </span>
1632 </span>
1633 )
1634 </div> 1499 </div>
1635 </em> 1500 </em>
1636 </dt> 1501 </dt>
1637 <dd class="todo"> 1502 <dd class="todo">
1638 Undocumented. 1503 Undocumented.
1639 </dd> 1504 </dd>
1640 <!-- OBJECT PROPERTIES --> 1505 <!-- OBJECT PROPERTIES -->
1641 <!-- OBJECT METHODS --> 1506 <!-- OBJECT METHODS -->
1642 <!-- OBJECT EVENT FIELDS --> 1507 <!-- OBJECT EVENT FIELDS -->
1643 <!-- FUNCTION PARAMETERS --> 1508 <!-- FUNCTION PARAMETERS -->
1644 </div> 1509 </div>
1645 </div>
1646 </dl>
1647 </div>
1648 </dd>
1649 </div>
1650 </div> 1510 </div>
1651 </dl> 1511 </dl>
1652 </dd> 1512 </dd>
1653 <!-- OBJECT METHODS --> 1513 <!-- OBJECT METHODS -->
1654 <!-- OBJECT EVENT FIELDS --> 1514 <!-- OBJECT EVENT FIELDS -->
1655 <!-- FUNCTION PARAMETERS --> 1515 <!-- FUNCTION PARAMETERS -->
1656 </div> 1516 </div>
1657 </div> <!-- /apiItem --> 1517 </div> <!-- /apiItem -->
1658 </div> <!-- /apiGroup --> 1518 </div> <!-- /apiGroup -->
1659 </div> <!-- /apiPage --> 1519 </div> <!-- /apiPage -->
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after
1696 _uff=0; 1556 _uff=0;
1697 urchinTracker(); 1557 urchinTracker();
1698 } 1558 }
1699 catch(e) {/* urchinTracker not available. */} 1559 catch(e) {/* urchinTracker not available. */}
1700 </script> 1560 </script>
1701 <!-- end analytics --> 1561 <!-- end analytics -->
1702 </div> 1562 </div>
1703 </div> <!-- /gc-footer --> 1563 </div> <!-- /gc-footer -->
1704 </div> <!-- /gc-container --> 1564 </div> <!-- /gc-container -->
1705 </body></html> 1565 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/apps/events.html ('k') | chrome/common/extensions/docs/extensions/events.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698