chrome/common/extensions/docs/apps/experimental.serial.html

   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
   3        across api docs and should be edited only with knowledge of the
   4        templating mechanism.
   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
   7        authored overview content.
   8     4) The <body>.innerHTML is also generated by an offline step so that this
   9        page may easily be indexed by search engines.
  10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
  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">
  13     <script type="text/javascript" src="../../../../third_party/jstemplate/jstemplate_compiled.js">
  14     </script>
  15     <script type="text/javascript" src="../../../../../third_party/json_minify/minify-sans-regexp.js">
  16     </script>
  17     <script type="text/javascript" src="../js/api_page_generator.js"></script>
  18     <script type="text/javascript" src="../js/bootstrap.js"></script>
  19     <script type="text/javascript" src="../js/sidebar.js"></script>
  20   <meta name="description" content="Documentation for the chrome.experimental.serial module, which is part of the Google Chrome  extension APIs."><title>chrome.experimental.serial - Google Chrome Extensions - Google Code</title></head>
  21   <body doc-family="apps">  <link href="../css/ApiRefStyles_apps.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">
  24   <div id="devModeWarning" class="displayModeWarning">
  25     You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
  26   </div>
  27   <div id="branchWarning" class="displayModeWarning">
  28     <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
  29     It may not work with the stable release of Chrome.</span>
  30     <select id="branchChooser">
  31       <option>Choose a different version...
  32       </option><option value="">Stable
  33       </option><option value="beta">Beta
  34       </option><option value="dev">Dev
  35       </option><option value="trunk">Trunk
  36     </option></select>
  37   </div>
  38   <div id="unofficialWarning" class="displayModeWarning">
  39     <span>WARNING: This is unofficial documentation. It may not work with the
  40     current release of Chrome.</span>
  41     <button id="goToOfficialDocs">Go to the official docs</button>
  42   </div>
  43   <div id="gc-container" class="labs">
  44       <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
  45       <!-- In particular, sub-templates that recurse, must be used by allowing
  46            jstemplate to make a copy of the template in this section which
  47            are not operated on by way of the jsskip="true" -->
  48        <!-- /SUBTEMPLATES -->
  49   <a id="top"></a>
  50     <div id="skipto">
  51       <a href="#gc-pagecontent">Skip to page content</a>
  52       <a href="#gc-toc">Skip to main navigation</a>
  53     </div>
  54     <!-- API HEADER -->
  55     <table id="header" width="100%" cellspacing="0" border="0">
  56       <tbody><tr>
  57         <td valign="middle"><a href="http://code.google.com/"><img src="../images/chrome_logo.gif" alt="Google Code" style="border:0; margin:0;"></a></td>
  58         <td valign="middle" width="100%" style="padding-left:0.6em;">
  59           <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">
  60             <div id="gsc-search-box">
  61               <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">
  62               <input type="hidden" name="ie" value="UTF-8">
  63               <input id="gsc-search-input" type="text" name="q" value="" size="55">
  64               <button class="gsc-search-button" type="submit" name="sa">
  65                 <img class="gsc-search-button-lens" src="../images/search.png" alt="Search">
  66               </button>
  67               <br>
  68               <span class="greytext">e.g. "event page" or "alarms"</span>
  69             </div>
  70           </form>
  71           <script type="text/javascript" src="https://www.google.com/jsapi"></script>
  72           <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
  73           <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&amp;t13n_langs=en"></script>
  74           <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&amp;lang=en"></script>
  75         </td>
  76       </tr>
  77     </tbody></table>
  78     <div id="codesiteContent" class="">
  79       <a id="gc-topnav-anchor"></a>
  80       <div id="gc-topnav">
  81         <h1>Packaged Apps</h1>
  82         <ul id="home" class="gc-topnav-tabs">
  83           <li id="home_link">
  84             <a href="about_apps.html" title="Packaged Apps home page"><span>Home</span></a>
  85           </li>
  86           <li id="docs_link">
  87             <a href="develop_apps.html" title="Packaged apps developer documentation"><span>Docs</span></a>
  88           </li>
  89           <li id="samples_link">
  90             <a href="https://github.com/GoogleChrome/chrome-app-samples" title="Packaged apps samples repository"><span>Samples</span></a>
  91           </li>
  92           <li id="group_link">
  93             <a href="http://groups.google.com/a/chromium.org/group/chromium-apps" title="Google Chrome Apps developer forum"><span>Group</span></a>
  94           </li>
  95           <li id="so_link">
  96             <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow"><span>Questions?</span></a>
  97           </li>
  98         </ul>
  99       </div> <!-- end gc-topnav -->
 100     <div class="g-section g-tpl-170">
 101       <!-- SIDENAV -->
 102       <div class="g-unit g-first" id="gc-toc">
 103         <ul>
 104           <li><h2>Getting Started</h2>
 105             <ul>
 106               <li><a href="about_apps.html">What Are Packaged Apps?</a></li>
 107               <li><a href="app_architecture.html">Understand the Architecture</a></li>
 108               <li><a href="first_app.html">Create Your First App</a></li>
 109             </ul>
 110           </li>
 111           <li><h2>Developing</h2>
 112             <ul>
 113               <li><a href="develop_apps.html">Before You Start</a></li>
 114               <li><span>The Fundamentals</span>
 115                 <ul>
 116                   <li><a href="app_lifecycle.html">Manage App Lifecycle</a></li>
 117                   <li><a href="app_storage.html">Manage Data</a></li>
 118                   <li><a href="offline_apps.html">Offline First</a></li>
 119                   <li><a href="app_external.html">Embed Content</a></li>
 120                 </ul>
 121               </li>
 122               <li><span>Security &amp; Privacy</span>
 123                 <ul>
 124                   <li><a href="app_identity.html">Identify User</a></li>
 125                   <li><a href="app_csp.html">Comply with CSP</a></li>
 126                 </ul>
 127               </li>
 128               <li><span>Advanced Technologies</span>
 129                 <ul>
 130                   <li><a href="app_network.html">Network Communications</a></li>
 131                   <li><a href="app_hardware.html">Access Hardware Devices</a></li>
 132                   <li><a href="app_intents.html">Connect Apps with Web Intents</a></li>
 133                 </ul>
 134               </li>
 135               <li><a href="app_frameworks.html">MVC Architecture</a></li>
 136             </ul>
 137           </li>
 138           <li><h2>Deploying</h2>
 139             <ul>
 140               <li><a href="publish_app.html">Publish</a></li>
 141             </ul>
 142           </li>
 143           <li><h2>Reference</h2>
 144             <ul>
 145               <li><a href="manifest.html">Manifest Files</a></li>
 146               <li><a href="api_index.html">Chrome JavaScript APIs</a></li>
 147               <li><a href="api_other.html">Supported Libraries</a></li>
 148               <li><a href="app_deprecated.html">Disabled Web Features</a></li>
 149             </ul>
 150           </li>
 151           <li><h2><a href="https://github.com/GoogleChrome/chrome-app-samples">Samples</a></h2></li>
 152           <li><h2><a href="app_known_issues.html">Known Issues</a></h2></li>
 153         </ul>
 154       </div>
 155       <script>
 156         initToggles();
 157       </script>
 158     <div class="g-unit" id="gc-pagecontent">
 159       <div id="pageTitle">
 160         <h1 class="page_title">chrome.experimental.serial</h1>
 161       </div>
 162         <!-- TABLE OF CONTENTS -->
 163         <div id="toc">
 164           <h2>Contents</h2>
 165           <ol>
 166               <li>
 167                 <a href="#apiReference">API reference: chrome.experimental.serial</a>
 168                 <ol>
 169                   <li>
 170             <a href="#global-methods">Methods</a>
 171             <ol>
 172               <li>
 173                 <a href="#method-close">close</a>
 174               </li><li>
 175                 <a href="#method-flush">flush</a>
 176               </li><li>
 177                 <a href="#method-getControlSignals">getControlSignals</a>
 178               </li><li>
 179                 <a href="#method-getPorts">getPorts</a>
 180               </li><li>
 181                 <a href="#method-open">open</a>
 182               </li><li>
 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>
 188               </li>
 189             </ol>
 190           </li>
 191                   <li>
 192             <a href="#types">Types</a>
 193             <ol>
 194               <li>
 195                 <a href="#type-experimental.serial.OpenOptions">experimental.serial.OpenOptions</a>
 196                 <ol>
 197                 </ol>
 198               </li><li>
 199                 <a href="#type-experimental.serial.OpenInfo">experimental.serial.OpenInfo</a>
 200                 <ol>
 201                 </ol>
 202               </li><li>
 203                 <a href="#type-experimental.serial.ReadInfo">experimental.serial.ReadInfo</a>
 204                 <ol>
 205                 </ol>
 206               </li><li>
 207                 <a href="#type-experimental.serial.WriteInfo">experimental.serial.WriteInfo</a>
 208                 <ol>
 209                 </ol>
 210               </li><li>
 211                 <a href="#type-experimental.serial.ControlSignalOptions">experimental.serial.ControlSignalOptions</a>
 212                 <ol>
 213                 </ol>
 214               </li>
 215             </ol>
 216           </li>
 217                 </ol>
 218               </li>
 219           </ol>
 220         </div>
 221         <!-- /TABLE OF CONTENTS -->
 222         <!-- Standard content lead-in for experimental API pages -->
 223         <p id="classSummary">
 224           For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.
 225         </p>
 226         <!-- STATIC CONTENT PLACEHOLDER -->
 227         <div id="static"></div>
 228         <!-- API PAGE -->
 229         <div class="apiPage">
 230         <a name="apiReference"></a>
 231         <h2>API reference: chrome.experimental.serial</h2>
 232           <!-- PROPERTIES -->
 233            <!-- /apiGroup -->
 234           <!-- METHODS -->
 235           <div id="methodsTemplate" class="apiGroup">
 236             <a name="global-methods"></a>
 237             <h3>Methods</h3>
 238             <!-- iterates over all functions -->
 239             <div class="apiItem">
 240               <a name="method-close"></a> <!-- method-anchor -->
 241               <h4>close</h4>
 242               <div class="summary">
 243                   <!-- Note: intentionally longer 80 columns -->
 244                   <span>chrome.experimental.serial.close</span>(<span class="null"><span>integer</span>
 245                       <var><span>connectionId</span></var></span><span class="null"><span>, </span><span>function</span>
 246                       <var><span>CloseCallback</span></var></span>)</div>
 247               <div class="description">
 248                 <p>Closes an open connection.</p>
 249                 <!-- PARAMETERS -->
 250                 <h4>Parameters</h4>
 251                 <dl>
 252                   <div>
 253                     <div>
 254           <dt>
 255             <var>connectionId</var>
 256               <em>
 257                 <!-- TYPE -->
 258                 <div style="display:inline">
 259                   (
 260                     <span id="typeTemplate">
 261                       <span>
 262                         <span>integer</span>
 263                       </span>
 264                     </span>
 265                   )
 266                 </div>
 267               </em>
 268           </dt>
 269           <dd>The id of the opened connection.</dd>
 270           <!-- OBJECT PROPERTIES -->
 271           <!-- OBJECT METHODS -->
 272           <!-- OBJECT EVENT FIELDS -->
 273           <!-- FUNCTION PARAMETERS -->
 274         </div>
 275                   </div><div>
 276                     <div>
 277           <dt>
 278             <var>CloseCallback</var>
 279               <em>
 280                 <!-- TYPE -->
 281                 <div style="display:inline">
 282                   (
 283                     <span id="typeTemplate">
 284                       <span>
 285                         <span>function</span>
 286                       </span>
 287                     </span>
 288                   )
 289                 </div>
 290               </em>
 291           </dt>
 292           <dd>Returns true if operation was successful.</dd>
 293           <!-- OBJECT PROPERTIES -->
 294           <!-- OBJECT METHODS -->
 295           <!-- OBJECT EVENT FIELDS -->
 296           <!-- FUNCTION PARAMETERS -->
 297           <dd>
 298             <div>
 299           <h5>Parameters</h5>
 300           <dl>
 301             <div>
 302               <div>
 303           <dt>
 304             <var>result</var>
 305               <em>
 306                 <!-- TYPE -->
 307                 <div style="display:inline">
 308                   (
 309                     <span id="typeTemplate">
 310                       <span>
 311                         <span>boolean</span>
 312                       </span>
 313                     </span>
 314                   )
 315                 </div>
 316               </em>
 317           </dt>
 318           <dd class="todo">
 319             Undocumented.
 320           </dd>
 321           <!-- OBJECT PROPERTIES -->
 322           <!-- OBJECT METHODS -->
 323           <!-- OBJECT EVENT FIELDS -->
 324           <!-- FUNCTION PARAMETERS -->
 325         </div>
 326             </div>
 327           </dl>
 328         </div>
 329           </dd>
 330         </div>
 331                   </div>
 332                 </dl>
 333                 <!-- RETURNS -->
 334                 <dl>
 335                 </dl>
 336                 <!-- CALLBACK -->
 337                 <!-- MIN_VERSION -->
 338               </div> <!-- /description -->
 339             </div><div class="apiItem">
 340               <a name="method-flush"></a> <!-- method-anchor -->
 341               <h4>flush</h4>
 342               <div class="summary">
 343                   <!-- Note: intentionally longer 80 columns -->
 344                   <span>chrome.experimental.serial.flush</span>(<span class="null"><span>integer</span>
 345                       <var><span>connectionId</span></var></span><span class="null"><span>, </span><span>function</span>
 346                       <var><span>FlushCallback</span></var></span>)</div>
 347               <div class="description">
 348                 <p>Flushes all bytes in the given connection's input and output buffers.</p>
 349                 <!-- PARAMETERS -->
 350                 <h4>Parameters</h4>
 351                 <dl>
 352                   <div>
 353                     <div>
 354           <dt>
 355             <var>connectionId</var>
 356               <em>
 357                 <!-- TYPE -->
 358                 <div style="display:inline">
 359                   (
 360                     <span id="typeTemplate">
 361                       <span>
 362                         <span>integer</span>
 363                       </span>
 364                     </span>
 365                   )
 366                 </div>
 367               </em>
 368           </dt>
 369           <dd>The id of the connection.</dd>
 370           <!-- OBJECT PROPERTIES -->
 371           <!-- OBJECT METHODS -->
 372           <!-- OBJECT EVENT FIELDS -->
 373           <!-- FUNCTION PARAMETERS -->
 374         </div>
 375                   </div><div>
 376                     <div>
 377           <dt>
 378             <var>FlushCallback</var>
 379               <em>
 380                 <!-- TYPE -->
 381                 <div style="display:inline">
 382                   (
 383                     <span id="typeTemplate">
 384                       <span>
 385                         <span>function</span>
 386                       </span>
 387                     </span>
 388                   )
 389                 </div>
 390               </em>
 391           </dt>
 392           <dd>Returns true if operation was successful.</dd>
 393           <!-- OBJECT PROPERTIES -->
 394           <!-- OBJECT METHODS -->
 395           <!-- OBJECT EVENT FIELDS -->
 396           <!-- FUNCTION PARAMETERS -->
 397           <dd>
 398             <div>
 399           <h5>Parameters</h5>
 400           <dl>
 401             <div>
 402               <div>
 403           <dt>
 404             <var>result</var>
 405               <em>
 406                 <!-- TYPE -->
 407                 <div style="display:inline">
 408                   (
 409                     <span id="typeTemplate">
 410                       <span>
 411                         <span>boolean</span>
 412                       </span>
 413                     </span>
 414                   )
 415                 </div>
 416               </em>
 417           </dt>
 418           <dd class="todo">
 419             Undocumented.
 420           </dd>
 421           <!-- OBJECT PROPERTIES -->
 422           <!-- OBJECT METHODS -->
 423           <!-- OBJECT EVENT FIELDS -->
 424           <!-- FUNCTION PARAMETERS -->
 425         </div>
 426             </div>
 427           </dl>
 428         </div>
 429           </dd>
 430         </div>
 431                   </div>
 432                 </dl>
 433                 <!-- RETURNS -->
 434                 <dl>
 435                 </dl>
 436                 <!-- CALLBACK -->
 437                 <!-- MIN_VERSION -->
 438               </div> <!-- /description -->
 439             </div><div class="apiItem">
 440               <a name="method-getControlSignals"></a> <!-- method-anchor -->
 441               <h4>getControlSignals</h4>
 442               <div class="summary">
 443                   <!-- Note: intentionally longer 80 columns -->
 444                   <span>chrome.experimental.serial.getControlSignals</span>(<span class="null"><span>integer</span>
 445                       <var><span>connectionId</span></var></span><span class="null"><span>, </span><span>function</span>
 446                       <var><span>GetControlSignalsCallback</span></var></span>)</div>
 447               <div class="description">
 448                 <!-- PARAMETERS -->
 449                 <h4>Parameters</h4>
 450                 <dl>
 451                   <div>
 452                     <div>
 453           <dt>
 454             <var>connectionId</var>
 455               <em>
 456                 <!-- TYPE -->
 457                 <div style="display:inline">
 458                   (
 459                     <span id="typeTemplate">
 460                       <span>
 461                         <span>integer</span>
 462                       </span>
 463                     </span>
 464                   )
 465                 </div>
 466               </em>
 467           </dt>
 468           <dd class="todo">
 469             Undocumented.
 470           </dd>
 471           <!-- OBJECT PROPERTIES -->
 472           <!-- OBJECT METHODS -->
 473           <!-- OBJECT EVENT FIELDS -->
 474           <!-- FUNCTION PARAMETERS -->
 475         </div>
 476                   </div><div>
 477                     <div>
 478           <dt>
 479             <var>GetControlSignalsCallback</var>
 480               <em>
 481                 <!-- TYPE -->
 482                 <div style="display:inline">
 483                   (
 484                     <span id="typeTemplate">
 485                       <span>
 486                         <span>function</span>
 487                       </span>
 488                     </span>
 489                   )
 490                 </div>
 491               </em>
 492           </dt>
 493           <dd>Returns a snapshot of current control signals.</dd>
 494           <!-- OBJECT PROPERTIES -->
 495           <!-- OBJECT METHODS -->
 496           <!-- OBJECT EVENT FIELDS -->
 497           <!-- FUNCTION PARAMETERS -->
 498           <dd>
 499             <div>
 500           <h5>Parameters</h5>
 501           <dl>
 502             <div>
 503               <div>
 504           <dt>
 505             <var>options</var>
 506               <em>
 507                 <!-- TYPE -->
 508                 <div style="display:inline">
 509                   (
 510                     <span id="typeTemplate">
 511                       <span>
 512                         <a href="experimental.serial.html#type-experimental.serial.ControlSignalOptions">experimental.serial.ControlSignalOptions</a>
 513                       </span>
 514                     </span>
 515                   )
 516                 </div>
 517               </em>
 518           </dt>
 519           <dd class="todo">
 520             Undocumented.
 521           </dd>
 522           <!-- OBJECT PROPERTIES -->
 523           <!-- OBJECT METHODS -->
 524           <!-- OBJECT EVENT FIELDS -->
 525           <!-- FUNCTION PARAMETERS -->
 526         </div>
 527             </div>
 528           </dl>
 529         </div>
 530           </dd>
 531         </div>
 532                   </div>
 533                 </dl>
 534                 <!-- RETURNS -->
 535                 <dl>
 536                 </dl>
 537                 <!-- CALLBACK -->
 538                 <!-- MIN_VERSION -->
 539               </div> <!-- /description -->
 540             </div><div class="apiItem">
 541               <a name="method-getPorts"></a> <!-- method-anchor -->
 542               <h4>getPorts</h4>
 543               <div class="summary">
 544                   <!-- Note: intentionally longer 80 columns -->
 545                   <span>chrome.experimental.serial.getPorts</span>(<span class="null"><span>function</span>
 546                       <var><span>GetPortsCallback</span></var></span>)</div>
 547               <div class="description">
 548                 <p>Returns names of valid ports on this machine, each of which is likely to be valid to pass as the port argument to open(). The list is regenerated each time this method is called, as port validity is dynamic.</p>
 549                 <!-- PARAMETERS -->
 550                 <h4>Parameters</h4>
 551                 <dl>
 552                   <div>
 553                     <div>
 554           <dt>
 555             <var>GetPortsCallback</var>
 556               <em>
 557                 <!-- TYPE -->
 558                 <div style="display:inline">
 559                   (
 560                     <span id="typeTemplate">
 561                       <span>
 562                         <span>function</span>
 563                       </span>
 564                     </span>
 565                   )
 566                 </div>
 567               </em>
 568           </dt>
 569           <dd class="todo">
 570             Undocumented.
 571           </dd>
 572           <!-- OBJECT PROPERTIES -->
 573           <!-- OBJECT METHODS -->
 574           <!-- OBJECT EVENT FIELDS -->
 575           <!-- FUNCTION PARAMETERS -->
 576           <dd>
 577             <div>
 578           <h5>Parameters</h5>
 579           <dl>
 580             <div>
 581               <div>
 582           <dt>
 583             <var>ports</var>
 584               <em>
 585                 <!-- TYPE -->
 586                 <div style="display:inline">
 587                   (
 588                     <span id="typeTemplate">
 589                       <span>
 590                         <span>
 591                           array of <span><span>
 592                       <span>
 593                         <span>string</span>
 594                       </span>
 595                     </span></span>
 596                         </span>
 597                       </span>
 598                     </span>
 599                   )
 600                 </div>
 601               </em>
 602           </dt>
 603           <dd class="todo">
 604             Undocumented.
 605           </dd>
 606           <!-- OBJECT PROPERTIES -->
 607           <!-- OBJECT METHODS -->
 608           <!-- OBJECT EVENT FIELDS -->
 609           <!-- FUNCTION PARAMETERS -->
 610         </div>
 611             </div>
 612           </dl>
 613         </div>
 614           </dd>
 615         </div>
 616                   </div>
 617                 </dl>
 618                 <!-- RETURNS -->
 619                 <dl>
 620                 </dl>
 621                 <!-- CALLBACK -->
 622                 <!-- MIN_VERSION -->
 623               </div> <!-- /description -->
 624             </div><div class="apiItem">
 625               <a name="method-open"></a> <!-- method-anchor -->
 626               <h4>open</h4>
 627               <div class="summary">
 628                   <!-- Note: intentionally longer 80 columns -->
 629                   <span>chrome.experimental.serial.open</span>(<span class="null"><span>string</span>
 630                       <var><span>port</span></var></span><span class="optional"><span>, </span><span>experimental.serial.OpenOptions</span>
 631                       <var><span>options</span></var></span><span class="null"><span>, </span><span>function</span>
 632                       <var><span>OpenCallback</span></var></span>)</div>
 633               <div class="description">
 634                 <p>Opens a connection to the given serial port.</p>
 635                 <!-- PARAMETERS -->
 636                 <h4>Parameters</h4>
 637                 <dl>
 638                   <div>
 639                     <div>
 640           <dt>
 641             <var>port</var>
 642               <em>
 643                 <!-- TYPE -->
 644                 <div style="display:inline">
 645                   (
 646                     <span id="typeTemplate">
 647                       <span>
 648                         <span>string</span>
 649                       </span>
 650                     </span>
 651                   )
 652                 </div>
 653               </em>
 654           </dt>
 655           <dd>The name of the serial port to open.</dd>
 656           <!-- OBJECT PROPERTIES -->
 657           <!-- OBJECT METHODS -->
 658           <!-- OBJECT EVENT FIELDS -->
 659           <!-- FUNCTION PARAMETERS -->
 660         </div>
 661                   </div><div>
 662                     <div>
 663           <dt>
 664             <var>options</var>
 665               <em>
 666                 <!-- TYPE -->
 667                 <div style="display:inline">
 668                   (
 669                     <span class="optional">optional</span>
 670                     <span id="typeTemplate">
 671                       <span>
 672                         <a href="experimental.serial.html#type-experimental.serial.OpenOptions">experimental.serial.OpenOptions</a>
 673                       </span>
 674                     </span>
 675                   )
 676                 </div>
 677               </em>
 678           </dt>
 679           <dd>Connection options.</dd>
 680           <!-- OBJECT PROPERTIES -->
 681           <!-- OBJECT METHODS -->
 682           <!-- OBJECT EVENT FIELDS -->
 683           <!-- FUNCTION PARAMETERS -->
 684         </div>
 685                   </div><div>
 686                     <div>
 687           <dt>
 688             <var>OpenCallback</var>
 689               <em>
 690                 <!-- TYPE -->
 691                 <div style="display:inline">
 692                   (
 693                     <span id="typeTemplate">
 694                       <span>
 695                         <span>function</span>
 696                       </span>
 697                     </span>
 698                   )
 699                 </div>
 700               </em>
 701           </dt>
 702           <dd class="todo">
 703             Undocumented.
 704           </dd>
 705           <!-- OBJECT PROPERTIES -->
 706           <!-- OBJECT METHODS -->
 707           <!-- OBJECT EVENT FIELDS -->
 708           <!-- FUNCTION PARAMETERS -->
 709           <dd>
 710             <div>
 711           <h5>Parameters</h5>
 712           <dl>
 713             <div>
 714               <div>
 715           <dt>
 716             <var>openInfo</var>
 717               <em>
 718                 <!-- TYPE -->
 719                 <div style="display:inline">
 720                   (
 721                     <span id="typeTemplate">
 722                       <span>
 723                         <a href="experimental.serial.html#type-experimental.serial.OpenInfo">experimental.serial.OpenInfo</a>
 724                       </span>
 725                     </span>
 726                   )
 727                 </div>
 728               </em>
 729           </dt>
 730           <dd class="todo">
 731             Undocumented.
 732           </dd>
 733           <!-- OBJECT PROPERTIES -->
 734           <!-- OBJECT METHODS -->
 735           <!-- OBJECT EVENT FIELDS -->
 736           <!-- FUNCTION PARAMETERS -->
 737         </div>
 738             </div>
 739           </dl>
 740         </div>
 741           </dd>
 742         </div>
 743                   </div>
 744                 </dl>
 745                 <!-- RETURNS -->
 746                 <dl>
 747                 </dl>
 748                 <!-- CALLBACK -->
 749                 <!-- MIN_VERSION -->
 750               </div> <!-- /description -->
 751             </div><div class="apiItem">
 752               <a name="method-read"></a> <!-- method-anchor -->
 753               <h4>read</h4>
 754               <div class="summary">
 755                   <!-- Note: intentionally longer 80 columns -->
 756                   <span>chrome.experimental.serial.read</span>(<span class="null"><span>integer</span>
 757                       <var><span>connectionId</span></var></span><span class="null"><span>, </span><span>function</span>
 758                       <var><span>ReadCallback</span></var></span>)</div>
 759               <div class="description">
 760                 <p>Reads a byte from the given connection.</p>
 761                 <!-- PARAMETERS -->
 762                 <h4>Parameters</h4>
 763                 <dl>
 764                   <div>
 765                     <div>
 766           <dt>
 767             <var>connectionId</var>
 768               <em>
 769                 <!-- TYPE -->
 770                 <div style="display:inline">
 771                   (
 772                     <span id="typeTemplate">
 773                       <span>
 774                         <span>integer</span>
 775                       </span>
 776                     </span>
 777                   )
 778                 </div>
 779               </em>
 780           </dt>
 781           <dd>The id of the connection.</dd>
 782           <!-- OBJECT PROPERTIES -->
 783           <!-- OBJECT METHODS -->
 784           <!-- OBJECT EVENT FIELDS -->
 785           <!-- FUNCTION PARAMETERS -->
 786         </div>
 787                   </div><div>
 788                     <div>
 789           <dt>
 790             <var>ReadCallback</var>
 791               <em>
 792                 <!-- TYPE -->
 793                 <div style="display:inline">
 794                   (
 795                     <span id="typeTemplate">
 796                       <span>
 797                         <span>function</span>
 798                       </span>
 799                     </span>
 800                   )
 801                 </div>
 802               </em>
 803           </dt>
 804           <dd class="todo">
 805             Undocumented.
 806           </dd>
 807           <!-- OBJECT PROPERTIES -->
 808           <!-- OBJECT METHODS -->
 809           <!-- OBJECT EVENT FIELDS -->
 810           <!-- FUNCTION PARAMETERS -->
 811           <dd>
 812             <div>
 813           <h5>Parameters</h5>
 814           <dl>
 815             <div>
 816               <div>
 817           <dt>
 818             <var>readInfo</var>
 819               <em>
 820                 <!-- TYPE -->
 821                 <div style="display:inline">
 822                   (
 823                     <span id="typeTemplate">
 824                       <span>
 825                         <a href="experimental.serial.html#type-experimental.serial.ReadInfo">experimental.serial.ReadInfo</a>
 826                       </span>
 827                     </span>
 828                   )
 829                 </div>
 830               </em>
 831           </dt>
 832           <dd class="todo">
 833             Undocumented.
 834           </dd>
 835           <!-- OBJECT PROPERTIES -->
 836           <!-- OBJECT METHODS -->
 837           <!-- OBJECT EVENT FIELDS -->
 838           <!-- FUNCTION PARAMETERS -->
 839         </div>
 840             </div>
 841           </dl>
 842         </div>
 843           </dd>
 844         </div>
 845                   </div>
 846                 </dl>
 847                 <!-- RETURNS -->
 848                 <dl>
 849                 </dl>
 850                 <!-- CALLBACK -->
 851                 <!-- MIN_VERSION -->
 852               </div> <!-- /description -->
 853             </div><div class="apiItem">
 854               <a name="method-setControlSignals"></a> <!-- method-anchor -->
 855               <h4>setControlSignals</h4>
 856               <div class="summary">
 857                   <!-- Note: intentionally longer 80 columns -->
 858                   <span>chrome.experimental.serial.setControlSignals</span>(<span class="null"><span>integer</span>
 859                       <var><span>connectionId</span></var></span><span class="null"><span>, </span><span>experimental.serial.ControlSignalOptions</span>
 860                       <var><span>options</span></var></span><span class="null"><span>, </span><span>function</span>
 861                       <var><span>SetControlSignalsCallback</span></var></span>)</div>
 862               <div class="description">
 863                 <!-- PARAMETERS -->
 864                 <h4>Parameters</h4>
 865                 <dl>
 866                   <div>
 867                     <div>
 868           <dt>
 869             <var>connectionId</var>
 870               <em>
 871                 <!-- TYPE -->
 872                 <div style="display:inline">
 873                   (
 874                     <span id="typeTemplate">
 875                       <span>
 876                         <span>integer</span>
 877                       </span>
 878                     </span>
 879                   )
 880                 </div>
 881               </em>
 882           </dt>
 883           <dd class="todo">
 884             Undocumented.
 885           </dd>
 886           <!-- OBJECT PROPERTIES -->
 887           <!-- OBJECT METHODS -->
 888           <!-- OBJECT EVENT FIELDS -->
 889           <!-- FUNCTION PARAMETERS -->
 890         </div>
 891                   </div><div>
 892                     <div>
 893           <dt>
 894             <var>options</var>
 895               <em>
 896                 <!-- TYPE -->
 897                 <div style="display:inline">
 898                   (
 899                     <span id="typeTemplate">
 900                       <span>
 901                         <a href="experimental.serial.html#type-experimental.serial.ControlSignalOptions">experimental.serial.ControlSignalOptions</a>
 902                       </span>
 903                     </span>
 904                   )
 905                 </div>
 906               </em>
 907           </dt>
 908           <dd class="todo">
 909             Undocumented.
 910           </dd>
 911           <!-- OBJECT PROPERTIES -->
 912           <!-- OBJECT METHODS -->
 913           <!-- OBJECT EVENT FIELDS -->
 914           <!-- FUNCTION PARAMETERS -->
 915         </div>
 916                   </div><div>
 917                     <div>
 918           <dt>
 919             <var>SetControlSignalsCallback</var>
 920               <em>
 921                 <!-- TYPE -->
 922                 <div style="display:inline">
 923                   (
 924                     <span id="typeTemplate">
 925                       <span>
 926                         <span>function</span>
 927                       </span>
 928                     </span>
 929                   )
 930                 </div>
 931               </em>
 932           </dt>
 933           <dd>Returns true if operation was successful.</dd>
 934           <!-- OBJECT PROPERTIES -->
 935           <!-- OBJECT METHODS -->
 936           <!-- OBJECT EVENT FIELDS -->
 937           <!-- FUNCTION PARAMETERS -->
 938           <dd>
 939             <div>
 940           <h5>Parameters</h5>
 941           <dl>
 942             <div>
 943               <div>
 944           <dt>
 945             <var>result</var>
 946               <em>
 947                 <!-- TYPE -->
 948                 <div style="display:inline">
 949                   (
 950                     <span id="typeTemplate">
 951                       <span>
 952                         <span>boolean</span>
 953                       </span>
 954                     </span>
 955                   )
 956                 </div>
 957               </em>
 958           </dt>
 959           <dd class="todo">
 960             Undocumented.
 961           </dd>
 962           <!-- OBJECT PROPERTIES -->
 963           <!-- OBJECT METHODS -->
 964           <!-- OBJECT EVENT FIELDS -->
 965           <!-- FUNCTION PARAMETERS -->
 966         </div>
 967             </div>
 968           </dl>
 969         </div>
 970           </dd>
 971         </div>
 972                   </div>
 973                 </dl>
 974                 <!-- RETURNS -->
 975                 <dl>
 976                 </dl>
 977                 <!-- CALLBACK -->
 978                 <!-- MIN_VERSION -->
 979               </div> <!-- /description -->
 980             </div><div class="apiItem">
 981               <a name="method-write"></a> <!-- method-anchor -->
 982               <h4>write</h4>
 983               <div class="summary">
 984                   <!-- Note: intentionally longer 80 columns -->
 985                   <span>chrome.experimental.serial.write</span>(<span class="null"><span>integer</span>
 986                       <var><span>connectionId</span></var></span><span class="null"><span>, </span><span>ArrayBuffer</span>
 987                       <var><span>data</span></var></span><span class="null"><span>, </span><span>function</span>
 988                       <var><span>WriteCallback</span></var></span>)</div>
 989               <div class="description">
 990                 <p>Writes a string to the given connection.</p>
 991                 <!-- PARAMETERS -->
 992                 <h4>Parameters</h4>
 993                 <dl>
 994                   <div>
 995                     <div>
 996           <dt>
 997             <var>connectionId</var>
 998               <em>
 999                 <!-- TYPE -->
1000                 <div style="display:inline">
1001                   (
1002                     <span id="typeTemplate">
1003                       <span>
1004                         <span>integer</span>
1005                       </span>
1006                     </span>
1007                   )
1008                 </div>
1009               </em>
1010           </dt>
1011           <dd>The id of the connection.</dd>
1012           <!-- OBJECT PROPERTIES -->
1013           <!-- OBJECT METHODS -->
1014           <!-- OBJECT EVENT FIELDS -->
1015           <!-- FUNCTION PARAMETERS -->
1016         </div>
1017                   </div><div>
1018                     <div>
1019           <dt>
1020             <var>data</var>
1021               <em>
1022                 <!-- TYPE -->
1023                 <div style="display:inline">
1024                   (
1025                     <span id="typeTemplate">
1026                       <span>
1027                         <span>ArrayBuffer</span>
1028                       </span>
1029                     </span>
1030                   )
1031                 </div>
1032               </em>
1033           </dt>
1034           <dd>The string to write.</dd>
1035           <!-- OBJECT PROPERTIES -->
1036           <!-- OBJECT METHODS -->
1037           <!-- OBJECT EVENT FIELDS -->
1038           <!-- FUNCTION PARAMETERS -->
1039         </div>
1040                   </div><div>
1041                     <div>
1042           <dt>
1043             <var>WriteCallback</var>
1044               <em>
1045                 <!-- TYPE -->
1046                 <div style="display:inline">
1047                   (
1048                     <span id="typeTemplate">
1049                       <span>
1050                         <span>function</span>
1051                       </span>
1052                     </span>
1053                   )
1054                 </div>
1055               </em>
1056           </dt>
1057           <dd class="todo">
1058             Undocumented.
1059           </dd>
1060           <!-- OBJECT PROPERTIES -->
1061           <!-- OBJECT METHODS -->
1062           <!-- OBJECT EVENT FIELDS -->
1063           <!-- FUNCTION PARAMETERS -->
1064           <dd>
1065             <div>
1066           <h5>Parameters</h5>
1067           <dl>
1068             <div>
1069               <div>
1070           <dt>
1071             <var>writeInfo</var>
1072               <em>
1073                 <!-- TYPE -->
1074                 <div style="display:inline">
1075                   (
1076                     <span id="typeTemplate">
1077                       <span>
1078                         <a href="experimental.serial.html#type-experimental.serial.WriteInfo">experimental.serial.WriteInfo</a>
1079                       </span>
1080                     </span>
1081                   )
1082                 </div>
1083               </em>
1084           </dt>
1085           <dd class="todo">
1086             Undocumented.
1087           </dd>
1088           <!-- OBJECT PROPERTIES -->
1089           <!-- OBJECT METHODS -->
1090           <!-- OBJECT EVENT FIELDS -->
1091           <!-- FUNCTION PARAMETERS -->
1092         </div>
1093             </div>
1094           </dl>
1095         </div>
1096           </dd>
1097         </div>
1098                   </div>
1099                 </dl>
1100                 <!-- RETURNS -->
1101                 <dl>
1102                 </dl>
1103                 <!-- CALLBACK -->
1104                 <!-- MIN_VERSION -->
1105               </div> <!-- /description -->
1106             </div>  <!-- /apiItem -->
1107           </div>  <!-- /apiGroup -->
1108           <!-- EVENTS -->
1109            <!-- /apiGroup -->
1110           <!-- TYPES -->
1111           <div class="apiGroup">
1112             <a name="types"></a>
1113             <h3 id="types">Types</h3>
1114             <!-- iterates over all types -->
1115             <div class="apiItem">
1116               <a name="type-experimental.serial.OpenOptions"></a>
1117               <h4>experimental.serial.OpenOptions</h4>
1118               <div>
1119           <dt>
1120               <em>
1121                 <!-- TYPE -->
1122                 <div style="display:inline">
1123                   (
1124                     <span id="typeTemplate">
1125                       <span>
1126                         <span>object</span>
1127                       </span>
1128                     </span>
1129                   )
1130                 </div>
1131               </em>
1132           </dt>
1133           <dd class="todo">
1134             Undocumented.
1135           </dd>
1136           <!-- OBJECT PROPERTIES -->
1137           <dd>
1138             <dl>
1139               <div>
1140                 <div>
1141           <dt>
1142             <var>bitrate</var>
1143               <em>
1144                 <!-- TYPE -->
1145                 <div style="display:inline">
1146                   (
1147                     <span id="typeTemplate">
1148                       <span>
1149                         <span>integer</span>
1150                       </span>
1151                     </span>
1152                   )
1153                 </div>
1154               </em>
1155           </dt>
1156           <dd>The requested bitrate of the connection to be opened. For compatibility with the widest range of hardware, this number should match one of commonly-available bitrates, such as 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 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 supports that bitrate.</dd>
1157           <!-- OBJECT PROPERTIES -->
1158           <!-- OBJECT METHODS -->
1159           <!-- OBJECT EVENT FIELDS -->
1160           <!-- FUNCTION PARAMETERS -->
1161         </div>
1162               </div>
1163             </dl>
1164           </dd>
1165           <!-- OBJECT METHODS -->
1166           <!-- OBJECT EVENT FIELDS -->
1167           <!-- FUNCTION PARAMETERS -->
1168         </div>
1169             </div><div class="apiItem">
1170               <a name="type-experimental.serial.OpenInfo"></a>
1171               <h4>experimental.serial.OpenInfo</h4>
1172               <div>
1173           <dt>
1174               <em>
1175                 <!-- TYPE -->
1176                 <div style="display:inline">
1177                   (
1178                     <span id="typeTemplate">
1179                       <span>
1180                         <span>object</span>
1181                       </span>
1182                     </span>
1183                   )
1184                 </div>
1185               </em>
1186           </dt>
1187           <dd class="todo">
1188             Undocumented.
1189           </dd>
1190           <!-- OBJECT PROPERTIES -->
1191           <dd>
1192             <dl>
1193               <div>
1194                 <div>
1195           <dt>
1196             <var>connectionId</var>
1197               <em>
1198                 <!-- TYPE -->
1199                 <div style="display:inline">
1200                   (
1201                     <span id="typeTemplate">
1202                       <span>
1203                         <span>integer</span>
1204                       </span>
1205                     </span>
1206                   )
1207                 </div>
1208               </em>
1209           </dt>
1210           <dd>The id of the opened connection.</dd>
1211           <!-- OBJECT PROPERTIES -->
1212           <!-- OBJECT METHODS -->
1213           <!-- OBJECT EVENT FIELDS -->
1214           <!-- FUNCTION PARAMETERS -->
1215         </div>
1216               </div>
1217             </dl>
1218           </dd>
1219           <!-- OBJECT METHODS -->
1220           <!-- OBJECT EVENT FIELDS -->
1221           <!-- FUNCTION PARAMETERS -->
1222         </div>
1223             </div><div class="apiItem">
1224               <a name="type-experimental.serial.ReadInfo"></a>
1225               <h4>experimental.serial.ReadInfo</h4>
1226               <div>
1227           <dt>
1228               <em>
1229                 <!-- TYPE -->
1230                 <div style="display:inline">
1231                   (
1232                     <span id="typeTemplate">
1233                       <span>
1234                         <span>object</span>
1235                       </span>
1236                     </span>
1237                   )
1238                 </div>
1239               </em>
1240           </dt>
1241           <dd class="todo">
1242             Undocumented.
1243           </dd>
1244           <!-- OBJECT PROPERTIES -->
1245           <dd>
1246             <dl>
1247               <div>
1248                 <div>
1249           <dt>
1250             <var>bytesRead</var>
1251               <em>
1252                 <!-- TYPE -->
1253                 <div style="display:inline">
1254                   (
1255                     <span id="typeTemplate">
1256                       <span>
1257                         <span>integer</span>
1258                       </span>
1259                     </span>
1260                   )
1261                 </div>
1262               </em>
1263           </dt>
1264           <dd>The number of bytes received, or a negative number if an error occurred.</dd>
1265           <!-- OBJECT PROPERTIES -->
1266           <!-- OBJECT METHODS -->
1267           <!-- OBJECT EVENT FIELDS -->
1268           <!-- FUNCTION PARAMETERS -->
1269         </div>
1270               </div><div>
1271                 <div>
1272           <dt>
1273             <var>data</var>
1274               <em>
1275                 <!-- TYPE -->
1276                 <div style="display:inline">
1277                   (
1278                     <span id="typeTemplate">
1279                       <span>
1280                         <span>ArrayBuffer</span>
1281                       </span>
1282                     </span>
1283                   )
1284                 </div>
1285               </em>
1286           </dt>
1287           <dd>The data received.</dd>
1288           <!-- OBJECT PROPERTIES -->
1289           <!-- OBJECT METHODS -->
1290           <!-- OBJECT EVENT FIELDS -->
1291           <!-- FUNCTION PARAMETERS -->
1292         </div>
1293               </div>
1294             </dl>
1295           </dd>
1296           <!-- OBJECT METHODS -->
1297           <!-- OBJECT EVENT FIELDS -->
1298           <!-- FUNCTION PARAMETERS -->
1299         </div>
1300             </div><div class="apiItem">
1301               <a name="type-experimental.serial.WriteInfo"></a>
1302               <h4>experimental.serial.WriteInfo</h4>
1303               <div>
1304           <dt>
1305               <em>
1306                 <!-- TYPE -->
1307                 <div style="display:inline">
1308                   (
1309                     <span id="typeTemplate">
1310                       <span>
1311                         <span>object</span>
1312                       </span>
1313                     </span>
1314                   )
1315                 </div>
1316               </em>
1317           </dt>
1318           <dd class="todo">
1319             Undocumented.
1320           </dd>
1321           <!-- OBJECT PROPERTIES -->
1322           <dd>
1323             <dl>
1324               <div>
1325                 <div>
1326           <dt>
1327             <var>bytesWritten</var>
1328               <em>
1329                 <!-- TYPE -->
1330                 <div style="display:inline">
1331                   (
1332                     <span id="typeTemplate">
1333                       <span>
1334                         <span>integer</span>
1335                       </span>
1336                     </span>
1337                   )
1338                 </div>
1339               </em>
1340           </dt>
1341           <dd>The number of bytes written.</dd>
1342           <!-- OBJECT PROPERTIES -->
1343           <!-- OBJECT METHODS -->
1344           <!-- OBJECT EVENT FIELDS -->
1345           <!-- FUNCTION PARAMETERS -->
1346         </div>
1347               </div>
1348             </dl>
1349           </dd>
1350           <!-- OBJECT METHODS -->
1351           <!-- OBJECT EVENT FIELDS -->
1352           <!-- FUNCTION PARAMETERS -->
1353         </div>
1354             </div><div class="apiItem">
1355               <a name="type-experimental.serial.ControlSignalOptions"></a>
1356               <h4>experimental.serial.ControlSignalOptions</h4>
1357               <div>
1358           <dt>
1359               <em>
1360                 <!-- TYPE -->
1361                 <div style="display:inline">
1362                   (
1363                     <span id="typeTemplate">
1364                       <span>
1365                         <span>object</span>
1366                       </span>
1367                     </span>
1368                   )
1369                 </div>
1370               </em>
1371           </dt>
1372           <dd class="todo">
1373             Undocumented.
1374           </dd>
1375           <!-- OBJECT PROPERTIES -->
1376           <dd>
1377             <dl>
1378               <div>
1379                 <div>
1380           <dt>
1381             <var>cts</var>
1382               <em>
1383                 <!-- TYPE -->
1384                 <div style="display:inline">
1385                   (
1386                     <span class="optional">optional</span>
1387                     <span id="typeTemplate">
1388                       <span>
1389                         <span>boolean</span>
1390                       </span>
1391                     </span>
1392                   )
1393                 </div>
1394               </em>
1395           </dt>
1396           <dd class="todo">
1397             Undocumented.
1398           </dd>
1399           <!-- OBJECT PROPERTIES -->
1400           <!-- OBJECT METHODS -->
1401           <!-- OBJECT EVENT FIELDS -->
1402           <!-- FUNCTION PARAMETERS -->
1403         </div>
1404               </div><div>
1405                 <div>
1406           <dt>
1407             <var>dcd</var>
1408               <em>
1409                 <!-- TYPE -->
1410                 <div style="display:inline">
1411                   (
1412                     <span class="optional">optional</span>
1413                     <span id="typeTemplate">
1414                       <span>
1415                         <span>boolean</span>
1416                       </span>
1417                     </span>
1418                   )
1419                 </div>
1420               </em>
1421           </dt>
1422           <dd>Serial control signals that your machine can receive. If a get operation 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 platforms.</dd>
1423           <!-- OBJECT PROPERTIES -->
1424           <!-- OBJECT METHODS -->
1425           <!-- OBJECT EVENT FIELDS -->
1426           <!-- FUNCTION PARAMETERS -->
1427         </div>
1428               </div><div>
1429                 <div>
1430           <dt>
1431             <var>dtr</var>
1432               <em>
1433                 <!-- TYPE -->
1434                 <div style="display:inline">
1435                   (
1436                     <span class="optional">optional</span>
1437                     <span id="typeTemplate">
1438                       <span>
1439                         <span>boolean</span>
1440                       </span>
1441                     </span>
1442                   )
1443                 </div>
1444               </em>
1445           </dt>
1446           <dd>Serial control signals that your machine can send. Missing fields will be set to false.</dd>
1447           <!-- OBJECT PROPERTIES -->
1448           <!-- OBJECT METHODS -->
1449           <!-- OBJECT EVENT FIELDS -->
1450           <!-- FUNCTION PARAMETERS -->
1451         </div>
1452               </div><div>
1453                 <div>
1454           <dt>
1455             <var>rts</var>
1456               <em>
1457                 <!-- TYPE -->
1458                 <div style="display:inline">
1459                   (
1460                     <span class="optional">optional</span>
1461                     <span id="typeTemplate">
1462                       <span>
1463                         <span>boolean</span>
1464                       </span>
1465                     </span>
1466                   )
1467                 </div>
1468               </em>
1469           </dt>
1470           <dd class="todo">
1471             Undocumented.
1472           </dd>
1473           <!-- OBJECT PROPERTIES -->
1474           <!-- OBJECT METHODS -->
1475           <!-- OBJECT EVENT FIELDS -->
1476           <!-- FUNCTION PARAMETERS -->
1477         </div>
1478               </div>
1479             </dl>
1480           </dd>
1481           <!-- OBJECT METHODS -->
1482           <!-- OBJECT EVENT FIELDS -->
1483           <!-- FUNCTION PARAMETERS -->
1484         </div>
1485             </div> <!-- /apiItem -->
1486           </div> <!-- /apiGroup -->
1487         </div> <!-- /apiPage -->
1488       </div> <!-- /gc-pagecontent -->
1489     </div> <!-- /g-section -->
1490   </div> <!-- /codesiteContent -->
1491     <div id="gc-footer" --="">
1492       <div class="text">
1493   <p>
1494   Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
1495   the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
1496   Attribution 3.0 License</a>, and code samples are licensed under the
1497   <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
1498   </p>
1499   <p>
1500   ©2012 Google
1501   </p>
1502 <!-- begin analytics -->
1503 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>
1504 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>
1505 <script src="../js/prettify.js" type="text/javascript"></script>
1506 <script>
1507   // Auto syntax highlight all pre tags.
1508   var pres = document.querySelectorAll('pre');
1509   for (var i = 0, pre; pre = pres[i]; ++i) {
1510     pre.className += ' prettyprint';
1511   };
1512   prettyPrint();
1513 </script>
1514 <script type="text/javascript">
1515   // chrome doc tracking
1516   try {
1517     var engdocs = _gat._getTracker("YT-10763712-2");
1518     engdocs._trackPageview();
1519   } catch(err) {}
1520   // code.google.com site-wide tracking
1521   try {
1522     _uacct="UA-18071-1";
1523     _uanchor=1;
1524     _uff=0;
1525     urchinTracker();
1526   }
1527   catch(e) {/* urchinTracker not available. */}
1528 </script>
1529 <!-- end analytics -->
1530       </div>
1531     </div> <!-- /gc-footer -->
1532   </div> <!-- /gc-container -->
1533 </body></html>