camera/docs/docs.html

   1 <!DOCTYPE html>
   2 <html>
   3 <!-- Copyright (C) 2012 The Android Open Source Project
   4
   5      Licensed under the Apache License, Version 2.0 (the "License");
   6      you may not use this file except in compliance with the License.
   7      You may obtain a copy of the License at
   8
   9           http://www.apache.org/licenses/LICENSE-2.0
  10
  11      Unless required by applicable law or agreed to in writing, software
  12      distributed under the License is distributed on an "AS IS" BASIS,
  13      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14      See the License for the specific language governing permissions and
  15      limitations under the License.
  16 -->
  17 <head>
  18   <!-- automatically generated from html.mako. do NOT edit directly -->
  19   <meta charset="utf-8" />
  20   <title>Android Camera HAL3.2 Properties</title>
  21   <style type="text/css">
  22      body { background-color: #f7f7f7; font-family: Roboto, sans-serif;}
  23      h1 { color: #333333; }
  24      h2 { color: #333333; }
  25      a:link { color: #258aaf; text-decoration: none}
  26      a:hover { color: #459aaf; text-decoration: underline }
  27      a:visited { color: #154a5f; text-decoration: none}
  28     .section { color: #eeeeee; font-size: 1.5em; font-weight: bold; background-color: #888888; padding: 0.5em 0em 0.5em 0.5em; border-width: thick thin thin thin; border-color: #111111 #777777 #777777 #777777}
  29     .kind { color: #eeeeee; font-size: 1.2em; font-weight: bold; padding-left: 1.5em; background-color: #aaaaaa }
  30     .entry { background-color: #f0f0f0 }
  31     .entry_cont { background-color: #f0f0f0 }
  32     .entries_header { background-color: #dddddd; text-align: center}
  33
  34     /* toc style */
  35     .toc_section_header { font-size:1.3em;  }
  36     .toc_kind_header { font-size:1.2em;  }
  37     .toc_deprecated { text-decoration:line-through; }
  38
  39     /* table column sizes */
  40     table { border-collapse:collapse; table-layout: fixed; width: 100%; word-wrap: break-word }
  41     td,th { border: 1px solid; border-color: #aaaaaa; padding-left: 0.5em; padding-right: 0.5em }
  42     .th_name { width: 20% }
  43     .th_units { width: 10% }
  44     .th_tags { width: 5% }
  45     .th_details { width: 25% }
  46     .th_type { width: 20% }
  47     .th_description { width: 20% }
  48     .th_range { width: 10% }
  49     td { font-size: 0.9em; }
  50
  51     /* hide the first thead, we need it there only to enforce column sizes */
  52     .thead_dummy { visibility: hidden; }
  53
  54     /* Entry flair */
  55     .entry_name { color: #333333; padding-left:1.0em; font-size:1.1em; font-family: monospace; vertical-align:top; }
  56     .entry_name_deprecated { text-decoration:line-through; }
  57
  58     /* Entry type flair */
  59     .entry_type_name { font-size:1.1em; color: #669900; font-weight: bold;}
  60     .entry_type_name_enum:after { color: #669900; font-weight: bold; content:" (enum)" }
  61     .entry_type_visibility { font-weight: bolder; padding-left:1em}
  62     .entry_type_synthetic { font-weight: bolder; color: #996600; }
  63     .entry_type_hwlevel { font-weight: bolder; color: #000066; }
  64     .entry_type_deprecated { font-weight: bolder; color: #4D4D4D; }
  65     .entry_type_enum_name { font-family: monospace; font-weight: bolder; }
  66     .entry_type_enum_notes:before { content:" - " }
  67     .entry_type_enum_notes>p:first-child { display:inline; }
  68     .entry_type_enum_value:before { content:" = " }
  69     .entry_type_enum_value { font-family: monospace; }
  70     .entry ul { margin: 0 0 0 0; list-style-position: inside; padding-left: 0.5em; }
  71     .entry ul li { padding: 0 0 0 0; margin: 0 0 0 0;}
  72     .entry_range_deprecated { font-weight: bolder; }
  73
  74     /* Entry tags flair */
  75     .entry_tags ul { list-style-type: none; }
  76
  77     /* Entry details (full docs) flair */
  78     .entry_details_header { font-weight: bold; background-color: #dddddd;
  79       text-align: center; font-size: 1.1em; margin-left: 0em; margin-right: 0em; }
  80
  81     /* Entry spacer flair */
  82     .entry_spacer { background-color: transparent; border-style: none; height: 0.5em; }
  83
  84     /* TODO: generate abbr element for each tag link? */
  85     /* TODO for each x.y.z try to link it to the entry */
  86
  87   </style>
  88
  89   <style>
  90
  91     {
  92       /* broken...
  93          supposedly there is a bug in chrome that it lays out tables before
  94          it knows its being printed, so the page-break-* styles are ignored
  95          */
  96         tr { page-break-after: always; page-break-inside: avoid; }
  97     }
  98
  99   </style>
 100 </head>
 101
 102
 103
 104 <body>
 105   <h1>Android Camera HAL3.2 Properties</h1>
 106
 107
 108   <h2>Table of Contents</h2>
 109   <ul class="toc">
 110     <li><a href="#tag_index" class="toc_section_header">Tags</a></li>
 111     <li>
 112       <span class="toc_section_header"><a href="#section_colorCorrection">colorCorrection</a></span>
 113       <ul class="toc_section">
 114         <li>
 115           <span class="toc_kind_header">controls</span>
 116           <ul class="toc_section">
 117             <li
 118             ><a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a></li>
 119             <li
 120             ><a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a></li>
 121             <li
 122             ><a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a></li>
 123             <li
 124             ><a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a></li>
 125           </ul>
 126         </li>
 127         <li>
 128           <span class="toc_kind_header">dynamic</span>
 129           <ul class="toc_section">
 130             <li
 131             ><a href="#dynamic_android.colorCorrection.mode">android.colorCorrection.mode</a></li>
 132             <li
 133             ><a href="#dynamic_android.colorCorrection.transform">android.colorCorrection.transform</a></li>
 134             <li
 135             ><a href="#dynamic_android.colorCorrection.gains">android.colorCorrection.gains</a></li>
 136             <li
 137             ><a href="#dynamic_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a></li>
 138           </ul>
 139         </li>
 140         <li>
 141           <span class="toc_kind_header">static</span>
 142           <ul class="toc_section">
 143             <li
 144             ><a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a></li>
 145           </ul>
 146         </li>
 147       </ul> <!-- toc_section -->
 148     </li>
 149     <li>
 150       <span class="toc_section_header"><a href="#section_control">control</a></span>
 151       <ul class="toc_section">
 152         <li>
 153           <span class="toc_kind_header">controls</span>
 154           <ul class="toc_section">
 155             <li
 156             ><a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a></li>
 157             <li
 158             ><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>
 159             <li
 160             ><a href="#controls_android.control.aeLock">android.control.aeLock</a></li>
 161             <li
 162             ><a href="#controls_android.control.aeMode">android.control.aeMode</a></li>
 163             <li
 164             ><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>
 165             <li
 166             ><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>
 167             <li
 168             ><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>
 169             <li
 170             ><a href="#controls_android.control.afMode">android.control.afMode</a></li>
 171             <li
 172             ><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>
 173             <li
 174             ><a href="#controls_android.control.afTrigger">android.control.afTrigger</a></li>
 175             <li
 176             ><a href="#controls_android.control.awbLock">android.control.awbLock</a></li>
 177             <li
 178             ><a href="#controls_android.control.awbMode">android.control.awbMode</a></li>
 179             <li
 180             ><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>
 181             <li
 182             ><a href="#controls_android.control.captureIntent">android.control.captureIntent</a></li>
 183             <li
 184             ><a href="#controls_android.control.effectMode">android.control.effectMode</a></li>
 185             <li
 186             ><a href="#controls_android.control.mode">android.control.mode</a></li>
 187             <li
 188             ><a href="#controls_android.control.sceneMode">android.control.sceneMode</a></li>
 189             <li
 190             ><a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a></li>
 191           </ul>
 192         </li>
 193         <li>
 194           <span class="toc_kind_header">static</span>
 195           <ul class="toc_section">
 196             <li
 197             ><a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a></li>
 198             <li
 199             ><a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a></li>
 200             <li
 201             ><a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a></li>
 202             <li
 203             ><a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a></li>
 204             <li
 205             ><a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a></li>
 206             <li
 207             ><a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a></li>
 208             <li
 209             ><a href="#static_android.control.availableEffects">android.control.availableEffects</a></li>
 210             <li
 211             ><a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a></li>
 212             <li
 213             ><a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a></li>
 214             <li
 215             ><a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a></li>
 216             <li
 217             ><a href="#static_android.control.maxRegions">android.control.maxRegions</a></li>
 218             <li
 219             ><a href="#static_android.control.maxRegionsAe">android.control.maxRegionsAe</a></li>
 220             <li
 221             ><a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a></li>
 222             <li
 223             ><a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a></li>
 224             <li
 225             ><a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a></li>
 226             <li
 227             ><a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a></li>
 228           </ul>
 229         </li>
 230         <li>
 231           <span class="toc_kind_header">dynamic</span>
 232           <ul class="toc_section">
 233             <li
 234                 class="toc_deprecated"
 235             ><a href="#dynamic_android.control.aePrecaptureId">android.control.aePrecaptureId</a></li>
 236             <li
 237             ><a href="#dynamic_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a></li>
 238             <li
 239             ><a href="#dynamic_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>
 240             <li
 241             ><a href="#dynamic_android.control.aeLock">android.control.aeLock</a></li>
 242             <li
 243             ><a href="#dynamic_android.control.aeMode">android.control.aeMode</a></li>
 244             <li
 245             ><a href="#dynamic_android.control.aeRegions">android.control.aeRegions</a></li>
 246             <li
 247             ><a href="#dynamic_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>
 248             <li
 249             ><a href="#dynamic_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>
 250             <li
 251             ><a href="#dynamic_android.control.aeState">android.control.aeState</a></li>
 252             <li
 253             ><a href="#dynamic_android.control.afMode">android.control.afMode</a></li>
 254             <li
 255             ><a href="#dynamic_android.control.afRegions">android.control.afRegions</a></li>
 256             <li
 257             ><a href="#dynamic_android.control.afTrigger">android.control.afTrigger</a></li>
 258             <li
 259             ><a href="#dynamic_android.control.afState">android.control.afState</a></li>
 260             <li
 261                 class="toc_deprecated"
 262             ><a href="#dynamic_android.control.afTriggerId">android.control.afTriggerId</a></li>
 263             <li
 264             ><a href="#dynamic_android.control.awbLock">android.control.awbLock</a></li>
 265             <li
 266             ><a href="#dynamic_android.control.awbMode">android.control.awbMode</a></li>
 267             <li
 268             ><a href="#dynamic_android.control.awbRegions">android.control.awbRegions</a></li>
 269             <li
 270             ><a href="#dynamic_android.control.captureIntent">android.control.captureIntent</a></li>
 271             <li
 272             ><a href="#dynamic_android.control.awbState">android.control.awbState</a></li>
 273             <li
 274             ><a href="#dynamic_android.control.effectMode">android.control.effectMode</a></li>
 275             <li
 276             ><a href="#dynamic_android.control.mode">android.control.mode</a></li>
 277             <li
 278             ><a href="#dynamic_android.control.sceneMode">android.control.sceneMode</a></li>
 279             <li
 280             ><a href="#dynamic_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a></li>
 281           </ul>
 282         </li>
 283       </ul> <!-- toc_section -->
 284     </li>
 285     <li>
 286       <span class="toc_section_header"><a href="#section_demosaic">demosaic</a></span>
 287       <ul class="toc_section">
 288         <li>
 289           <span class="toc_kind_header">controls</span>
 290           <ul class="toc_section">
 291             <li
 292             ><a href="#controls_android.demosaic.mode">android.demosaic.mode</a></li>
 293           </ul>
 294         </li>
 295       </ul> <!-- toc_section -->
 296     </li>
 297     <li>
 298       <span class="toc_section_header"><a href="#section_edge">edge</a></span>
 299       <ul class="toc_section">
 300         <li>
 301           <span class="toc_kind_header">controls</span>
 302           <ul class="toc_section">
 303             <li
 304             ><a href="#controls_android.edge.mode">android.edge.mode</a></li>
 305             <li
 306             ><a href="#controls_android.edge.strength">android.edge.strength</a></li>
 307           </ul>
 308         </li>
 309         <li>
 310           <span class="toc_kind_header">static</span>
 311           <ul class="toc_section">
 312             <li
 313             ><a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a></li>
 314           </ul>
 315         </li>
 316         <li>
 317           <span class="toc_kind_header">dynamic</span>
 318           <ul class="toc_section">
 319             <li
 320             ><a href="#dynamic_android.edge.mode">android.edge.mode</a></li>
 321           </ul>
 322         </li>
 323       </ul> <!-- toc_section -->
 324     </li>
 325     <li>
 326       <span class="toc_section_header"><a href="#section_flash">flash</a></span>
 327       <ul class="toc_section">
 328         <li>
 329           <span class="toc_kind_header">controls</span>
 330           <ul class="toc_section">
 331             <li
 332             ><a href="#controls_android.flash.firingPower">android.flash.firingPower</a></li>
 333             <li
 334             ><a href="#controls_android.flash.firingTime">android.flash.firingTime</a></li>
 335             <li
 336             ><a href="#controls_android.flash.mode">android.flash.mode</a></li>
 337           </ul>
 338         </li>
 339         <li>
 340           <span class="toc_kind_header">static</span>
 341           <ul class="toc_section">
 342
 343             <li
 344             ><a href="#static_android.flash.info.available">android.flash.info.available</a></li>
 345             <li
 346             ><a href="#static_android.flash.info.chargeDuration">android.flash.info.chargeDuration</a></li>
 347
 348             <li
 349             ><a href="#static_android.flash.colorTemperature">android.flash.colorTemperature</a></li>
 350             <li
 351             ><a href="#static_android.flash.maxEnergy">android.flash.maxEnergy</a></li>
 352           </ul>
 353         </li>
 354         <li>
 355           <span class="toc_kind_header">dynamic</span>
 356           <ul class="toc_section">
 357             <li
 358             ><a href="#dynamic_android.flash.firingPower">android.flash.firingPower</a></li>
 359             <li
 360             ><a href="#dynamic_android.flash.firingTime">android.flash.firingTime</a></li>
 361             <li
 362             ><a href="#dynamic_android.flash.mode">android.flash.mode</a></li>
 363             <li
 364             ><a href="#dynamic_android.flash.state">android.flash.state</a></li>
 365           </ul>
 366         </li>
 367       </ul> <!-- toc_section -->
 368     </li>
 369     <li>
 370       <span class="toc_section_header"><a href="#section_hotPixel">hotPixel</a></span>
 371       <ul class="toc_section">
 372         <li>
 373           <span class="toc_kind_header">controls</span>
 374           <ul class="toc_section">
 375             <li
 376             ><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a></li>
 377           </ul>
 378         </li>
 379         <li>
 380           <span class="toc_kind_header">static</span>
 381           <ul class="toc_section">
 382             <li
 383             ><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a></li>
 384           </ul>
 385         </li>
 386         <li>
 387           <span class="toc_kind_header">dynamic</span>
 388           <ul class="toc_section">
 389             <li
 390             ><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a></li>
 391           </ul>
 392         </li>
 393       </ul> <!-- toc_section -->
 394     </li>
 395     <li>
 396       <span class="toc_section_header"><a href="#section_jpeg">jpeg</a></span>
 397       <ul class="toc_section">
 398         <li>
 399           <span class="toc_kind_header">controls</span>
 400           <ul class="toc_section">
 401             <li
 402             ><a href="#controls_android.jpeg.gpsLocation">android.jpeg.gpsLocation</a></li>
 403             <li
 404             ><a href="#controls_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a></li>
 405             <li
 406             ><a href="#controls_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a></li>
 407             <li
 408             ><a href="#controls_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a></li>
 409             <li
 410             ><a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a></li>
 411             <li
 412             ><a href="#controls_android.jpeg.quality">android.jpeg.quality</a></li>
 413             <li
 414             ><a href="#controls_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a></li>
 415             <li
 416             ><a href="#controls_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a></li>
 417           </ul>
 418         </li>
 419         <li>
 420           <span class="toc_kind_header">static</span>
 421           <ul class="toc_section">
 422             <li
 423             ><a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a></li>
 424             <li
 425             ><a href="#static_android.jpeg.maxSize">android.jpeg.maxSize</a></li>
 426           </ul>
 427         </li>
 428         <li>
 429           <span class="toc_kind_header">dynamic</span>
 430           <ul class="toc_section">
 431             <li
 432             ><a href="#dynamic_android.jpeg.gpsLocation">android.jpeg.gpsLocation</a></li>
 433             <li
 434             ><a href="#dynamic_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a></li>
 435             <li
 436             ><a href="#dynamic_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a></li>
 437             <li
 438             ><a href="#dynamic_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a></li>
 439             <li
 440             ><a href="#dynamic_android.jpeg.orientation">android.jpeg.orientation</a></li>
 441             <li
 442             ><a href="#dynamic_android.jpeg.quality">android.jpeg.quality</a></li>
 443             <li
 444             ><a href="#dynamic_android.jpeg.size">android.jpeg.size</a></li>
 445             <li
 446             ><a href="#dynamic_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a></li>
 447             <li
 448             ><a href="#dynamic_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a></li>
 449           </ul>
 450         </li>
 451       </ul> <!-- toc_section -->
 452     </li>
 453     <li>
 454       <span class="toc_section_header"><a href="#section_lens">lens</a></span>
 455       <ul class="toc_section">
 456         <li>
 457           <span class="toc_kind_header">controls</span>
 458           <ul class="toc_section">
 459             <li
 460             ><a href="#controls_android.lens.aperture">android.lens.aperture</a></li>
 461             <li
 462             ><a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a></li>
 463             <li
 464             ><a href="#controls_android.lens.focalLength">android.lens.focalLength</a></li>
 465             <li
 466             ><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a></li>
 467             <li
 468             ><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a></li>
 469           </ul>
 470         </li>
 471         <li>
 472           <span class="toc_kind_header">static</span>
 473           <ul class="toc_section">
 474
 475             <li
 476             ><a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a></li>
 477             <li
 478             ><a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a></li>
 479             <li
 480             ><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a></li>
 481             <li
 482             ><a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a></li>
 483             <li
 484             ><a href="#static_android.lens.info.hyperfocalDistance">android.lens.info.hyperfocalDistance</a></li>
 485             <li
 486             ><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a></li>
 487             <li
 488             ><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a></li>
 489             <li
 490             ><a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a></li>
 491
 492             <li
 493             ><a href="#static_android.lens.facing">android.lens.facing</a></li>
 494             <li
 495             ><a href="#static_android.lens.opticalAxisAngle">android.lens.opticalAxisAngle</a></li>
 496             <li
 497             ><a href="#static_android.lens.position">android.lens.position</a></li>
 498           </ul>
 499         </li>
 500         <li>
 501           <span class="toc_kind_header">dynamic</span>
 502           <ul class="toc_section">
 503             <li
 504             ><a href="#dynamic_android.lens.aperture">android.lens.aperture</a></li>
 505             <li
 506             ><a href="#dynamic_android.lens.filterDensity">android.lens.filterDensity</a></li>
 507             <li
 508             ><a href="#dynamic_android.lens.focalLength">android.lens.focalLength</a></li>
 509             <li
 510             ><a href="#dynamic_android.lens.focusDistance">android.lens.focusDistance</a></li>
 511             <li
 512             ><a href="#dynamic_android.lens.focusRange">android.lens.focusRange</a></li>
 513             <li
 514             ><a href="#dynamic_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a></li>
 515             <li
 516             ><a href="#dynamic_android.lens.state">android.lens.state</a></li>
 517           </ul>
 518         </li>
 519       </ul> <!-- toc_section -->
 520     </li>
 521     <li>
 522       <span class="toc_section_header"><a href="#section_noiseReduction">noiseReduction</a></span>
 523       <ul class="toc_section">
 524         <li>
 525           <span class="toc_kind_header">controls</span>
 526           <ul class="toc_section">
 527             <li
 528             ><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a></li>
 529             <li
 530             ><a href="#controls_android.noiseReduction.strength">android.noiseReduction.strength</a></li>
 531           </ul>
 532         </li>
 533         <li>
 534           <span class="toc_kind_header">static</span>
 535           <ul class="toc_section">
 536             <li
 537             ><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a></li>
 538           </ul>
 539         </li>
 540         <li>
 541           <span class="toc_kind_header">dynamic</span>
 542           <ul class="toc_section">
 543             <li
 544             ><a href="#dynamic_android.noiseReduction.mode">android.noiseReduction.mode</a></li>
 545           </ul>
 546         </li>
 547       </ul> <!-- toc_section -->
 548     </li>
 549     <li>
 550       <span class="toc_section_header"><a href="#section_quirks">quirks</a></span>
 551       <ul class="toc_section">
 552         <li>
 553           <span class="toc_kind_header">static</span>
 554           <ul class="toc_section">
 555             <li
 556                 class="toc_deprecated"
 557             ><a href="#static_android.quirks.meteringCropRegion">android.quirks.meteringCropRegion</a></li>
 558             <li
 559                 class="toc_deprecated"
 560             ><a href="#static_android.quirks.triggerAfWithAuto">android.quirks.triggerAfWithAuto</a></li>
 561             <li
 562                 class="toc_deprecated"
 563             ><a href="#static_android.quirks.useZslFormat">android.quirks.useZslFormat</a></li>
 564             <li
 565                 class="toc_deprecated"
 566             ><a href="#static_android.quirks.usePartialResult">android.quirks.usePartialResult</a></li>
 567           </ul>
 568         </li>
 569         <li>
 570           <span class="toc_kind_header">dynamic</span>
 571           <ul class="toc_section">
 572             <li
 573                 class="toc_deprecated"
 574             ><a href="#dynamic_android.quirks.partialResult">android.quirks.partialResult</a></li>
 575           </ul>
 576         </li>
 577       </ul> <!-- toc_section -->
 578     </li>
 579     <li>
 580       <span class="toc_section_header"><a href="#section_request">request</a></span>
 581       <ul class="toc_section">
 582         <li>
 583           <span class="toc_kind_header">controls</span>
 584           <ul class="toc_section">
 585             <li
 586                 class="toc_deprecated"
 587             ><a href="#controls_android.request.frameCount">android.request.frameCount</a></li>
 588             <li
 589             ><a href="#controls_android.request.id">android.request.id</a></li>
 590             <li
 591                 class="toc_deprecated"
 592             ><a href="#controls_android.request.inputStreams">android.request.inputStreams</a></li>
 593             <li
 594             ><a href="#controls_android.request.metadataMode">android.request.metadataMode</a></li>
 595             <li
 596                 class="toc_deprecated"
 597             ><a href="#controls_android.request.outputStreams">android.request.outputStreams</a></li>
 598             <li
 599                 class="toc_deprecated"
 600             ><a href="#controls_android.request.type">android.request.type</a></li>
 601           </ul>
 602         </li>
 603         <li>
 604           <span class="toc_kind_header">static</span>
 605           <ul class="toc_section">
 606             <li
 607             ><a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a></li>
 608             <li
 609             ><a href="#static_android.request.maxNumOutputRaw">android.request.maxNumOutputRaw</a></li>
 610             <li
 611             ><a href="#static_android.request.maxNumOutputProc">android.request.maxNumOutputProc</a></li>
 612             <li
 613             ><a href="#static_android.request.maxNumOutputProcStalling">android.request.maxNumOutputProcStalling</a></li>
 614             <li
 615                 class="toc_deprecated"
 616             ><a href="#static_android.request.maxNumReprocessStreams">android.request.maxNumReprocessStreams</a></li>
 617             <li
 618             ><a href="#static_android.request.maxNumInputStreams">android.request.maxNumInputStreams</a></li>
 619             <li
 620             ><a href="#static_android.request.pipelineMaxDepth">android.request.pipelineMaxDepth</a></li>
 621             <li
 622             ><a href="#static_android.request.partialResultCount">android.request.partialResultCount</a></li>
 623             <li
 624             ><a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a></li>
 625             <li
 626             ><a href="#static_android.request.availableRequestKeys">android.request.availableRequestKeys</a></li>
 627             <li
 628             ><a href="#static_android.request.availableResultKeys">android.request.availableResultKeys</a></li>
 629             <li
 630             ><a href="#static_android.request.availableCharacteristicsKeys">android.request.availableCharacteristicsKeys</a></li>
 631           </ul>
 632         </li>
 633         <li>
 634           <span class="toc_kind_header">dynamic</span>
 635           <ul class="toc_section">
 636             <li
 637                 class="toc_deprecated"
 638             ><a href="#dynamic_android.request.frameCount">android.request.frameCount</a></li>
 639             <li
 640             ><a href="#dynamic_android.request.id">android.request.id</a></li>
 641             <li
 642             ><a href="#dynamic_android.request.metadataMode">android.request.metadataMode</a></li>
 643             <li
 644                 class="toc_deprecated"
 645             ><a href="#dynamic_android.request.outputStreams">android.request.outputStreams</a></li>
 646             <li
 647             ><a href="#dynamic_android.request.pipelineDepth">android.request.pipelineDepth</a></li>
 648           </ul>
 649         </li>
 650       </ul> <!-- toc_section -->
 651     </li>
 652     <li>
 653       <span class="toc_section_header"><a href="#section_scaler">scaler</a></span>
 654       <ul class="toc_section">
 655         <li>
 656           <span class="toc_kind_header">controls</span>
 657           <ul class="toc_section">
 658             <li
 659             ><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a></li>
 660           </ul>
 661         </li>
 662         <li>
 663           <span class="toc_kind_header">static</span>
 664           <ul class="toc_section">
 665             <li
 666                 class="toc_deprecated"
 667             ><a href="#static_android.scaler.availableFormats">android.scaler.availableFormats</a></li>
 668             <li
 669                 class="toc_deprecated"
 670             ><a href="#static_android.scaler.availableJpegMinDurations">android.scaler.availableJpegMinDurations</a></li>
 671             <li
 672                 class="toc_deprecated"
 673             ><a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a></li>
 674             <li
 675             ><a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a></li>
 676             <li
 677                 class="toc_deprecated"
 678             ><a href="#static_android.scaler.availableProcessedMinDurations">android.scaler.availableProcessedMinDurations</a></li>
 679             <li
 680                 class="toc_deprecated"
 681             ><a href="#static_android.scaler.availableProcessedSizes">android.scaler.availableProcessedSizes</a></li>
 682             <li
 683                 class="toc_deprecated"
 684             ><a href="#static_android.scaler.availableRawMinDurations">android.scaler.availableRawMinDurations</a></li>
 685             <li
 686                 class="toc_deprecated"
 687             ><a href="#static_android.scaler.availableRawSizes">android.scaler.availableRawSizes</a></li>
 688             <li
 689             ><a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a></li>
 690             <li
 691             ><a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a></li>
 692             <li
 693             ><a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a></li>
 694             <li
 695             ><a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a></li>
 696             <li
 697             ><a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a></li>
 698             <li
 699             ><a href="#static_android.scaler.croppingType">android.scaler.croppingType</a></li>
 700           </ul>
 701         </li>
 702         <li>
 703           <span class="toc_kind_header">dynamic</span>
 704           <ul class="toc_section">
 705             <li
 706             ><a href="#dynamic_android.scaler.cropRegion">android.scaler.cropRegion</a></li>
 707           </ul>
 708         </li>
 709       </ul> <!-- toc_section -->
 710     </li>
 711     <li>
 712       <span class="toc_section_header"><a href="#section_sensor">sensor</a></span>
 713       <ul class="toc_section">
 714         <li>
 715           <span class="toc_kind_header">controls</span>
 716           <ul class="toc_section">
 717             <li
 718             ><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a></li>
 719             <li
 720             ><a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a></li>
 721             <li
 722             ><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a></li>
 723             <li
 724             ><a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a></li>
 725             <li
 726             ><a href="#controls_android.sensor.testPatternMode">android.sensor.testPatternMode</a></li>
 727           </ul>
 728         </li>
 729         <li>
 730           <span class="toc_kind_header">static</span>
 731           <ul class="toc_section">
 732
 733             <li
 734             ><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a></li>
 735             <li
 736             ><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a></li>
 737             <li
 738             ><a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a></li>
 739             <li
 740             ><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a></li>
 741             <li
 742             ><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a></li>
 743             <li
 744             ><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a></li>
 745             <li
 746             ><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a></li>
 747             <li
 748             ><a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a></li>
 749             <li
 750             ><a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a></li>
 751
 752             <li
 753             ><a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a></li>
 754             <li
 755             ><a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a></li>
 756             <li
 757             ><a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a></li>
 758             <li
 759             ><a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a></li>
 760             <li
 761             ><a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a></li>
 762             <li
 763             ><a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a></li>
 764             <li
 765             ><a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a></li>
 766             <li
 767             ><a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a></li>
 768             <li
 769             ><a href="#static_android.sensor.baseGainFactor">android.sensor.baseGainFactor</a></li>
 770             <li
 771             ><a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a></li>
 772             <li
 773             ><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a></li>
 774             <li
 775             ><a href="#static_android.sensor.orientation">android.sensor.orientation</a></li>
 776             <li
 777             ><a href="#static_android.sensor.profileHueSatMapDimensions">android.sensor.profileHueSatMapDimensions</a></li>
 778             <li
 779             ><a href="#static_android.sensor.availableTestPatternModes">android.sensor.availableTestPatternModes</a></li>
 780           </ul>
 781         </li>
 782         <li>
 783           <span class="toc_kind_header">dynamic</span>
 784           <ul class="toc_section">
 785             <li
 786             ><a href="#dynamic_android.sensor.exposureTime">android.sensor.exposureTime</a></li>
 787             <li
 788             ><a href="#dynamic_android.sensor.frameDuration">android.sensor.frameDuration</a></li>
 789             <li
 790             ><a href="#dynamic_android.sensor.sensitivity">android.sensor.sensitivity</a></li>
 791             <li
 792             ><a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a></li>
 793             <li
 794             ><a href="#dynamic_android.sensor.temperature">android.sensor.temperature</a></li>
 795             <li
 796             ><a href="#dynamic_android.sensor.neutralColorPoint">android.sensor.neutralColorPoint</a></li>
 797             <li
 798             ><a href="#dynamic_android.sensor.noiseProfile">android.sensor.noiseProfile</a></li>
 799             <li
 800             ><a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a></li>
 801             <li
 802             ><a href="#dynamic_android.sensor.profileToneCurve">android.sensor.profileToneCurve</a></li>
 803             <li
 804             ><a href="#dynamic_android.sensor.greenSplit">android.sensor.greenSplit</a></li>
 805             <li
 806             ><a href="#dynamic_android.sensor.testPatternData">android.sensor.testPatternData</a></li>
 807             <li
 808             ><a href="#dynamic_android.sensor.testPatternMode">android.sensor.testPatternMode</a></li>
 809             <li
 810             ><a href="#dynamic_android.sensor.rollingShutterSkew">android.sensor.rollingShutterSkew</a></li>
 811           </ul>
 812         </li>
 813       </ul> <!-- toc_section -->
 814     </li>
 815     <li>
 816       <span class="toc_section_header"><a href="#section_shading">shading</a></span>
 817       <ul class="toc_section">
 818         <li>
 819           <span class="toc_kind_header">controls</span>
 820           <ul class="toc_section">
 821             <li
 822             ><a href="#controls_android.shading.mode">android.shading.mode</a></li>
 823             <li
 824             ><a href="#controls_android.shading.strength">android.shading.strength</a></li>
 825           </ul>
 826         </li>
 827         <li>
 828           <span class="toc_kind_header">dynamic</span>
 829           <ul class="toc_section">
 830             <li
 831             ><a href="#dynamic_android.shading.mode">android.shading.mode</a></li>
 832           </ul>
 833         </li>
 834       </ul> <!-- toc_section -->
 835     </li>
 836     <li>
 837       <span class="toc_section_header"><a href="#section_statistics">statistics</a></span>
 838       <ul class="toc_section">
 839         <li>
 840           <span class="toc_kind_header">controls</span>
 841           <ul class="toc_section">
 842             <li
 843             ><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>
 844             <li
 845             ><a href="#controls_android.statistics.histogramMode">android.statistics.histogramMode</a></li>
 846             <li
 847             ><a href="#controls_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a></li>
 848             <li
 849             ><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a></li>
 850             <li
 851             ><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a></li>
 852           </ul>
 853         </li>
 854         <li>
 855           <span class="toc_kind_header">static</span>
 856           <ul class="toc_section">
 857
 858             <li
 859             ><a href="#static_android.statistics.info.availableFaceDetectModes">android.statistics.info.availableFaceDetectModes</a></li>
 860             <li
 861             ><a href="#static_android.statistics.info.histogramBucketCount">android.statistics.info.histogramBucketCount</a></li>
 862             <li
 863             ><a href="#static_android.statistics.info.maxFaceCount">android.statistics.info.maxFaceCount</a></li>
 864             <li
 865             ><a href="#static_android.statistics.info.maxHistogramCount">android.statistics.info.maxHistogramCount</a></li>
 866             <li
 867             ><a href="#static_android.statistics.info.maxSharpnessMapValue">android.statistics.info.maxSharpnessMapValue</a></li>
 868             <li
 869             ><a href="#static_android.statistics.info.sharpnessMapSize">android.statistics.info.sharpnessMapSize</a></li>
 870             <li
 871             ><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a></li>
 872
 873           </ul>
 874         </li>
 875         <li>
 876           <span class="toc_kind_header">dynamic</span>
 877           <ul class="toc_section">
 878             <li
 879             ><a href="#dynamic_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>
 880             <li
 881             ><a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a></li>
 882             <li
 883             ><a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a></li>
 884             <li
 885             ><a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a></li>
 886             <li
 887             ><a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a></li>
 888             <li
 889             ><a href="#dynamic_android.statistics.faces">android.statistics.faces</a></li>
 890             <li
 891             ><a href="#dynamic_android.statistics.histogram">android.statistics.histogram</a></li>
 892             <li
 893             ><a href="#dynamic_android.statistics.histogramMode">android.statistics.histogramMode</a></li>
 894             <li
 895             ><a href="#dynamic_android.statistics.sharpnessMap">android.statistics.sharpnessMap</a></li>
 896             <li
 897             ><a href="#dynamic_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a></li>
 898             <li
 899             ><a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a></li>
 900             <li
 901             ><a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a></li>
 902             <li
 903                 class="toc_deprecated"
 904             ><a href="#dynamic_android.statistics.predictedColorGains">android.statistics.predictedColorGains</a></li>
 905             <li
 906                 class="toc_deprecated"
 907             ><a href="#dynamic_android.statistics.predictedColorTransform">android.statistics.predictedColorTransform</a></li>
 908             <li
 909             ><a href="#dynamic_android.statistics.sceneFlicker">android.statistics.sceneFlicker</a></li>
 910             <li
 911             ><a href="#dynamic_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a></li>
 912             <li
 913             ><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a></li>
 914             <li
 915             ><a href="#dynamic_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a></li>
 916           </ul>
 917         </li>
 918       </ul> <!-- toc_section -->
 919     </li>
 920     <li>
 921       <span class="toc_section_header"><a href="#section_tonemap">tonemap</a></span>
 922       <ul class="toc_section">
 923         <li>
 924           <span class="toc_kind_header">controls</span>
 925           <ul class="toc_section">
 926             <li
 927             ><a href="#controls_android.tonemap.curveBlue">android.tonemap.curveBlue</a></li>
 928             <li
 929             ><a href="#controls_android.tonemap.curveGreen">android.tonemap.curveGreen</a></li>
 930             <li
 931             ><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a></li>
 932             <li
 933             ><a href="#controls_android.tonemap.curve">android.tonemap.curve</a></li>
 934             <li
 935             ><a href="#controls_android.tonemap.mode">android.tonemap.mode</a></li>
 936           </ul>
 937         </li>
 938         <li>
 939           <span class="toc_kind_header">static</span>
 940           <ul class="toc_section">
 941             <li
 942             ><a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></li>
 943             <li
 944             ><a href="#static_android.tonemap.availableToneMapModes">android.tonemap.availableToneMapModes</a></li>
 945           </ul>
 946         </li>
 947         <li>
 948           <span class="toc_kind_header">dynamic</span>
 949           <ul class="toc_section">
 950             <li
 951             ><a href="#dynamic_android.tonemap.curveBlue">android.tonemap.curveBlue</a></li>
 952             <li
 953             ><a href="#dynamic_android.tonemap.curveGreen">android.tonemap.curveGreen</a></li>
 954             <li
 955             ><a href="#dynamic_android.tonemap.curveRed">android.tonemap.curveRed</a></li>
 956             <li
 957             ><a href="#dynamic_android.tonemap.curve">android.tonemap.curve</a></li>
 958             <li
 959             ><a href="#dynamic_android.tonemap.mode">android.tonemap.mode</a></li>
 960           </ul>
 961         </li>
 962       </ul> <!-- toc_section -->
 963     </li>
 964     <li>
 965       <span class="toc_section_header"><a href="#section_led">led</a></span>
 966       <ul class="toc_section">
 967         <li>
 968           <span class="toc_kind_header">controls</span>
 969           <ul class="toc_section">
 970             <li
 971             ><a href="#controls_android.led.transmit">android.led.transmit</a></li>
 972           </ul>
 973         </li>
 974         <li>
 975           <span class="toc_kind_header">dynamic</span>
 976           <ul class="toc_section">
 977             <li
 978             ><a href="#dynamic_android.led.transmit">android.led.transmit</a></li>
 979           </ul>
 980         </li>
 981         <li>
 982           <span class="toc_kind_header">static</span>
 983           <ul class="toc_section">
 984             <li
 985             ><a href="#static_android.led.availableLeds">android.led.availableLeds</a></li>
 986           </ul>
 987         </li>
 988       </ul> <!-- toc_section -->
 989     </li>
 990     <li>
 991       <span class="toc_section_header"><a href="#section_info">info</a></span>
 992       <ul class="toc_section">
 993         <li>
 994           <span class="toc_kind_header">static</span>
 995           <ul class="toc_section">
 996             <li
 997             ><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a></li>
 998           </ul>
 999         </li>
1000       </ul> <!-- toc_section -->
1001     </li>
1002     <li>
1003       <span class="toc_section_header"><a href="#section_blackLevel">blackLevel</a></span>
1004       <ul class="toc_section">
1005         <li>
1006           <span class="toc_kind_header">controls</span>
1007           <ul class="toc_section">
1008             <li
1009             ><a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a></li>
1010           </ul>
1011         </li>
1012         <li>
1013           <span class="toc_kind_header">dynamic</span>
1014           <ul class="toc_section">
1015             <li
1016             ><a href="#dynamic_android.blackLevel.lock">android.blackLevel.lock</a></li>
1017           </ul>
1018         </li>
1019       </ul> <!-- toc_section -->
1020     </li>
1021     <li>
1022       <span class="toc_section_header"><a href="#section_sync">sync</a></span>
1023       <ul class="toc_section">
1024         <li>
1025           <span class="toc_kind_header">dynamic</span>
1026           <ul class="toc_section">
1027             <li
1028             ><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a></li>
1029           </ul>
1030         </li>
1031         <li>
1032           <span class="toc_kind_header">static</span>
1033           <ul class="toc_section">
1034             <li
1035             ><a href="#static_android.sync.maxLatency">android.sync.maxLatency</a></li>
1036           </ul>
1037         </li>
1038       </ul> <!-- toc_section -->
1039     </li>
1040   </ul>
1041
1042
1043   <h1>Properties</h1>
1044   <table class="properties">
1045
1046     <thead class="thead_dummy">
1047       <tr>
1048         <th class="th_name">Property Name</th>
1049         <th class="th_type">Type</th>
1050         <th class="th_description">Description</th>
1051         <th class="th_units">Units</th>
1052         <th class="th_range">Range</th>
1053         <th class="th_tags">Tags</th>
1054       </tr>
1055     </thead> <!-- so that the first occurrence of thead is not
1056                          above the first occurrence of tr -->
1057 <!-- <namespace name="android"> -->
1058   <tr><td colspan="6" id="section_colorCorrection" class="section">colorCorrection</td></tr>
1059
1060
1061       <tr><td colspan="6" class="kind">controls</td></tr>
1062
1063       <thead class="entries_header">
1064         <tr>
1065           <th class="th_name">Property Name</th>
1066           <th class="th_type">Type</th>
1067           <th class="th_description">Description</th>
1068           <th class="th_units">Units</th>
1069           <th class="th_range">Range</th>
1070           <th class="th_tags">Tags</th>
1071         </tr>
1072       </thead>
1073
1074       <tbody>
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085           <tr class="entry" id="controls_android.colorCorrection.mode">
1086             <td class="entry_name
1087              " rowspan="3">
1088               android.<wbr/>color<wbr/>Correction.<wbr/>mode
1089             </td>
1090             <td class="entry_type">
1091                 <span class="entry_type_name entry_type_name_enum">byte</span>
1092
1093               <span class="entry_type_visibility"> [public]</span>
1094
1095
1096               <span class="entry_type_hwlevel">[full] </span>
1097
1098
1099
1100                 <ul class="entry_type_enum">
1101                   <li>
1102                     <span class="entry_type_enum_name">TRANSFORM_MATRIX</span>
1103                     <span class="entry_type_enum_notes"><p>Use the <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> matrix
1104 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> to do color conversion.<wbr/></p>
1105 <p>All advanced white balance adjustments (not specified
1106 by our white balance pipeline) must be disabled.<wbr/></p>
1107 <p>If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != OFF</code>,<wbr/> then
1108 TRANSFORM_<wbr/>MATRIX is ignored.<wbr/> The camera device will override
1109 this value to either FAST or HIGH_<wbr/>QUALITY.<wbr/></p></span>
1110                   </li>
1111                   <li>
1112                     <span class="entry_type_enum_name">FAST</span>
1113                     <span class="entry_type_enum_notes"><p>Color correction processing must not slow down
1114 capture rate relative to sensor raw output.<wbr/></p>
1115 <p>Advanced white balance adjustments above and beyond
1116 the specified white balance pipeline may be applied.<wbr/></p>
1117 <p>If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != OFF</code>,<wbr/> then
1118 the camera device uses the last frame's AWB values
1119 (or defaults if AWB has never been run).<wbr/></p></span>
1120                   </li>
1121                   <li>
1122                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
1123                     <span class="entry_type_enum_notes"><p>Color correction processing operates at improved
1124 quality but reduced capture rate (relative to sensor raw
1125 output).<wbr/></p>
1126 <p>Advanced white balance adjustments above and beyond
1127 the specified white balance pipeline may be applied.<wbr/></p>
1128 <p>If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != OFF</code>,<wbr/> then
1129 the camera device uses the last frame's AWB values
1130 (or defaults if AWB has never been run).<wbr/></p></span>
1131                   </li>
1132                 </ul>
1133
1134             </td> <!-- entry_type -->
1135
1136             <td class="entry_description">
1137               <p>The mode control selects how the image data is converted from the
1138 sensor's native color into linear sRGB color.<wbr/></p>
1139             </td>
1140
1141             <td class="entry_units">
1142             </td>
1143
1144             <td class="entry_range">
1145             </td>
1146
1147             <td class="entry_tags">
1148             </td>
1149
1150           </tr>
1151           <tr class="entries_header">
1152             <th class="th_details" colspan="5">Details</th>
1153           </tr>
1154           <tr class="entry_cont">
1155             <td class="entry_details" colspan="5">
1156               <p>When auto-white balance (AWB) is enabled with <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> this
1157 control is overridden by the AWB routine.<wbr/> When AWB is disabled,<wbr/> the
1158 application controls how the color mapping is performed.<wbr/></p>
1159 <p>We define the expected processing pipeline below.<wbr/> For consistency
1160 across devices,<wbr/> this is always the case with TRANSFORM_<wbr/>MATRIX.<wbr/></p>
1161 <p>When either FULL or HIGH_<wbr/>QUALITY is used,<wbr/> the camera device may
1162 do additional processing but <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
1163 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> will still be provided by the
1164 camera device (in the results) and be roughly correct.<wbr/></p>
1165 <p>Switching to TRANSFORM_<wbr/>MATRIX and using the data provided from
1166 FAST or HIGH_<wbr/>QUALITY will yield a picture with the same white point
1167 as what was produced by the camera device in the earlier frame.<wbr/></p>
1168 <p>The expected processing pipeline is as follows:</p>
1169 <p><img alt="White balance processing pipeline" src="images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png"/></p>
1170 <p>The white balance is encoded by two values,<wbr/> a 4-channel white-balance
1171 gain vector (applied in the Bayer domain),<wbr/> and a 3x3 color transform
1172 matrix (applied after demosaic).<wbr/></p>
1173 <p>The 4-channel white-balance gains are defined as:</p>
1174 <pre><code><a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> = [ R G_<wbr/>even G_<wbr/>odd B ]
1175 </code></pre>
1176 <p>where <code>G_<wbr/>even</code> is the gain for green pixels on even rows of the
1177 output,<wbr/> and <code>G_<wbr/>odd</code> is the gain for green pixels on the odd rows.<wbr/>
1178 These may be identical for a given camera device implementation; if
1179 the camera device does not support a separate gain for even/<wbr/>odd green
1180 channels,<wbr/> it will use the <code>G_<wbr/>even</code> value,<wbr/> and write <code>G_<wbr/>odd</code> equal to
1181 <code>G_<wbr/>even</code> in the output result metadata.<wbr/></p>
1182 <p>The matrices for color transforms are defined as a 9-entry vector:</p>
1183 <pre><code><a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ]
1184 </code></pre>
1185 <p>which define a transform from input sensor colors,<wbr/> <code>P_<wbr/>in = [ r g b ]</code>,<wbr/>
1186 to output linear sRGB,<wbr/> <code>P_<wbr/>out = [ r' g' b' ]</code>,<wbr/></p>
1187 <p>with colors as follows:</p>
1188 <pre><code>r' = I0r + I1g + I2b
1189 g' = I3r + I4g + I5b
1190 b' = I6r + I7g + I8b
1191 </code></pre>
1192 <p>Both the input and output value ranges must match.<wbr/> Overflow/<wbr/>underflow
1193 values are clipped to fit within the range.<wbr/></p>
1194             </td>
1195           </tr>
1196
1197
1198           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1199            <!-- end of entry -->
1200
1201
1202           <tr class="entry" id="controls_android.colorCorrection.transform">
1203             <td class="entry_name
1204              " rowspan="3">
1205               android.<wbr/>color<wbr/>Correction.<wbr/>transform
1206             </td>
1207             <td class="entry_type">
1208                 <span class="entry_type_name">rational</span>
1209                 <span class="entry_type_container">x</span>
1210
1211                 <span class="entry_type_array">
1212                   3 x 3
1213                 </span>
1214               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
1215
1216
1217               <span class="entry_type_hwlevel">[full] </span>
1218
1219
1220                 <div class="entry_type_notes">3x3 rational matrix in row-major order</div>
1221
1222
1223             </td> <!-- entry_type -->
1224
1225             <td class="entry_description">
1226               <p>A color transform matrix to use to transform
1227 from sensor RGB color space to output linear sRGB color space.<wbr/></p>
1228             </td>
1229
1230             <td class="entry_units">
1231               Unitless scale factors
1232             </td>
1233
1234             <td class="entry_range">
1235             </td>
1236
1237             <td class="entry_tags">
1238             </td>
1239
1240           </tr>
1241           <tr class="entries_header">
1242             <th class="th_details" colspan="5">Details</th>
1243           </tr>
1244           <tr class="entry_cont">
1245             <td class="entry_details" colspan="5">
1246               <p>This matrix is either set by the camera device when the request
1247 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is not TRANSFORM_<wbr/>MATRIX,<wbr/> or
1248 directly by the application in the request when the
1249 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is TRANSFORM_<wbr/>MATRIX.<wbr/></p>
1250 <p>In the latter case,<wbr/> the camera device may round the matrix to account
1251 for precision issues; the final rounded matrix should be reported back
1252 in this matrix result metadata.<wbr/> The transform should keep the magnitude
1253 of the output color values within <code>[0,<wbr/> 1.<wbr/>0]</code> (assuming input color
1254 values is within the normalized range <code>[0,<wbr/> 1.<wbr/>0]</code>),<wbr/> or clipping may occur.<wbr/></p>
1255             </td>
1256           </tr>
1257
1258
1259           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1260            <!-- end of entry -->
1261
1262
1263           <tr class="entry" id="controls_android.colorCorrection.gains">
1264             <td class="entry_name
1265              " rowspan="5">
1266               android.<wbr/>color<wbr/>Correction.<wbr/>gains
1267             </td>
1268             <td class="entry_type">
1269                 <span class="entry_type_name">float</span>
1270                 <span class="entry_type_container">x</span>
1271
1272                 <span class="entry_type_array">
1273                   4
1274                 </span>
1275               <span class="entry_type_visibility"> [public as rggbChannelVector]</span>
1276
1277
1278               <span class="entry_type_hwlevel">[full] </span>
1279
1280
1281                 <div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>
1282
1283
1284             </td> <!-- entry_type -->
1285
1286             <td class="entry_description">
1287               <p>Gains applying to Bayer raw color channels for
1288 white-balance.<wbr/></p>
1289             </td>
1290
1291             <td class="entry_units">
1292               Unitless gain factors
1293             </td>
1294
1295             <td class="entry_range">
1296             </td>
1297
1298             <td class="entry_tags">
1299             </td>
1300
1301           </tr>
1302           <tr class="entries_header">
1303             <th class="th_details" colspan="5">Details</th>
1304           </tr>
1305           <tr class="entry_cont">
1306             <td class="entry_details" colspan="5">
1307               <p>These per-channel gains are either set by the camera device
1308 when the request <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is not
1309 TRANSFORM_<wbr/>MATRIX,<wbr/> or directly by the application in the
1310 request when the <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is
1311 TRANSFORM_<wbr/>MATRIX.<wbr/></p>
1312 <p>The gains in the result metadata are the gains actually
1313 applied by the camera device to the current frame.<wbr/></p>
1314             </td>
1315           </tr>
1316
1317           <tr class="entries_header">
1318             <th class="th_details" colspan="5">HAL Implementation Details</th>
1319           </tr>
1320           <tr class="entry_cont">
1321             <td class="entry_details" colspan="5">
1322               <p>The 4-channel white-balance gains are defined in
1323 the order of <code>[R G_<wbr/>even G_<wbr/>odd B]</code>,<wbr/> where <code>G_<wbr/>even</code> is the gain
1324 for green pixels on even rows of the output,<wbr/> and <code>G_<wbr/>odd</code>
1325 is the gain for green pixels on the odd rows.<wbr/></p>
1326 <p>If a HAL does not support a separate gain for even/<wbr/>odd green
1327 channels,<wbr/> it must use the <code>G_<wbr/>even</code> value,<wbr/> and write
1328 <code>G_<wbr/>odd</code> equal to <code>G_<wbr/>even</code> in the output result metadata.<wbr/></p>
1329             </td>
1330           </tr>
1331
1332           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1333            <!-- end of entry -->
1334
1335
1336           <tr class="entry" id="controls_android.colorCorrection.aberrationMode">
1337             <td class="entry_name
1338              " rowspan="3">
1339               android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode
1340             </td>
1341             <td class="entry_type">
1342                 <span class="entry_type_name entry_type_name_enum">byte</span>
1343
1344               <span class="entry_type_visibility"> [public]</span>
1345
1346
1347               <span class="entry_type_hwlevel">[legacy] </span>
1348
1349
1350
1351                 <ul class="entry_type_enum">
1352                   <li>
1353                     <span class="entry_type_enum_name">OFF</span>
1354                     <span class="entry_type_enum_notes"><p>No aberration correction is applied.<wbr/></p></span>
1355                   </li>
1356                   <li>
1357                     <span class="entry_type_enum_name">FAST</span>
1358                     <span class="entry_type_enum_notes"><p>Aberration correction will not slow down capture rate
1359 relative to sensor raw output.<wbr/></p></span>
1360                   </li>
1361                   <li>
1362                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
1363                     <span class="entry_type_enum_notes"><p>Aberration correction operates at improved quality but reduced
1364 capture rate (relative to sensor raw output).<wbr/></p></span>
1365                   </li>
1366                 </ul>
1367
1368             </td> <!-- entry_type -->
1369
1370             <td class="entry_description">
1371               <p>Mode of operation for the chromatic aberration correction algorithm.<wbr/></p>
1372             </td>
1373
1374             <td class="entry_units">
1375             </td>
1376
1377             <td class="entry_range">
1378               <p><a href="#static_android.colorCorrection.availableAberrationModes">android.<wbr/>color<wbr/>Correction.<wbr/>available<wbr/>Aberration<wbr/>Modes</a></p>
1379             </td>
1380
1381             <td class="entry_tags">
1382             </td>
1383
1384           </tr>
1385           <tr class="entries_header">
1386             <th class="th_details" colspan="5">Details</th>
1387           </tr>
1388           <tr class="entry_cont">
1389             <td class="entry_details" colspan="5">
1390               <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light
1391 can not focus on the same point after exiting from the lens.<wbr/> This metadata defines
1392 the high level control of chromatic aberration correction algorithm,<wbr/> which aims to
1393 minimize the chromatic artifacts that may occur along the object boundaries in an
1394 image.<wbr/></p>
1395 <p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean that camera device determined aberration
1396 correction will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the camera device will
1397 use the highest-quality aberration correction algorithms,<wbr/> even if it slows down
1398 capture rate.<wbr/> FAST means the camera device will not slow down capture rate when
1399 applying aberration correction.<wbr/></p>
1400 <p>LEGACY devices will always be in FAST mode.<wbr/></p>
1401             </td>
1402           </tr>
1403
1404
1405           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1406            <!-- end of entry -->
1407
1408
1409
1410       <!-- end of kind -->
1411       </tbody>
1412       <tr><td colspan="6" class="kind">dynamic</td></tr>
1413
1414       <thead class="entries_header">
1415         <tr>
1416           <th class="th_name">Property Name</th>
1417           <th class="th_type">Type</th>
1418           <th class="th_description">Description</th>
1419           <th class="th_units">Units</th>
1420           <th class="th_range">Range</th>
1421           <th class="th_tags">Tags</th>
1422         </tr>
1423       </thead>
1424
1425       <tbody>
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436           <tr class="entry" id="dynamic_android.colorCorrection.mode">
1437             <td class="entry_name
1438              " rowspan="3">
1439               android.<wbr/>color<wbr/>Correction.<wbr/>mode
1440             </td>
1441             <td class="entry_type">
1442                 <span class="entry_type_name entry_type_name_enum">byte</span>
1443
1444               <span class="entry_type_visibility"> [public]</span>
1445
1446
1447               <span class="entry_type_hwlevel">[full] </span>
1448
1449
1450
1451                 <ul class="entry_type_enum">
1452                   <li>
1453                     <span class="entry_type_enum_name">TRANSFORM_MATRIX</span>
1454                     <span class="entry_type_enum_notes"><p>Use the <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> matrix
1455 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> to do color conversion.<wbr/></p>
1456 <p>All advanced white balance adjustments (not specified
1457 by our white balance pipeline) must be disabled.<wbr/></p>
1458 <p>If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != OFF</code>,<wbr/> then
1459 TRANSFORM_<wbr/>MATRIX is ignored.<wbr/> The camera device will override
1460 this value to either FAST or HIGH_<wbr/>QUALITY.<wbr/></p></span>
1461                   </li>
1462                   <li>
1463                     <span class="entry_type_enum_name">FAST</span>
1464                     <span class="entry_type_enum_notes"><p>Color correction processing must not slow down
1465 capture rate relative to sensor raw output.<wbr/></p>
1466 <p>Advanced white balance adjustments above and beyond
1467 the specified white balance pipeline may be applied.<wbr/></p>
1468 <p>If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != OFF</code>,<wbr/> then
1469 the camera device uses the last frame's AWB values
1470 (or defaults if AWB has never been run).<wbr/></p></span>
1471                   </li>
1472                   <li>
1473                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
1474                     <span class="entry_type_enum_notes"><p>Color correction processing operates at improved
1475 quality but reduced capture rate (relative to sensor raw
1476 output).<wbr/></p>
1477 <p>Advanced white balance adjustments above and beyond
1478 the specified white balance pipeline may be applied.<wbr/></p>
1479 <p>If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != OFF</code>,<wbr/> then
1480 the camera device uses the last frame's AWB values
1481 (or defaults if AWB has never been run).<wbr/></p></span>
1482                   </li>
1483                 </ul>
1484
1485             </td> <!-- entry_type -->
1486
1487             <td class="entry_description">
1488               <p>The mode control selects how the image data is converted from the
1489 sensor's native color into linear sRGB color.<wbr/></p>
1490             </td>
1491
1492             <td class="entry_units">
1493             </td>
1494
1495             <td class="entry_range">
1496             </td>
1497
1498             <td class="entry_tags">
1499             </td>
1500
1501           </tr>
1502           <tr class="entries_header">
1503             <th class="th_details" colspan="5">Details</th>
1504           </tr>
1505           <tr class="entry_cont">
1506             <td class="entry_details" colspan="5">
1507               <p>When auto-white balance (AWB) is enabled with <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> this
1508 control is overridden by the AWB routine.<wbr/> When AWB is disabled,<wbr/> the
1509 application controls how the color mapping is performed.<wbr/></p>
1510 <p>We define the expected processing pipeline below.<wbr/> For consistency
1511 across devices,<wbr/> this is always the case with TRANSFORM_<wbr/>MATRIX.<wbr/></p>
1512 <p>When either FULL or HIGH_<wbr/>QUALITY is used,<wbr/> the camera device may
1513 do additional processing but <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
1514 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> will still be provided by the
1515 camera device (in the results) and be roughly correct.<wbr/></p>
1516 <p>Switching to TRANSFORM_<wbr/>MATRIX and using the data provided from
1517 FAST or HIGH_<wbr/>QUALITY will yield a picture with the same white point
1518 as what was produced by the camera device in the earlier frame.<wbr/></p>
1519 <p>The expected processing pipeline is as follows:</p>
1520 <p><img alt="White balance processing pipeline" src="images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png"/></p>
1521 <p>The white balance is encoded by two values,<wbr/> a 4-channel white-balance
1522 gain vector (applied in the Bayer domain),<wbr/> and a 3x3 color transform
1523 matrix (applied after demosaic).<wbr/></p>
1524 <p>The 4-channel white-balance gains are defined as:</p>
1525 <pre><code><a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> = [ R G_<wbr/>even G_<wbr/>odd B ]
1526 </code></pre>
1527 <p>where <code>G_<wbr/>even</code> is the gain for green pixels on even rows of the
1528 output,<wbr/> and <code>G_<wbr/>odd</code> is the gain for green pixels on the odd rows.<wbr/>
1529 These may be identical for a given camera device implementation; if
1530 the camera device does not support a separate gain for even/<wbr/>odd green
1531 channels,<wbr/> it will use the <code>G_<wbr/>even</code> value,<wbr/> and write <code>G_<wbr/>odd</code> equal to
1532 <code>G_<wbr/>even</code> in the output result metadata.<wbr/></p>
1533 <p>The matrices for color transforms are defined as a 9-entry vector:</p>
1534 <pre><code><a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ]
1535 </code></pre>
1536 <p>which define a transform from input sensor colors,<wbr/> <code>P_<wbr/>in = [ r g b ]</code>,<wbr/>
1537 to output linear sRGB,<wbr/> <code>P_<wbr/>out = [ r' g' b' ]</code>,<wbr/></p>
1538 <p>with colors as follows:</p>
1539 <pre><code>r' = I0r + I1g + I2b
1540 g' = I3r + I4g + I5b
1541 b' = I6r + I7g + I8b
1542 </code></pre>
1543 <p>Both the input and output value ranges must match.<wbr/> Overflow/<wbr/>underflow
1544 values are clipped to fit within the range.<wbr/></p>
1545             </td>
1546           </tr>
1547
1548
1549           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1550            <!-- end of entry -->
1551
1552
1553           <tr class="entry" id="dynamic_android.colorCorrection.transform">
1554             <td class="entry_name
1555              " rowspan="3">
1556               android.<wbr/>color<wbr/>Correction.<wbr/>transform
1557             </td>
1558             <td class="entry_type">
1559                 <span class="entry_type_name">rational</span>
1560                 <span class="entry_type_container">x</span>
1561
1562                 <span class="entry_type_array">
1563                   3 x 3
1564                 </span>
1565               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
1566
1567
1568               <span class="entry_type_hwlevel">[full] </span>
1569
1570
1571                 <div class="entry_type_notes">3x3 rational matrix in row-major order</div>
1572
1573
1574             </td> <!-- entry_type -->
1575
1576             <td class="entry_description">
1577               <p>A color transform matrix to use to transform
1578 from sensor RGB color space to output linear sRGB color space.<wbr/></p>
1579             </td>
1580
1581             <td class="entry_units">
1582               Unitless scale factors
1583             </td>
1584
1585             <td class="entry_range">
1586             </td>
1587
1588             <td class="entry_tags">
1589             </td>
1590
1591           </tr>
1592           <tr class="entries_header">
1593             <th class="th_details" colspan="5">Details</th>
1594           </tr>
1595           <tr class="entry_cont">
1596             <td class="entry_details" colspan="5">
1597               <p>This matrix is either set by the camera device when the request
1598 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is not TRANSFORM_<wbr/>MATRIX,<wbr/> or
1599 directly by the application in the request when the
1600 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is TRANSFORM_<wbr/>MATRIX.<wbr/></p>
1601 <p>In the latter case,<wbr/> the camera device may round the matrix to account
1602 for precision issues; the final rounded matrix should be reported back
1603 in this matrix result metadata.<wbr/> The transform should keep the magnitude
1604 of the output color values within <code>[0,<wbr/> 1.<wbr/>0]</code> (assuming input color
1605 values is within the normalized range <code>[0,<wbr/> 1.<wbr/>0]</code>),<wbr/> or clipping may occur.<wbr/></p>
1606             </td>
1607           </tr>
1608
1609
1610           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1611            <!-- end of entry -->
1612
1613
1614           <tr class="entry" id="dynamic_android.colorCorrection.gains">
1615             <td class="entry_name
1616              " rowspan="5">
1617               android.<wbr/>color<wbr/>Correction.<wbr/>gains
1618             </td>
1619             <td class="entry_type">
1620                 <span class="entry_type_name">float</span>
1621                 <span class="entry_type_container">x</span>
1622
1623                 <span class="entry_type_array">
1624                   4
1625                 </span>
1626               <span class="entry_type_visibility"> [public as rggbChannelVector]</span>
1627
1628
1629               <span class="entry_type_hwlevel">[full] </span>
1630
1631
1632                 <div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>
1633
1634
1635             </td> <!-- entry_type -->
1636
1637             <td class="entry_description">
1638               <p>Gains applying to Bayer raw color channels for
1639 white-balance.<wbr/></p>
1640             </td>
1641
1642             <td class="entry_units">
1643               Unitless gain factors
1644             </td>
1645
1646             <td class="entry_range">
1647             </td>
1648
1649             <td class="entry_tags">
1650             </td>
1651
1652           </tr>
1653           <tr class="entries_header">
1654             <th class="th_details" colspan="5">Details</th>
1655           </tr>
1656           <tr class="entry_cont">
1657             <td class="entry_details" colspan="5">
1658               <p>These per-channel gains are either set by the camera device
1659 when the request <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is not
1660 TRANSFORM_<wbr/>MATRIX,<wbr/> or directly by the application in the
1661 request when the <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is
1662 TRANSFORM_<wbr/>MATRIX.<wbr/></p>
1663 <p>The gains in the result metadata are the gains actually
1664 applied by the camera device to the current frame.<wbr/></p>
1665             </td>
1666           </tr>
1667
1668           <tr class="entries_header">
1669             <th class="th_details" colspan="5">HAL Implementation Details</th>
1670           </tr>
1671           <tr class="entry_cont">
1672             <td class="entry_details" colspan="5">
1673               <p>The 4-channel white-balance gains are defined in
1674 the order of <code>[R G_<wbr/>even G_<wbr/>odd B]</code>,<wbr/> where <code>G_<wbr/>even</code> is the gain
1675 for green pixels on even rows of the output,<wbr/> and <code>G_<wbr/>odd</code>
1676 is the gain for green pixels on the odd rows.<wbr/></p>
1677 <p>If a HAL does not support a separate gain for even/<wbr/>odd green
1678 channels,<wbr/> it must use the <code>G_<wbr/>even</code> value,<wbr/> and write
1679 <code>G_<wbr/>odd</code> equal to <code>G_<wbr/>even</code> in the output result metadata.<wbr/></p>
1680             </td>
1681           </tr>
1682
1683           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1684            <!-- end of entry -->
1685
1686
1687           <tr class="entry" id="dynamic_android.colorCorrection.aberrationMode">
1688             <td class="entry_name
1689              " rowspan="3">
1690               android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode
1691             </td>
1692             <td class="entry_type">
1693                 <span class="entry_type_name entry_type_name_enum">byte</span>
1694
1695               <span class="entry_type_visibility"> [public]</span>
1696
1697
1698               <span class="entry_type_hwlevel">[legacy] </span>
1699
1700
1701
1702                 <ul class="entry_type_enum">
1703                   <li>
1704                     <span class="entry_type_enum_name">OFF</span>
1705                     <span class="entry_type_enum_notes"><p>No aberration correction is applied.<wbr/></p></span>
1706                   </li>
1707                   <li>
1708                     <span class="entry_type_enum_name">FAST</span>
1709                     <span class="entry_type_enum_notes"><p>Aberration correction will not slow down capture rate
1710 relative to sensor raw output.<wbr/></p></span>
1711                   </li>
1712                   <li>
1713                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
1714                     <span class="entry_type_enum_notes"><p>Aberration correction operates at improved quality but reduced
1715 capture rate (relative to sensor raw output).<wbr/></p></span>
1716                   </li>
1717                 </ul>
1718
1719             </td> <!-- entry_type -->
1720
1721             <td class="entry_description">
1722               <p>Mode of operation for the chromatic aberration correction algorithm.<wbr/></p>
1723             </td>
1724
1725             <td class="entry_units">
1726             </td>
1727
1728             <td class="entry_range">
1729               <p><a href="#static_android.colorCorrection.availableAberrationModes">android.<wbr/>color<wbr/>Correction.<wbr/>available<wbr/>Aberration<wbr/>Modes</a></p>
1730             </td>
1731
1732             <td class="entry_tags">
1733             </td>
1734
1735           </tr>
1736           <tr class="entries_header">
1737             <th class="th_details" colspan="5">Details</th>
1738           </tr>
1739           <tr class="entry_cont">
1740             <td class="entry_details" colspan="5">
1741               <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light
1742 can not focus on the same point after exiting from the lens.<wbr/> This metadata defines
1743 the high level control of chromatic aberration correction algorithm,<wbr/> which aims to
1744 minimize the chromatic artifacts that may occur along the object boundaries in an
1745 image.<wbr/></p>
1746 <p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean that camera device determined aberration
1747 correction will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the camera device will
1748 use the highest-quality aberration correction algorithms,<wbr/> even if it slows down
1749 capture rate.<wbr/> FAST means the camera device will not slow down capture rate when
1750 applying aberration correction.<wbr/></p>
1751 <p>LEGACY devices will always be in FAST mode.<wbr/></p>
1752             </td>
1753           </tr>
1754
1755
1756           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1757            <!-- end of entry -->
1758
1759
1760
1761       <!-- end of kind -->
1762       </tbody>
1763       <tr><td colspan="6" class="kind">static</td></tr>
1764
1765       <thead class="entries_header">
1766         <tr>
1767           <th class="th_name">Property Name</th>
1768           <th class="th_type">Type</th>
1769           <th class="th_description">Description</th>
1770           <th class="th_units">Units</th>
1771           <th class="th_range">Range</th>
1772           <th class="th_tags">Tags</th>
1773         </tr>
1774       </thead>
1775
1776       <tbody>
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787           <tr class="entry" id="static_android.colorCorrection.availableAberrationModes">
1788             <td class="entry_name
1789              " rowspan="3">
1790               android.<wbr/>color<wbr/>Correction.<wbr/>available<wbr/>Aberration<wbr/>Modes
1791             </td>
1792             <td class="entry_type">
1793                 <span class="entry_type_name">byte</span>
1794                 <span class="entry_type_container">x</span>
1795
1796                 <span class="entry_type_array">
1797                   n
1798                 </span>
1799               <span class="entry_type_visibility"> [public as enumList]</span>
1800
1801
1802               <span class="entry_type_hwlevel">[legacy] </span>
1803
1804
1805                 <div class="entry_type_notes">list of enums</div>
1806
1807
1808             </td> <!-- entry_type -->
1809
1810             <td class="entry_description">
1811               <p>List of aberration correction modes for <a href="#controls_android.colorCorrection.aberrationMode">android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode</a> that are
1812 supported by this camera device.<wbr/></p>
1813             </td>
1814
1815             <td class="entry_units">
1816             </td>
1817
1818             <td class="entry_range">
1819               <p>Any value listed in <a href="#controls_android.colorCorrection.aberrationMode">android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode</a></p>
1820             </td>
1821
1822             <td class="entry_tags">
1823               <ul class="entry_tags">
1824                   <li><a href="#tag_V1">V1</a></li>
1825               </ul>
1826             </td>
1827
1828           </tr>
1829           <tr class="entries_header">
1830             <th class="th_details" colspan="5">Details</th>
1831           </tr>
1832           <tr class="entry_cont">
1833             <td class="entry_details" colspan="5">
1834               <p>This key lists the valid modes for <a href="#controls_android.colorCorrection.aberrationMode">android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode</a>.<wbr/>  If no
1835 aberration correction modes are available for a device,<wbr/> this list will solely include
1836 OFF mode.<wbr/></p>
1837 <p>For FULL capability device (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> <code>==</code> FULL),<wbr/> OFF is
1838 always included.<wbr/></p>
1839 <p>LEGACY devices will always only support FAST mode.<wbr/></p>
1840             </td>
1841           </tr>
1842
1843
1844           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1845            <!-- end of entry -->
1846
1847
1848
1849       <!-- end of kind -->
1850       </tbody>
1851
1852   <!-- end of section -->
1853   <tr><td colspan="6" id="section_control" class="section">control</td></tr>
1854
1855
1856       <tr><td colspan="6" class="kind">controls</td></tr>
1857
1858       <thead class="entries_header">
1859         <tr>
1860           <th class="th_name">Property Name</th>
1861           <th class="th_type">Type</th>
1862           <th class="th_description">Description</th>
1863           <th class="th_units">Units</th>
1864           <th class="th_range">Range</th>
1865           <th class="th_tags">Tags</th>
1866         </tr>
1867       </thead>
1868
1869       <tbody>
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880           <tr class="entry" id="controls_android.control.aeAntibandingMode">
1881             <td class="entry_name
1882              " rowspan="5">
1883               android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode
1884             </td>
1885             <td class="entry_type">
1886                 <span class="entry_type_name entry_type_name_enum">byte</span>
1887
1888               <span class="entry_type_visibility"> [public]</span>
1889
1890
1891               <span class="entry_type_hwlevel">[legacy] </span>
1892
1893
1894
1895                 <ul class="entry_type_enum">
1896                   <li>
1897                     <span class="entry_type_enum_name">OFF</span>
1898                     <span class="entry_type_enum_notes"><p>The camera device will not adjust exposure duration to
1899 avoid banding problems.<wbr/></p></span>
1900                   </li>
1901                   <li>
1902                     <span class="entry_type_enum_name">50HZ</span>
1903                     <span class="entry_type_enum_notes"><p>The camera device will adjust exposure duration to
1904 avoid banding problems with 50Hz illumination sources.<wbr/></p></span>
1905                   </li>
1906                   <li>
1907                     <span class="entry_type_enum_name">60HZ</span>
1908                     <span class="entry_type_enum_notes"><p>The camera device will adjust exposure duration to
1909 avoid banding problems with 60Hz illumination
1910 sources.<wbr/></p></span>
1911                   </li>
1912                   <li>
1913                     <span class="entry_type_enum_name">AUTO</span>
1914                     <span class="entry_type_enum_notes"><p>The camera device will automatically adapt its
1915 antibanding routine to the current illumination
1916 conditions.<wbr/> This is the default.<wbr/></p></span>
1917                   </li>
1918                 </ul>
1919
1920             </td> <!-- entry_type -->
1921
1922             <td class="entry_description">
1923               <p>The desired setting for the camera device's auto-exposure
1924 algorithm's antibanding compensation.<wbr/></p>
1925             </td>
1926
1927             <td class="entry_units">
1928             </td>
1929
1930             <td class="entry_range">
1931               <p><a href="#static_android.control.aeAvailableAntibandingModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes</a></p>
1932             </td>
1933
1934             <td class="entry_tags">
1935               <ul class="entry_tags">
1936                   <li><a href="#tag_BC">BC</a></li>
1937               </ul>
1938             </td>
1939
1940           </tr>
1941           <tr class="entries_header">
1942             <th class="th_details" colspan="5">Details</th>
1943           </tr>
1944           <tr class="entry_cont">
1945             <td class="entry_details" colspan="5">
1946               <p>Some kinds of lighting fixtures,<wbr/> such as some fluorescent
1947 lights,<wbr/> flicker at the rate of the power supply frequency
1948 (60Hz or 50Hz,<wbr/> depending on country).<wbr/> While this is
1949 typically not noticeable to a person,<wbr/> it can be visible to
1950 a camera device.<wbr/> If a camera sets its exposure time to the
1951 wrong value,<wbr/> the flicker may become visible in the
1952 viewfinder as flicker or in a final captured image,<wbr/> as a
1953 set of variable-brightness bands across the image.<wbr/></p>
1954 <p>Therefore,<wbr/> the auto-exposure routines of camera devices
1955 include antibanding routines that ensure that the chosen
1956 exposure value will not cause such banding.<wbr/> The choice of
1957 exposure time depends on the rate of flicker,<wbr/> which the
1958 camera device can detect automatically,<wbr/> or the expected
1959 rate can be selected by the application using this
1960 control.<wbr/></p>
1961 <p>A given camera device may not support all of the possible
1962 options for the antibanding mode.<wbr/> The
1963 <a href="#static_android.control.aeAvailableAntibandingModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes</a> key contains
1964 the available modes for a given camera device.<wbr/></p>
1965 <p>The default mode is AUTO,<wbr/> which is supported by all
1966 camera devices.<wbr/></p>
1967 <p>If manual exposure control is enabled (by setting
1968 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> to OFF),<wbr/>
1969 then this setting has no effect,<wbr/> and the application must
1970 ensure it selects exposure times that do not cause banding
1971 issues.<wbr/> The <a href="#dynamic_android.statistics.sceneFlicker">android.<wbr/>statistics.<wbr/>scene<wbr/>Flicker</a> key can assist
1972 the application in this.<wbr/></p>
1973             </td>
1974           </tr>
1975
1976           <tr class="entries_header">
1977             <th class="th_details" colspan="5">HAL Implementation Details</th>
1978           </tr>
1979           <tr class="entry_cont">
1980             <td class="entry_details" colspan="5">
1981               <p>For all capture request templates,<wbr/> this field must be set
1982 to AUTO.<wbr/>  AUTO is the only mode that must supported;
1983 OFF,<wbr/> 50HZ,<wbr/> 60HZ are all optional.<wbr/></p>
1984 <p>If manual exposure control is enabled (by setting
1985 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> to OFF),<wbr/>
1986 then the exposure values provided by the application must not be
1987 adjusted for antibanding.<wbr/></p>
1988             </td>
1989           </tr>
1990
1991           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1992            <!-- end of entry -->
1993
1994
1995           <tr class="entry" id="controls_android.control.aeExposureCompensation">
1996             <td class="entry_name
1997              " rowspan="3">
1998               android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation
1999             </td>
2000             <td class="entry_type">
2001                 <span class="entry_type_name">int32</span>
2002
2003               <span class="entry_type_visibility"> [public]</span>
2004
2005
2006               <span class="entry_type_hwlevel">[legacy] </span>
2007
2008
2009
2010
2011             </td> <!-- entry_type -->
2012
2013             <td class="entry_description">
2014               <p>Adjustment to auto-exposure (AE) target image
2015 brightness.<wbr/></p>
2016             </td>
2017
2018             <td class="entry_units">
2019               Compensation steps
2020             </td>
2021
2022             <td class="entry_range">
2023               <p><a href="#static_android.control.aeCompensationRange">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range</a></p>
2024             </td>
2025
2026             <td class="entry_tags">
2027               <ul class="entry_tags">
2028                   <li><a href="#tag_BC">BC</a></li>
2029               </ul>
2030             </td>
2031
2032           </tr>
2033           <tr class="entries_header">
2034             <th class="th_details" colspan="5">Details</th>
2035           </tr>
2036           <tr class="entry_cont">
2037             <td class="entry_details" colspan="5">
2038               <p>The adjustment is measured as a count of steps,<wbr/> with the
2039 step size defined by <a href="#static_android.control.aeCompensationStep">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step</a> and the
2040 allowed range by <a href="#static_android.control.aeCompensationRange">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range</a>.<wbr/></p>
2041 <p>For example,<wbr/> if the exposure value (EV) step is 0.<wbr/>333,<wbr/> '6'
2042 will mean an exposure compensation of +2 EV; -3 will mean an
2043 exposure compensation of -1 EV.<wbr/> One EV represents a doubling
2044 of image brightness.<wbr/> Note that this control will only be
2045 effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>!=</code> OFF.<wbr/> This control
2046 will take effect even when <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> <code>== true</code>.<wbr/></p>
2047 <p>In the event of exposure compensation value being changed,<wbr/> camera device
2048 may take several frames to reach the newly requested exposure target.<wbr/>
2049 During that time,<wbr/> <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> field will be in the SEARCHING
2050 state.<wbr/> Once the new exposure target is reached,<wbr/> <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> will
2051 change from SEARCHING to either CONVERGED,<wbr/> LOCKED (if AE lock is enabled),<wbr/> or
2052 FLASH_<wbr/>REQUIRED (if the scene is too dark for still capture).<wbr/></p>
2053             </td>
2054           </tr>
2055
2056
2057           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2058            <!-- end of entry -->
2059
2060
2061           <tr class="entry" id="controls_android.control.aeLock">
2062             <td class="entry_name
2063              " rowspan="3">
2064               android.<wbr/>control.<wbr/>ae<wbr/>Lock
2065             </td>
2066             <td class="entry_type">
2067                 <span class="entry_type_name entry_type_name_enum">byte</span>
2068
2069               <span class="entry_type_visibility"> [public as boolean]</span>
2070
2071
2072               <span class="entry_type_hwlevel">[legacy] </span>
2073
2074
2075
2076                 <ul class="entry_type_enum">
2077                   <li>
2078                     <span class="entry_type_enum_name">OFF</span>
2079                     <span class="entry_type_enum_notes"><p>Auto-exposure lock is disabled; the AE algorithm
2080 is free to update its parameters.<wbr/></p></span>
2081                   </li>
2082                   <li>
2083                     <span class="entry_type_enum_name">ON</span>
2084                     <span class="entry_type_enum_notes"><p>Auto-exposure lock is enabled; the AE algorithm
2085 must not update the exposure and sensitivity parameters
2086 while the lock is active.<wbr/></p>
2087 <p><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a> setting changes
2088 will still take effect while auto-exposure is locked.<wbr/></p>
2089 <p>Some rare LEGACY devices may not support
2090 this,<wbr/> in which case the value will always be overridden to OFF.<wbr/></p></span>
2091                   </li>
2092                 </ul>
2093
2094             </td> <!-- entry_type -->
2095
2096             <td class="entry_description">
2097               <p>Whether auto-exposure (AE) is currently locked to its latest
2098 calculated values.<wbr/></p>
2099             </td>
2100
2101             <td class="entry_units">
2102             </td>
2103
2104             <td class="entry_range">
2105             </td>
2106
2107             <td class="entry_tags">
2108               <ul class="entry_tags">
2109                   <li><a href="#tag_BC">BC</a></li>
2110               </ul>
2111             </td>
2112
2113           </tr>
2114           <tr class="entries_header">
2115             <th class="th_details" colspan="5">Details</th>
2116           </tr>
2117           <tr class="entry_cont">
2118             <td class="entry_details" colspan="5">
2119               <p>When set to <code>true</code> (ON),<wbr/> the AE algorithm is locked to its latest parameters,<wbr/>
2120 and will not change exposure settings until the lock is set to <code>false</code> (OFF).<wbr/></p>
2121 <p>Note that even when AE is locked,<wbr/> the flash may be fired if
2122 the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is ON_<wbr/>AUTO_<wbr/>FLASH /<wbr/>
2123 ON_<wbr/>ALWAYS_<wbr/>FLASH /<wbr/> ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE.<wbr/></p>
2124 <p>When <a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a> is changed,<wbr/> even if the AE lock
2125 is ON,<wbr/> the camera device will still adjust its exposure value.<wbr/></p>
2126 <p>If AE precapture is triggered (see <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>)
2127 when AE is already locked,<wbr/> the camera device will not change the exposure time
2128 (<a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>) and sensitivity (<a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>)
2129 parameters.<wbr/> The flash may be fired if the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>
2130 is ON_<wbr/>AUTO_<wbr/>FLASH/<wbr/>ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE and the scene is too dark.<wbr/> If the
2131 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is ON_<wbr/>ALWAYS_<wbr/>FLASH,<wbr/> the scene may become overexposed.<wbr/></p>
2132 <p>Since the camera device has a pipeline of in-flight requests,<wbr/> the settings that
2133 get locked do not necessarily correspond to the settings that were present in the
2134 latest capture result received from the camera device,<wbr/> since additional captures
2135 and AE updates may have occurred even before the result was sent out.<wbr/> If an
2136 application is switching between automatic and manual control and wishes to eliminate
2137 any flicker during the switch,<wbr/> the following procedure is recommended:</p>
2138 <ol>
2139 <li>Starting in auto-AE mode:</li>
2140 <li>Lock AE</li>
2141 <li>Wait for the first result to be output that has the AE locked</li>
2142 <li>Copy exposure settings from that result into a request,<wbr/> set the request to manual AE</li>
2143 <li>Submit the capture request,<wbr/> proceed to run manual AE as desired.<wbr/></li>
2144 </ol>
2145 <p>See <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> for AE lock related state transition details.<wbr/></p>
2146             </td>
2147           </tr>
2148
2149
2150           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2151            <!-- end of entry -->
2152
2153
2154           <tr class="entry" id="controls_android.control.aeMode">
2155             <td class="entry_name
2156              " rowspan="3">
2157               android.<wbr/>control.<wbr/>ae<wbr/>Mode
2158             </td>
2159             <td class="entry_type">
2160                 <span class="entry_type_name entry_type_name_enum">byte</span>
2161
2162               <span class="entry_type_visibility"> [public]</span>
2163
2164
2165               <span class="entry_type_hwlevel">[legacy] </span>
2166
2167
2168
2169                 <ul class="entry_type_enum">
2170                   <li>
2171                     <span class="entry_type_enum_name">OFF</span>
2172                     <span class="entry_type_enum_notes"><p>The camera device's autoexposure routine is disabled.<wbr/></p>
2173 <p>The application-selected <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
2174 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a> and
2175 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> are used by the camera
2176 device,<wbr/> along with android.<wbr/>flash.<wbr/>* fields,<wbr/> if there's
2177 a flash unit for this camera device.<wbr/></p>
2178 <p>LEGACY devices do not support the OFF mode and will
2179 override attempts to use this value to ON.<wbr/></p></span>
2180                   </li>
2181                   <li>
2182                     <span class="entry_type_enum_name">ON</span>
2183                     <span class="entry_type_enum_notes"><p>The camera device's autoexposure routine is active,<wbr/>
2184 with no flash control.<wbr/></p>
2185 <p>The application's values for
2186 <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
2187 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> and
2188 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> are ignored.<wbr/> The
2189 application has control over the various
2190 android.<wbr/>flash.<wbr/>* fields.<wbr/></p></span>
2191                   </li>
2192                   <li>
2193                     <span class="entry_type_enum_name">ON_AUTO_FLASH</span>
2194                     <span class="entry_type_enum_notes"><p>Like ON,<wbr/> except that the camera device also controls
2195 the camera's flash unit,<wbr/> firing it in low-light
2196 conditions.<wbr/></p>
2197 <p>The flash may be fired during a precapture sequence
2198 (triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>) and
2199 may be fired for captures for which the
2200 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> field is set to
2201 STILL_<wbr/>CAPTURE</p></span>
2202                   </li>
2203                   <li>
2204                     <span class="entry_type_enum_name">ON_ALWAYS_FLASH</span>
2205                     <span class="entry_type_enum_notes"><p>Like ON,<wbr/> except that the camera device also controls
2206 the camera's flash unit,<wbr/> always firing it for still
2207 captures.<wbr/></p>
2208 <p>The flash may be fired during a precapture sequence
2209 (triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>) and
2210 will always be fired for captures for which the
2211 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> field is set to
2212 STILL_<wbr/>CAPTURE</p></span>
2213                   </li>
2214                   <li>
2215                     <span class="entry_type_enum_name">ON_AUTO_FLASH_REDEYE</span>
2216                     <span class="entry_type_enum_notes"><p>Like ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/> but with automatic red eye
2217 reduction.<wbr/></p>
2218 <p>If deemed necessary by the camera device,<wbr/> a red eye
2219 reduction flash will fire during the precapture
2220 sequence.<wbr/></p></span>
2221                   </li>
2222                 </ul>
2223
2224             </td> <!-- entry_type -->
2225
2226             <td class="entry_description">
2227               <p>The desired mode for the camera device's
2228 auto-exposure routine.<wbr/></p>
2229             </td>
2230
2231             <td class="entry_units">
2232             </td>
2233
2234             <td class="entry_range">
2235               <p><a href="#static_android.control.aeAvailableModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Modes</a></p>
2236             </td>
2237
2238             <td class="entry_tags">
2239               <ul class="entry_tags">
2240                   <li><a href="#tag_BC">BC</a></li>
2241               </ul>
2242             </td>
2243
2244           </tr>
2245           <tr class="entries_header">
2246             <th class="th_details" colspan="5">Details</th>
2247           </tr>
2248           <tr class="entry_cont">
2249             <td class="entry_details" colspan="5">
2250               <p>This control is only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is
2251 AUTO.<wbr/></p>
2252 <p>When set to any of the ON modes,<wbr/> the camera device's
2253 auto-exposure routine is enabled,<wbr/> overriding the
2254 application's selected exposure time,<wbr/> sensor sensitivity,<wbr/>
2255 and frame duration (<a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
2256 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> and
2257 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>).<wbr/> If one of the FLASH modes
2258 is selected,<wbr/> the camera device's flash unit controls are
2259 also overridden.<wbr/></p>
2260 <p>The FLASH modes are only available if the camera device
2261 has a flash unit (<a href="#static_android.flash.info.available">android.<wbr/>flash.<wbr/>info.<wbr/>available</a> is <code>true</code>).<wbr/></p>
2262 <p>If flash TORCH mode is desired,<wbr/> this field must be set to
2263 ON or OFF,<wbr/> and <a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> set to TORCH.<wbr/></p>
2264 <p>When set to any of the ON modes,<wbr/> the values chosen by the
2265 camera device auto-exposure routine for the overridden
2266 fields for a given capture will be available in its
2267 CaptureResult.<wbr/></p>
2268             </td>
2269           </tr>
2270
2271
2272           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2273            <!-- end of entry -->
2274
2275
2276           <tr class="entry" id="controls_android.control.aeRegions">
2277             <td class="entry_name
2278              " rowspan="5">
2279               android.<wbr/>control.<wbr/>ae<wbr/>Regions
2280             </td>
2281             <td class="entry_type">
2282                 <span class="entry_type_name">int32</span>
2283                 <span class="entry_type_container">x</span>
2284
2285                 <span class="entry_type_array">
2286                   5 x area_count
2287                 </span>
2288               <span class="entry_type_visibility"> [public as meteringRectangle]</span>
2289
2290
2291
2292
2293
2294
2295             </td> <!-- entry_type -->
2296
2297             <td class="entry_description">
2298               <p>List of metering areas to use for auto-exposure adjustment.<wbr/></p>
2299             </td>
2300
2301             <td class="entry_units">
2302               Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
2303             </td>
2304
2305             <td class="entry_range">
2306               <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
2307 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
2308             </td>
2309
2310             <td class="entry_tags">
2311               <ul class="entry_tags">
2312                   <li><a href="#tag_BC">BC</a></li>
2313               </ul>
2314             </td>
2315
2316           </tr>
2317           <tr class="entries_header">
2318             <th class="th_details" colspan="5">Details</th>
2319           </tr>
2320           <tr class="entry_cont">
2321             <td class="entry_details" colspan="5">
2322               <p>Not available if <a href="#static_android.control.maxRegionsAe">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae</a> is 0.<wbr/>
2323 Otherwise will always be present.<wbr/></p>
2324 <p>The maximum number of regions supported by the device is determined by the value
2325 of <a href="#static_android.control.maxRegionsAe">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae</a>.<wbr/></p>
2326 <p>The coordinate system is based on the active pixel array,<wbr/>
2327 with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
2328 (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
2329 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
2330 bottom-right pixel in the active pixel array.<wbr/></p>
2331 <p>The weight must be within <code>[0,<wbr/> 1000]</code>,<wbr/> and represents a weight
2332 for every pixel in the area.<wbr/> This means that a large metering area
2333 with the same weight as a smaller area will have more effect in
2334 the metering result.<wbr/> Metering areas can partially overlap and the
2335 camera device will add the weights in the overlap region.<wbr/></p>
2336 <p>The weights are relative to weights of other exposure metering regions,<wbr/> so if only one
2337 region is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with 0
2338 weight is ignored.<wbr/></p>
2339 <p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
2340 camera device.<wbr/></p>
2341 <p>If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> returned in
2342 capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
2343 region and output only the intersection rectangle as the metering region in the result
2344 metadata.<wbr/>  If the region is entirely outside the crop region,<wbr/> it will be ignored and
2345 not reported in the result metadata.<wbr/></p>
2346             </td>
2347           </tr>
2348
2349           <tr class="entries_header">
2350             <th class="th_details" colspan="5">HAL Implementation Details</th>
2351           </tr>
2352           <tr class="entry_cont">
2353             <td class="entry_details" colspan="5">
2354               <p>The HAL level representation of MeteringRectangle[] is a
2355 int[5 * area_<wbr/>count].<wbr/>
2356 Every five elements represent a metering region of
2357 (xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
2358 The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
2359 exclusive on xmax and ymax.<wbr/></p>
2360             </td>
2361           </tr>
2362
2363           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2364            <!-- end of entry -->
2365
2366
2367           <tr class="entry" id="controls_android.control.aeTargetFpsRange">
2368             <td class="entry_name
2369              " rowspan="3">
2370               android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range
2371             </td>
2372             <td class="entry_type">
2373                 <span class="entry_type_name">int32</span>
2374                 <span class="entry_type_container">x</span>
2375
2376                 <span class="entry_type_array">
2377                   2
2378                 </span>
2379               <span class="entry_type_visibility"> [public as rangeInt]</span>
2380
2381
2382               <span class="entry_type_hwlevel">[legacy] </span>
2383
2384
2385
2386
2387             </td> <!-- entry_type -->
2388
2389             <td class="entry_description">
2390               <p>Range over which the auto-exposure routine can
2391 adjust the capture frame rate to maintain good
2392 exposure.<wbr/></p>
2393             </td>
2394
2395             <td class="entry_units">
2396               Frames per second (FPS)
2397             </td>
2398
2399             <td class="entry_range">
2400               <p>Any of the entries in <a href="#static_android.control.aeAvailableTargetFpsRanges">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Target<wbr/>Fps<wbr/>Ranges</a></p>
2401             </td>
2402
2403             <td class="entry_tags">
2404               <ul class="entry_tags">
2405                   <li><a href="#tag_BC">BC</a></li>
2406               </ul>
2407             </td>
2408
2409           </tr>
2410           <tr class="entries_header">
2411             <th class="th_details" colspan="5">Details</th>
2412           </tr>
2413           <tr class="entry_cont">
2414             <td class="entry_details" colspan="5">
2415               <p>Only constrains auto-exposure (AE) algorithm,<wbr/> not
2416 manual control of <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a> and
2417 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>.<wbr/></p>
2418             </td>
2419           </tr>
2420
2421
2422           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2423            <!-- end of entry -->
2424
2425
2426           <tr class="entry" id="controls_android.control.aePrecaptureTrigger">
2427             <td class="entry_name
2428              " rowspan="3">
2429               android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger
2430             </td>
2431             <td class="entry_type">
2432                 <span class="entry_type_name entry_type_name_enum">byte</span>
2433
2434               <span class="entry_type_visibility"> [public]</span>
2435
2436
2437               <span class="entry_type_hwlevel">[limited] </span>
2438
2439
2440
2441                 <ul class="entry_type_enum">
2442                   <li>
2443                     <span class="entry_type_enum_name">IDLE</span>
2444                     <span class="entry_type_enum_notes"><p>The trigger is idle.<wbr/></p></span>
2445                   </li>
2446                   <li>
2447                     <span class="entry_type_enum_name">START</span>
2448                     <span class="entry_type_enum_notes"><p>The precapture metering sequence will be started
2449 by the camera device.<wbr/></p>
2450 <p>The exact effect of the precapture trigger depends on
2451 the current AE mode and state.<wbr/></p></span>
2452                   </li>
2453                 </ul>
2454
2455             </td> <!-- entry_type -->
2456
2457             <td class="entry_description">
2458               <p>Whether the camera device will trigger a precapture
2459 metering sequence when it processes this request.<wbr/></p>
2460             </td>
2461
2462             <td class="entry_units">
2463             </td>
2464
2465             <td class="entry_range">
2466             </td>
2467
2468             <td class="entry_tags">
2469               <ul class="entry_tags">
2470                   <li><a href="#tag_BC">BC</a></li>
2471               </ul>
2472             </td>
2473
2474           </tr>
2475           <tr class="entries_header">
2476             <th class="th_details" colspan="5">Details</th>
2477           </tr>
2478           <tr class="entry_cont">
2479             <td class="entry_details" colspan="5">
2480               <p>This entry is normally set to IDLE,<wbr/> or is not
2481 included at all in the request settings.<wbr/> When included and
2482 set to START,<wbr/> the camera device will trigger the autoexposure
2483 precapture metering sequence.<wbr/></p>
2484 <p>The precapture sequence should triggered before starting a
2485 high-quality still capture for final metering decisions to
2486 be made,<wbr/> and for firing pre-capture flash pulses to estimate
2487 scene brightness and required final capture flash power,<wbr/> when
2488 the flash is enabled.<wbr/></p>
2489 <p>Normally,<wbr/> this entry should be set to START for only a
2490 single request,<wbr/> and the application should wait until the
2491 sequence completes before starting a new one.<wbr/></p>
2492 <p>The exact effect of auto-exposure (AE) precapture trigger
2493 depends on the current AE mode and state; see
2494 <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> for AE precapture state transition
2495 details.<wbr/></p>
2496 <p>On LEGACY-level devices,<wbr/> the precapture trigger is not supported;
2497 capturing a high-resolution JPEG image will automatically trigger a
2498 precapture sequence before the high-resolution capture,<wbr/> including
2499 potentially firing a pre-capture flash.<wbr/></p>
2500             </td>
2501           </tr>
2502
2503
2504           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2505            <!-- end of entry -->
2506
2507
2508           <tr class="entry" id="controls_android.control.afMode">
2509             <td class="entry_name
2510              " rowspan="5">
2511               android.<wbr/>control.<wbr/>af<wbr/>Mode
2512             </td>
2513             <td class="entry_type">
2514                 <span class="entry_type_name entry_type_name_enum">byte</span>
2515
2516               <span class="entry_type_visibility"> [public]</span>
2517
2518
2519               <span class="entry_type_hwlevel">[legacy] </span>
2520
2521
2522
2523                 <ul class="entry_type_enum">
2524                   <li>
2525                     <span class="entry_type_enum_name">OFF</span>
2526                     <span class="entry_type_enum_notes"><p>The auto-focus routine does not control the lens;
2527 <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> is controlled by the
2528 application.<wbr/></p></span>
2529                   </li>
2530                   <li>
2531                     <span class="entry_type_enum_name">AUTO</span>
2532                     <span class="entry_type_enum_notes"><p>Basic automatic focus mode.<wbr/></p>
2533 <p>In this mode,<wbr/> the lens does not move unless
2534 the autofocus trigger action is called.<wbr/> When that trigger
2535 is activated,<wbr/> AF will transition to ACTIVE_<wbr/>SCAN,<wbr/> then to
2536 the outcome of the scan (FOCUSED or NOT_<wbr/>FOCUSED).<wbr/></p>
2537 <p>Always supported if lens is not fixed focus.<wbr/></p>
2538 <p>Use <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> to determine if lens
2539 is fixed-focus.<wbr/></p>
2540 <p>Triggering AF_<wbr/>CANCEL resets the lens position to default,<wbr/>
2541 and sets the AF state to INACTIVE.<wbr/></p></span>
2542                   </li>
2543                   <li>
2544                     <span class="entry_type_enum_name">MACRO</span>
2545                     <span class="entry_type_enum_notes"><p>Close-up focusing mode.<wbr/></p>
2546 <p>In this mode,<wbr/> the lens does not move unless the
2547 autofocus trigger action is called.<wbr/> When that trigger is
2548 activated,<wbr/> AF will transition to ACTIVE_<wbr/>SCAN,<wbr/> then to
2549 the outcome of the scan (FOCUSED or NOT_<wbr/>FOCUSED).<wbr/> This
2550 mode is optimized for focusing on objects very close to
2551 the camera.<wbr/></p>
2552 <p>When that trigger is activated,<wbr/> AF will transition to
2553 ACTIVE_<wbr/>SCAN,<wbr/> then to the outcome of the scan (FOCUSED or
2554 NOT_<wbr/>FOCUSED).<wbr/> Triggering cancel AF resets the lens
2555 position to default,<wbr/> and sets the AF state to
2556 INACTIVE.<wbr/></p></span>
2557                   </li>
2558                   <li>
2559                     <span class="entry_type_enum_name">CONTINUOUS_VIDEO</span>
2560                     <span class="entry_type_enum_notes"><p>In this mode,<wbr/> the AF algorithm modifies the lens
2561 position continually to attempt to provide a
2562 constantly-in-focus image stream.<wbr/></p>
2563 <p>The focusing behavior should be suitable for good quality
2564 video recording; typically this means slower focus
2565 movement and no overshoots.<wbr/> When the AF trigger is not
2566 involved,<wbr/> the AF algorithm should start in INACTIVE state,<wbr/>
2567 and then transition into PASSIVE_<wbr/>SCAN and PASSIVE_<wbr/>FOCUSED
2568 states as appropriate.<wbr/> When the AF trigger is activated,<wbr/>
2569 the algorithm should immediately transition into
2570 AF_<wbr/>FOCUSED or AF_<wbr/>NOT_<wbr/>FOCUSED as appropriate,<wbr/> and lock the
2571 lens position until a cancel AF trigger is received.<wbr/></p>
2572 <p>Once cancel is received,<wbr/> the algorithm should transition
2573 back to INACTIVE and resume passive scan.<wbr/> Note that this
2574 behavior is not identical to CONTINUOUS_<wbr/>PICTURE,<wbr/> since an
2575 ongoing PASSIVE_<wbr/>SCAN must immediately be
2576 canceled.<wbr/></p></span>
2577                   </li>
2578                   <li>
2579                     <span class="entry_type_enum_name">CONTINUOUS_PICTURE</span>
2580                     <span class="entry_type_enum_notes"><p>In this mode,<wbr/> the AF algorithm modifies the lens
2581 position continually to attempt to provide a
2582 constantly-in-focus image stream.<wbr/></p>
2583 <p>The focusing behavior should be suitable for still image
2584 capture; typically this means focusing as fast as
2585 possible.<wbr/> When the AF trigger is not involved,<wbr/> the AF
2586 algorithm should start in INACTIVE state,<wbr/> and then
2587 transition into PASSIVE_<wbr/>SCAN and PASSIVE_<wbr/>FOCUSED states as
2588 appropriate as it attempts to maintain focus.<wbr/> When the AF
2589 trigger is activated,<wbr/> the algorithm should finish its
2590 PASSIVE_<wbr/>SCAN if active,<wbr/> and then transition into
2591 AF_<wbr/>FOCUSED or AF_<wbr/>NOT_<wbr/>FOCUSED as appropriate,<wbr/> and lock the
2592 lens position until a cancel AF trigger is received.<wbr/></p>
2593 <p>When the AF cancel trigger is activated,<wbr/> the algorithm
2594 should transition back to INACTIVE and then act as if it
2595 has just been started.<wbr/></p></span>
2596                   </li>
2597                   <li>
2598                     <span class="entry_type_enum_name">EDOF</span>
2599                     <span class="entry_type_enum_notes"><p>Extended depth of field (digital focus) mode.<wbr/></p>
2600 <p>The camera device will produce images with an extended
2601 depth of field automatically; no special focusing
2602 operations need to be done before taking a picture.<wbr/></p>
2603 <p>AF triggers are ignored,<wbr/> and the AF state will always be
2604 INACTIVE.<wbr/></p></span>
2605                   </li>
2606                 </ul>
2607
2608             </td> <!-- entry_type -->
2609
2610             <td class="entry_description">
2611               <p>Whether auto-focus (AF) is currently enabled,<wbr/> and what
2612 mode it is set to.<wbr/></p>
2613             </td>
2614
2615             <td class="entry_units">
2616             </td>
2617
2618             <td class="entry_range">
2619               <p><a href="#static_android.control.afAvailableModes">android.<wbr/>control.<wbr/>af<wbr/>Available<wbr/>Modes</a></p>
2620             </td>
2621
2622             <td class="entry_tags">
2623               <ul class="entry_tags">
2624                   <li><a href="#tag_BC">BC</a></li>
2625               </ul>
2626             </td>
2627
2628           </tr>
2629           <tr class="entries_header">
2630             <th class="th_details" colspan="5">Details</th>
2631           </tr>
2632           <tr class="entry_cont">
2633             <td class="entry_details" colspan="5">
2634               <p>Only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> = AUTO and the lens is not fixed focus
2635 (i.<wbr/>e.<wbr/> <code><a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> &gt; 0</code>).<wbr/></p>
2636 <p>If the lens is controlled by the camera device auto-focus algorithm,<wbr/>
2637 the camera device will report the current AF status in <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a>
2638 in result metadata.<wbr/></p>
2639             </td>
2640           </tr>
2641
2642           <tr class="entries_header">
2643             <th class="th_details" colspan="5">HAL Implementation Details</th>
2644           </tr>
2645           <tr class="entry_cont">
2646             <td class="entry_details" colspan="5">
2647               <p>When afMode is AUTO or MACRO,<wbr/> the lens must not move until an AF trigger is sent in a
2648 request (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a> <code>==</code> START).<wbr/> After an AF trigger,<wbr/> the afState will end
2649 up with either FOCUSED_<wbr/>LOCKED or NOT_<wbr/>FOCUSED_<wbr/>LOCKED state (see
2650 <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a> for detailed state transitions),<wbr/> which indicates that the lens is
2651 locked and will not move.<wbr/> If camera movement (e.<wbr/>g.<wbr/> tilting camera) causes the lens to move
2652 after the lens is locked,<wbr/> the HAL must compensate this movement appropriately such that
2653 the same focal plane remains in focus.<wbr/></p>
2654 <p>When afMode is one of the continuous auto focus modes,<wbr/> the HAL is free to start a AF
2655 scan whenever it's not locked.<wbr/> When the lens is locked after an AF trigger
2656 (see <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a> for detailed state transitions),<wbr/> the HAL should maintain the
2657 same lock behavior as above.<wbr/></p>
2658 <p>When afMode is OFF,<wbr/> the application controls focus manually.<wbr/> The accuracy of the
2659 focus distance control depends on the <a href="#static_android.lens.info.focusDistanceCalibration">android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration</a>.<wbr/>
2660 However,<wbr/> the lens must not move regardless of the camera movement for any focus distance
2661 manual control.<wbr/></p>
2662 <p>To put this in concrete terms,<wbr/> if the camera has lens elements which may move based on
2663 camera orientation or motion (e.<wbr/>g.<wbr/> due to gravity),<wbr/> then the HAL must drive the lens to
2664 remain in a fixed position invariant to the camera's orientation or motion,<wbr/> for example,<wbr/>
2665 by using accelerometer measurements in the lens control logic.<wbr/> This is a typical issue
2666 that will arise on camera modules with open-loop VCMs.<wbr/></p>
2667             </td>
2668           </tr>
2669
2670           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2671            <!-- end of entry -->
2672
2673
2674           <tr class="entry" id="controls_android.control.afRegions">
2675             <td class="entry_name
2676              " rowspan="5">
2677               android.<wbr/>control.<wbr/>af<wbr/>Regions
2678             </td>
2679             <td class="entry_type">
2680                 <span class="entry_type_name">int32</span>
2681                 <span class="entry_type_container">x</span>
2682
2683                 <span class="entry_type_array">
2684                   5 x area_count
2685                 </span>
2686               <span class="entry_type_visibility"> [public as meteringRectangle]</span>
2687
2688
2689
2690
2691
2692
2693             </td> <!-- entry_type -->
2694
2695             <td class="entry_description">
2696               <p>List of metering areas to use for auto-focus.<wbr/></p>
2697             </td>
2698
2699             <td class="entry_units">
2700               Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
2701             </td>
2702
2703             <td class="entry_range">
2704               <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
2705 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
2706             </td>
2707
2708             <td class="entry_tags">
2709               <ul class="entry_tags">
2710                   <li><a href="#tag_BC">BC</a></li>
2711               </ul>
2712             </td>
2713
2714           </tr>
2715           <tr class="entries_header">
2716             <th class="th_details" colspan="5">Details</th>
2717           </tr>
2718           <tr class="entry_cont">
2719             <td class="entry_details" colspan="5">
2720               <p>Not available if <a href="#static_android.control.maxRegionsAf">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af</a> is 0.<wbr/>
2721 Otherwise will always be present.<wbr/></p>
2722 <p>The maximum number of focus areas supported by the device is determined by the value
2723 of <a href="#static_android.control.maxRegionsAf">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af</a>.<wbr/></p>
2724 <p>The coordinate system is based on the active pixel array,<wbr/>
2725 with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
2726 (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
2727 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
2728 bottom-right pixel in the active pixel array.<wbr/></p>
2729 <p>The weight must be within <code>[0,<wbr/> 1000]</code>,<wbr/> and represents a weight
2730 for every pixel in the area.<wbr/> This means that a large metering area
2731 with the same weight as a smaller area will have more effect in
2732 the metering result.<wbr/> Metering areas can partially overlap and the
2733 camera device will add the weights in the overlap region.<wbr/></p>
2734 <p>The weights are relative to weights of other metering regions,<wbr/> so if only one region
2735 is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with 0 weight is
2736 ignored.<wbr/></p>
2737 <p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
2738 camera device.<wbr/></p>
2739 <p>If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> returned in
2740 capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
2741 region and output only the intersection rectangle as the metering region in the result
2742 metadata.<wbr/> If the region is entirely outside the crop region,<wbr/> it will be ignored and
2743 not reported in the result metadata.<wbr/></p>
2744             </td>
2745           </tr>
2746
2747           <tr class="entries_header">
2748             <th class="th_details" colspan="5">HAL Implementation Details</th>
2749           </tr>
2750           <tr class="entry_cont">
2751             <td class="entry_details" colspan="5">
2752               <p>The HAL level representation of MeteringRectangle[] is a
2753 int[5 * area_<wbr/>count].<wbr/>
2754 Every five elements represent a metering region of
2755 (xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
2756 The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
2757 exclusive on xmax and ymax.<wbr/></p>
2758             </td>
2759           </tr>
2760
2761           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2762            <!-- end of entry -->
2763
2764
2765           <tr class="entry" id="controls_android.control.afTrigger">
2766             <td class="entry_name
2767              " rowspan="3">
2768               android.<wbr/>control.<wbr/>af<wbr/>Trigger
2769             </td>
2770             <td class="entry_type">
2771                 <span class="entry_type_name entry_type_name_enum">byte</span>
2772
2773               <span class="entry_type_visibility"> [public]</span>
2774
2775
2776               <span class="entry_type_hwlevel">[legacy] </span>
2777
2778
2779
2780                 <ul class="entry_type_enum">
2781                   <li>
2782                     <span class="entry_type_enum_name">IDLE</span>
2783                     <span class="entry_type_enum_notes"><p>The trigger is idle.<wbr/></p></span>
2784                   </li>
2785                   <li>
2786                     <span class="entry_type_enum_name">START</span>
2787                     <span class="entry_type_enum_notes"><p>Autofocus will trigger now.<wbr/></p></span>
2788                   </li>
2789                   <li>
2790                     <span class="entry_type_enum_name">CANCEL</span>
2791                     <span class="entry_type_enum_notes"><p>Autofocus will return to its initial
2792 state,<wbr/> and cancel any currently active trigger.<wbr/></p></span>
2793                   </li>
2794                 </ul>
2795
2796             </td> <!-- entry_type -->
2797
2798             <td class="entry_description">
2799               <p>Whether the camera device will trigger autofocus for this request.<wbr/></p>
2800             </td>
2801
2802             <td class="entry_units">
2803             </td>
2804
2805             <td class="entry_range">
2806             </td>
2807
2808             <td class="entry_tags">
2809               <ul class="entry_tags">
2810                   <li><a href="#tag_BC">BC</a></li>
2811               </ul>
2812             </td>
2813
2814           </tr>
2815           <tr class="entries_header">
2816             <th class="th_details" colspan="5">Details</th>
2817           </tr>
2818           <tr class="entry_cont">
2819             <td class="entry_details" colspan="5">
2820               <p>This entry is normally set to IDLE,<wbr/> or is not
2821 included at all in the request settings.<wbr/></p>
2822 <p>When included and set to START,<wbr/> the camera device will trigger the
2823 autofocus algorithm.<wbr/> If autofocus is disabled,<wbr/> this trigger has no effect.<wbr/></p>
2824 <p>When set to CANCEL,<wbr/> the camera device will cancel any active trigger,<wbr/>
2825 and return to its initial AF state.<wbr/></p>
2826 <p>Generally,<wbr/> applications should set this entry to START or CANCEL for only a
2827 single capture,<wbr/> and then return it to IDLE (or not set at all).<wbr/> Specifying
2828 START for multiple captures in a row means restarting the AF operation over
2829 and over again.<wbr/></p>
2830 <p>See <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a> for what the trigger means for each AF mode.<wbr/></p>
2831             </td>
2832           </tr>
2833
2834
2835           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2836            <!-- end of entry -->
2837
2838
2839           <tr class="entry" id="controls_android.control.awbLock">
2840             <td class="entry_name
2841              " rowspan="3">
2842               android.<wbr/>control.<wbr/>awb<wbr/>Lock
2843             </td>
2844             <td class="entry_type">
2845                 <span class="entry_type_name entry_type_name_enum">byte</span>
2846
2847               <span class="entry_type_visibility"> [public as boolean]</span>
2848
2849
2850               <span class="entry_type_hwlevel">[legacy] </span>
2851
2852
2853
2854                 <ul class="entry_type_enum">
2855                   <li>
2856                     <span class="entry_type_enum_name">OFF</span>
2857                     <span class="entry_type_enum_notes"><p>Auto-white balance lock is disabled; the AWB
2858 algorithm is free to update its parameters if in AUTO
2859 mode.<wbr/></p></span>
2860                   </li>
2861                   <li>
2862                     <span class="entry_type_enum_name">ON</span>
2863                     <span class="entry_type_enum_notes"><p>Auto-white balance lock is enabled; the AWB
2864 algorithm will not update its parameters while the lock
2865 is active.<wbr/></p></span>
2866                   </li>
2867                 </ul>
2868
2869             </td> <!-- entry_type -->
2870
2871             <td class="entry_description">
2872               <p>Whether auto-white balance (AWB) is currently locked to its
2873 latest calculated values.<wbr/></p>
2874             </td>
2875
2876             <td class="entry_units">
2877             </td>
2878
2879             <td class="entry_range">
2880             </td>
2881
2882             <td class="entry_tags">
2883               <ul class="entry_tags">
2884                   <li><a href="#tag_BC">BC</a></li>
2885               </ul>
2886             </td>
2887
2888           </tr>
2889           <tr class="entries_header">
2890             <th class="th_details" colspan="5">Details</th>
2891           </tr>
2892           <tr class="entry_cont">
2893             <td class="entry_details" colspan="5">
2894               <p>When set to <code>true</code> (ON),<wbr/> the AWB algorithm is locked to its latest parameters,<wbr/>
2895 and will not change color balance settings until the lock is set to <code>false</code> (OFF).<wbr/></p>
2896 <p>Since the camera device has a pipeline of in-flight requests,<wbr/> the settings that
2897 get locked do not necessarily correspond to the settings that were present in the
2898 latest capture result received from the camera device,<wbr/> since additional captures
2899 and AWB updates may have occurred even before the result was sent out.<wbr/> If an
2900 application is switching between automatic and manual control and wishes to eliminate
2901 any flicker during the switch,<wbr/> the following procedure is recommended:</p>
2902 <ol>
2903 <li>Starting in auto-AWB mode:</li>
2904 <li>Lock AWB</li>
2905 <li>Wait for the first result to be output that has the AWB locked</li>
2906 <li>Copy AWB settings from that result into a request,<wbr/> set the request to manual AWB</li>
2907 <li>Submit the capture request,<wbr/> proceed to run manual AWB as desired.<wbr/></li>
2908 </ol>
2909 <p>Note that AWB lock is only meaningful when
2910 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> is in the AUTO mode; in other modes,<wbr/>
2911 AWB is already fixed to a specific setting.<wbr/></p>
2912 <p>Some LEGACY devices may not support ON; the value is then overridden to OFF.<wbr/></p>
2913             </td>
2914           </tr>
2915
2916
2917           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2918            <!-- end of entry -->
2919
2920
2921           <tr class="entry" id="controls_android.control.awbMode">
2922             <td class="entry_name
2923              " rowspan="3">
2924               android.<wbr/>control.<wbr/>awb<wbr/>Mode
2925             </td>
2926             <td class="entry_type">
2927                 <span class="entry_type_name entry_type_name_enum">byte</span>
2928
2929               <span class="entry_type_visibility"> [public]</span>
2930
2931
2932               <span class="entry_type_hwlevel">[legacy] </span>
2933
2934
2935
2936                 <ul class="entry_type_enum">
2937                   <li>
2938                     <span class="entry_type_enum_name">OFF</span>
2939                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled.<wbr/></p>
2940 <p>The application-selected color transform matrix
2941 (<a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>) and gains
2942 (<a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a>) are used by the camera
2943 device for manual white balance control.<wbr/></p></span>
2944                   </li>
2945                   <li>
2946                     <span class="entry_type_enum_name">AUTO</span>
2947                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is active.<wbr/></p>
2948 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
2949 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
2950 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
2951 values used by the camera device for the transform and gains
2952 will be available in the capture result for this request.<wbr/></p></span>
2953                   </li>
2954                   <li>
2955                     <span class="entry_type_enum_name">INCANDESCENT</span>
2956                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
2957 the camera device uses incandescent light as the assumed scene
2958 illumination for white balance.<wbr/></p>
2959 <p>While the exact white balance transforms are up to the
2960 camera device,<wbr/> they will approximately match the CIE
2961 standard illuminant A.<wbr/></p>
2962 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
2963 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
2964 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
2965 values used by the camera device for the transform and gains
2966 will be available in the capture result for this request.<wbr/></p></span>
2967                   </li>
2968                   <li>
2969                     <span class="entry_type_enum_name">FLUORESCENT</span>
2970                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
2971 the camera device uses fluorescent light as the assumed scene
2972 illumination for white balance.<wbr/></p>
2973 <p>While the exact white balance transforms are up to the
2974 camera device,<wbr/> they will approximately match the CIE
2975 standard illuminant F2.<wbr/></p>
2976 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
2977 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
2978 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
2979 values used by the camera device for the transform and gains
2980 will be available in the capture result for this request.<wbr/></p></span>
2981                   </li>
2982                   <li>
2983                     <span class="entry_type_enum_name">WARM_FLUORESCENT</span>
2984                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
2985 the camera device uses warm fluorescent light as the assumed scene
2986 illumination for white balance.<wbr/></p>
2987 <p>While the exact white balance transforms are up to the
2988 camera device,<wbr/> they will approximately match the CIE
2989 standard illuminant F4.<wbr/></p>
2990 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
2991 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
2992 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
2993 values used by the camera device for the transform and gains
2994 will be available in the capture result for this request.<wbr/></p></span>
2995                   </li>
2996                   <li>
2997                     <span class="entry_type_enum_name">DAYLIGHT</span>
2998                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
2999 the camera device uses daylight light as the assumed scene
3000 illumination for white balance.<wbr/></p>
3001 <p>While the exact white balance transforms are up to the
3002 camera device,<wbr/> they will approximately match the CIE
3003 standard illuminant D65.<wbr/></p>
3004 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
3005 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
3006 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
3007 values used by the camera device for the transform and gains
3008 will be available in the capture result for this request.<wbr/></p></span>
3009                   </li>
3010                   <li>
3011                     <span class="entry_type_enum_name">CLOUDY_DAYLIGHT</span>
3012                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
3013 the camera device uses cloudy daylight light as the assumed scene
3014 illumination for white balance.<wbr/></p>
3015 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
3016 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
3017 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
3018 values used by the camera device for the transform and gains
3019 will be available in the capture result for this request.<wbr/></p></span>
3020                   </li>
3021                   <li>
3022                     <span class="entry_type_enum_name">TWILIGHT</span>
3023                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
3024 the camera device uses twilight light as the assumed scene
3025 illumination for white balance.<wbr/></p>
3026 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
3027 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
3028 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
3029 values used by the camera device for the transform and gains
3030 will be available in the capture result for this request.<wbr/></p></span>
3031                   </li>
3032                   <li>
3033                     <span class="entry_type_enum_name">SHADE</span>
3034                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
3035 the camera device uses shade light as the assumed scene
3036 illumination for white balance.<wbr/></p>
3037 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
3038 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
3039 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
3040 values used by the camera device for the transform and gains
3041 will be available in the capture result for this request.<wbr/></p></span>
3042                   </li>
3043                 </ul>
3044
3045             </td> <!-- entry_type -->
3046
3047             <td class="entry_description">
3048               <p>Whether auto-white balance (AWB) is currently setting the color
3049 transform fields,<wbr/> and what its illumination target
3050 is.<wbr/></p>
3051             </td>
3052
3053             <td class="entry_units">
3054             </td>
3055
3056             <td class="entry_range">
3057               <p><a href="#static_android.control.awbAvailableModes">android.<wbr/>control.<wbr/>awb<wbr/>Available<wbr/>Modes</a></p>
3058             </td>
3059
3060             <td class="entry_tags">
3061               <ul class="entry_tags">
3062                   <li><a href="#tag_BC">BC</a></li>
3063               </ul>
3064             </td>
3065
3066           </tr>
3067           <tr class="entries_header">
3068             <th class="th_details" colspan="5">Details</th>
3069           </tr>
3070           <tr class="entry_cont">
3071             <td class="entry_details" colspan="5">
3072               <p>This control is only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is AUTO.<wbr/></p>
3073 <p>When set to the ON mode,<wbr/> the camera device's auto-white balance
3074 routine is enabled,<wbr/> overriding the application's selected
3075 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>,<wbr/> <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
3076 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a>.<wbr/></p>
3077 <p>When set to the OFF mode,<wbr/> the camera device's auto-white balance
3078 routine is disabled.<wbr/> The application manually controls the white
3079 balance by <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>,<wbr/> <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a>
3080 and <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a>.<wbr/></p>
3081 <p>When set to any other modes,<wbr/> the camera device's auto-white
3082 balance routine is disabled.<wbr/> The camera device uses each
3083 particular illumination target for white balance
3084 adjustment.<wbr/> The application's values for
3085 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>,<wbr/>
3086 <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
3087 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> are ignored.<wbr/></p>
3088             </td>
3089           </tr>
3090
3091
3092           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3093            <!-- end of entry -->
3094
3095
3096           <tr class="entry" id="controls_android.control.awbRegions">
3097             <td class="entry_name
3098              " rowspan="5">
3099               android.<wbr/>control.<wbr/>awb<wbr/>Regions
3100             </td>
3101             <td class="entry_type">
3102                 <span class="entry_type_name">int32</span>
3103                 <span class="entry_type_container">x</span>
3104
3105                 <span class="entry_type_array">
3106                   5 x area_count
3107                 </span>
3108               <span class="entry_type_visibility"> [public as meteringRectangle]</span>
3109
3110
3111
3112
3113
3114
3115             </td> <!-- entry_type -->
3116
3117             <td class="entry_description">
3118               <p>List of metering areas to use for auto-white-balance illuminant
3119 estimation.<wbr/></p>
3120             </td>
3121
3122             <td class="entry_units">
3123               Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
3124             </td>
3125
3126             <td class="entry_range">
3127               <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
3128 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
3129             </td>
3130
3131             <td class="entry_tags">
3132               <ul class="entry_tags">
3133                   <li><a href="#tag_BC">BC</a></li>
3134               </ul>
3135             </td>
3136
3137           </tr>
3138           <tr class="entries_header">
3139             <th class="th_details" colspan="5">Details</th>
3140           </tr>
3141           <tr class="entry_cont">
3142             <td class="entry_details" colspan="5">
3143               <p>Not available if <a href="#static_android.control.maxRegionsAwb">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb</a> is 0.<wbr/>
3144 Otherwise will always be present.<wbr/></p>
3145 <p>The maximum number of regions supported by the device is determined by the value
3146 of <a href="#static_android.control.maxRegionsAwb">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb</a>.<wbr/></p>
3147 <p>The coordinate system is based on the active pixel array,<wbr/>
3148 with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
3149 (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
3150 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
3151 bottom-right pixel in the active pixel array.<wbr/></p>
3152 <p>The weight must range from 0 to 1000,<wbr/> and represents a weight
3153 for every pixel in the area.<wbr/> This means that a large metering area
3154 with the same weight as a smaller area will have more effect in
3155 the metering result.<wbr/> Metering areas can partially overlap and the
3156 camera device will add the weights in the overlap region.<wbr/></p>
3157 <p>The weights are relative to weights of other white balance metering regions,<wbr/> so if
3158 only one region is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with
3159 0 weight is ignored.<wbr/></p>
3160 <p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
3161 camera device.<wbr/></p>
3162 <p>If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> returned in
3163 capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
3164 region and output only the intersection rectangle as the metering region in the result
3165 metadata.<wbr/>  If the region is entirely outside the crop region,<wbr/> it will be ignored and
3166 not reported in the result metadata.<wbr/></p>
3167             </td>
3168           </tr>
3169
3170           <tr class="entries_header">
3171             <th class="th_details" colspan="5">HAL Implementation Details</th>
3172           </tr>
3173           <tr class="entry_cont">
3174             <td class="entry_details" colspan="5">
3175               <p>The HAL level representation of MeteringRectangle[] is a
3176 int[5 * area_<wbr/>count].<wbr/>
3177 Every five elements represent a metering region of
3178 (xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
3179 The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
3180 exclusive on xmax and ymax.<wbr/></p>
3181             </td>
3182           </tr>
3183
3184           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3185            <!-- end of entry -->
3186
3187
3188           <tr class="entry" id="controls_android.control.captureIntent">
3189             <td class="entry_name
3190              " rowspan="3">
3191               android.<wbr/>control.<wbr/>capture<wbr/>Intent
3192             </td>
3193             <td class="entry_type">
3194                 <span class="entry_type_name entry_type_name_enum">byte</span>
3195
3196               <span class="entry_type_visibility"> [public]</span>
3197
3198
3199               <span class="entry_type_hwlevel">[legacy] </span>
3200
3201
3202
3203                 <ul class="entry_type_enum">
3204                   <li>
3205                     <span class="entry_type_enum_name">CUSTOM</span>
3206                     <span class="entry_type_enum_notes"><p>The goal of this request doesn't fall into the other
3207 categories.<wbr/> The camera device will default to preview-like
3208 behavior.<wbr/></p></span>
3209                   </li>
3210                   <li>
3211                     <span class="entry_type_enum_name">PREVIEW</span>
3212                     <span class="entry_type_enum_notes"><p>This request is for a preview-like use case.<wbr/></p>
3213 <p>The precapture trigger may be used to start off a metering
3214 w/<wbr/>flash sequence.<wbr/></p></span>
3215                   </li>
3216                   <li>
3217                     <span class="entry_type_enum_name">STILL_CAPTURE</span>
3218                     <span class="entry_type_enum_notes"><p>This request is for a still capture-type
3219 use case.<wbr/></p>
3220 <p>If the flash unit is under automatic control,<wbr/> it may fire as needed.<wbr/></p></span>
3221                   </li>
3222                   <li>
3223                     <span class="entry_type_enum_name">VIDEO_RECORD</span>
3224                     <span class="entry_type_enum_notes"><p>This request is for a video recording
3225 use case.<wbr/></p></span>
3226                   </li>
3227                   <li>
3228                     <span class="entry_type_enum_name">VIDEO_SNAPSHOT</span>
3229                     <span class="entry_type_enum_notes"><p>This request is for a video snapshot (still
3230 image while recording video) use case.<wbr/></p>
3231 <p>The camera device should take the highest-quality image
3232 possible (given the other settings) without disrupting the
3233 frame rate of video recording.<wbr/>  </p></span>
3234                   </li>
3235                   <li>
3236                     <span class="entry_type_enum_name">ZERO_SHUTTER_LAG</span>
3237                     <span class="entry_type_enum_notes"><p>This request is for a ZSL usecase; the
3238 application will stream full-resolution images and
3239 reprocess one or several later for a final
3240 capture.<wbr/></p></span>
3241                   </li>
3242                   <li>
3243                     <span class="entry_type_enum_name">MANUAL</span>
3244                     <span class="entry_type_enum_notes"><p>This request is for manual capture use case where
3245 the applications want to directly control the capture parameters.<wbr/></p>
3246 <p>For example,<wbr/> the application may wish to manually control
3247 <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/> <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> etc.<wbr/></p></span>
3248                   </li>
3249                 </ul>
3250
3251             </td> <!-- entry_type -->
3252
3253             <td class="entry_description">
3254               <p>Information to the camera device 3A (auto-exposure,<wbr/>
3255 auto-focus,<wbr/> auto-white balance) routines about the purpose
3256 of this capture,<wbr/> to help the camera device to decide optimal 3A
3257 strategy.<wbr/></p>
3258             </td>
3259
3260             <td class="entry_units">
3261             </td>
3262
3263             <td class="entry_range">
3264             </td>
3265
3266             <td class="entry_tags">
3267               <ul class="entry_tags">
3268                   <li><a href="#tag_BC">BC</a></li>
3269               </ul>
3270             </td>
3271
3272           </tr>
3273           <tr class="entries_header">
3274             <th class="th_details" colspan="5">Details</th>
3275           </tr>
3276           <tr class="entry_cont">
3277             <td class="entry_details" colspan="5">
3278               <p>This control (except for MANUAL) is only effective if
3279 <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> != OFF</code> and any 3A routine is active.<wbr/></p>
3280 <p>ZERO_<wbr/>SHUTTER_<wbr/>LAG will be supported if <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
3281 contains ZSL.<wbr/> MANUAL will be supported if <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
3282 contains MANUAL_<wbr/>SENSOR.<wbr/> Other intent values are always supported.<wbr/></p>
3283             </td>
3284           </tr>
3285
3286
3287           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3288            <!-- end of entry -->
3289
3290
3291           <tr class="entry" id="controls_android.control.effectMode">
3292             <td class="entry_name
3293              " rowspan="3">
3294               android.<wbr/>control.<wbr/>effect<wbr/>Mode
3295             </td>
3296             <td class="entry_type">
3297                 <span class="entry_type_name entry_type_name_enum">byte</span>
3298
3299               <span class="entry_type_visibility"> [public]</span>
3300
3301
3302               <span class="entry_type_hwlevel">[legacy] </span>
3303
3304
3305
3306                 <ul class="entry_type_enum">
3307                   <li>
3308                     <span class="entry_type_enum_name">OFF</span>
3309                     <span class="entry_type_enum_notes"><p>No color effect will be applied.<wbr/></p></span>
3310                   </li>
3311                   <li>
3312                     <span class="entry_type_enum_name">MONO</span>
3313                     <span class="entry_type_enum_optional">[optional]</span>
3314                     <span class="entry_type_enum_notes"><p>A "monocolor" effect where the image is mapped into
3315 a single color.<wbr/></p>
3316 <p>This will typically be grayscale.<wbr/></p></span>
3317                   </li>
3318                   <li>
3319                     <span class="entry_type_enum_name">NEGATIVE</span>
3320                     <span class="entry_type_enum_optional">[optional]</span>
3321                     <span class="entry_type_enum_notes"><p>A "photo-negative" effect where the image's colors
3322 are inverted.<wbr/></p></span>
3323                   </li>
3324                   <li>
3325                     <span class="entry_type_enum_name">SOLARIZE</span>
3326                     <span class="entry_type_enum_optional">[optional]</span>
3327                     <span class="entry_type_enum_notes"><p>A "solarisation" effect (Sabattier effect) where the
3328 image is wholly or partially reversed in
3329 tone.<wbr/></p></span>
3330                   </li>
3331                   <li>
3332                     <span class="entry_type_enum_name">SEPIA</span>
3333                     <span class="entry_type_enum_optional">[optional]</span>
3334                     <span class="entry_type_enum_notes"><p>A "sepia" effect where the image is mapped into warm
3335 gray,<wbr/> red,<wbr/> and brown tones.<wbr/></p></span>
3336                   </li>
3337                   <li>
3338                     <span class="entry_type_enum_name">POSTERIZE</span>
3339                     <span class="entry_type_enum_optional">[optional]</span>
3340                     <span class="entry_type_enum_notes"><p>A "posterization" effect where the image uses
3341 discrete regions of tone rather than a continuous
3342 gradient of tones.<wbr/></p></span>
3343                   </li>
3344                   <li>
3345                     <span class="entry_type_enum_name">WHITEBOARD</span>
3346                     <span class="entry_type_enum_optional">[optional]</span>
3347                     <span class="entry_type_enum_notes"><p>A "whiteboard" effect where the image is typically displayed
3348 as regions of white,<wbr/> with black or grey details.<wbr/></p></span>
3349                   </li>
3350                   <li>
3351                     <span class="entry_type_enum_name">BLACKBOARD</span>
3352                     <span class="entry_type_enum_optional">[optional]</span>
3353                     <span class="entry_type_enum_notes"><p>A "blackboard" effect where the image is typically displayed
3354 as regions of black,<wbr/> with white or grey details.<wbr/></p></span>
3355                   </li>
3356                   <li>
3357                     <span class="entry_type_enum_name">AQUA</span>
3358                     <span class="entry_type_enum_optional">[optional]</span>
3359                     <span class="entry_type_enum_notes"><p>An "aqua" effect where a blue hue is added to the image.<wbr/></p></span>
3360                   </li>
3361                 </ul>
3362
3363             </td> <!-- entry_type -->
3364
3365             <td class="entry_description">
3366               <p>A special color effect to apply.<wbr/></p>
3367             </td>
3368
3369             <td class="entry_units">
3370             </td>
3371
3372             <td class="entry_range">
3373               <p><a href="#static_android.control.availableEffects">android.<wbr/>control.<wbr/>available<wbr/>Effects</a></p>
3374             </td>
3375
3376             <td class="entry_tags">
3377               <ul class="entry_tags">
3378                   <li><a href="#tag_BC">BC</a></li>
3379               </ul>
3380             </td>
3381
3382           </tr>
3383           <tr class="entries_header">
3384             <th class="th_details" colspan="5">Details</th>
3385           </tr>
3386           <tr class="entry_cont">
3387             <td class="entry_details" colspan="5">
3388               <p>When this mode is set,<wbr/> a color effect will be applied
3389 to images produced by the camera device.<wbr/> The interpretation
3390 and implementation of these color effects is left to the
3391 implementor of the camera device,<wbr/> and should not be
3392 depended on to be consistent (or present) across all
3393 devices.<wbr/></p>
3394             </td>
3395           </tr>
3396
3397
3398           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3399            <!-- end of entry -->
3400
3401
3402           <tr class="entry" id="controls_android.control.mode">
3403             <td class="entry_name
3404              " rowspan="3">
3405               android.<wbr/>control.<wbr/>mode
3406             </td>
3407             <td class="entry_type">
3408                 <span class="entry_type_name entry_type_name_enum">byte</span>
3409
3410               <span class="entry_type_visibility"> [public]</span>
3411
3412
3413               <span class="entry_type_hwlevel">[legacy] </span>
3414
3415
3416
3417                 <ul class="entry_type_enum">
3418                   <li>
3419                     <span class="entry_type_enum_name">OFF</span>
3420                     <span class="entry_type_enum_notes"><p>Full application control of pipeline.<wbr/></p>
3421 <p>All control by the device's metering and focusing (3A)
3422 routines is disabled,<wbr/> and no other settings in
3423 android.<wbr/>control.<wbr/>* have any effect,<wbr/> except that
3424 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> may be used by the camera
3425 device to select post-processing values for processing
3426 blocks that do not allow for manual control,<wbr/> or are not
3427 exposed by the camera API.<wbr/></p>
3428 <p>However,<wbr/> the camera device's 3A routines may continue to
3429 collect statistics and update their internal state so that
3430 when control is switched to AUTO mode,<wbr/> good control values
3431 can be immediately applied.<wbr/></p></span>
3432                   </li>
3433                   <li>
3434                     <span class="entry_type_enum_name">AUTO</span>
3435                     <span class="entry_type_enum_notes"><p>Use settings for each individual 3A routine.<wbr/></p>
3436 <p>Manual control of capture parameters is disabled.<wbr/> All
3437 controls in android.<wbr/>control.<wbr/>* besides sceneMode take
3438 effect.<wbr/></p></span>
3439                   </li>
3440                   <li>
3441                     <span class="entry_type_enum_name">USE_SCENE_MODE</span>
3442                     <span class="entry_type_enum_notes"><p>Use a specific scene mode.<wbr/></p>
3443 <p>Enabling this disables control.<wbr/>aeMode,<wbr/> control.<wbr/>awbMode and
3444 control.<wbr/>afMode controls; the camera device will ignore
3445 those settings while USE_<wbr/>SCENE_<wbr/>MODE is active (except for
3446 FACE_<wbr/>PRIORITY scene mode).<wbr/> Other control entries are still
3447 active.<wbr/>  This setting can only be used if scene mode is
3448 supported (i.<wbr/>e.<wbr/> <a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a>
3449 contain some modes other than DISABLED).<wbr/></p></span>
3450                   </li>
3451                   <li>
3452                     <span class="entry_type_enum_name">OFF_KEEP_STATE</span>
3453                     <span class="entry_type_enum_notes"><p>Same as OFF mode,<wbr/> except that this capture will not be
3454 used by camera device background auto-exposure,<wbr/> auto-white balance and
3455 auto-focus algorithms (3A) to update their statistics.<wbr/></p>
3456 <p>Specifically,<wbr/> the 3A routines are locked to the last
3457 values set from a request with AUTO,<wbr/> OFF,<wbr/> or
3458 USE_<wbr/>SCENE_<wbr/>MODE,<wbr/> and any statistics or state updates
3459 collected from manual captures with OFF_<wbr/>KEEP_<wbr/>STATE will be
3460 discarded by the camera device.<wbr/></p></span>
3461                   </li>
3462                 </ul>
3463
3464             </td> <!-- entry_type -->
3465
3466             <td class="entry_description">
3467               <p>Overall mode of 3A (auto-exposure,<wbr/> auto-white-balance,<wbr/> auto-focus) control
3468 routines.<wbr/></p>
3469             </td>
3470
3471             <td class="entry_units">
3472             </td>
3473
3474             <td class="entry_range">
3475             </td>
3476
3477             <td class="entry_tags">
3478               <ul class="entry_tags">
3479                   <li><a href="#tag_BC">BC</a></li>
3480               </ul>
3481             </td>
3482
3483           </tr>
3484           <tr class="entries_header">
3485             <th class="th_details" colspan="5">Details</th>
3486           </tr>
3487           <tr class="entry_cont">
3488             <td class="entry_details" colspan="5">
3489               <p>This is a top-level 3A control switch.<wbr/> When set to OFF,<wbr/> all 3A control
3490 by the camera device is disabled.<wbr/> The application must set the fields for
3491 capture parameters itself.<wbr/></p>
3492 <p>When set to AUTO,<wbr/> the individual algorithm controls in
3493 android.<wbr/>control.<wbr/>* are in effect,<wbr/> such as <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>.<wbr/></p>
3494 <p>When set to USE_<wbr/>SCENE_<wbr/>MODE,<wbr/> the individual controls in
3495 android.<wbr/>control.<wbr/>* are mostly disabled,<wbr/> and the camera device implements
3496 one of the scene mode settings (such as ACTION,<wbr/> SUNSET,<wbr/> or PARTY)
3497 as it wishes.<wbr/> The camera device scene mode 3A settings are provided by
3498 <a href="#static_android.control.sceneModeOverrides">android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides</a>.<wbr/></p>
3499 <p>When set to OFF_<wbr/>KEEP_<wbr/>STATE,<wbr/> it is similar to OFF mode,<wbr/> the only difference
3500 is that this frame will not be used by camera device background 3A statistics
3501 update,<wbr/> as if this frame is never captured.<wbr/> This mode can be used in the scenario
3502 where the application doesn't want a 3A manual control capture to affect
3503 the subsequent auto 3A capture results.<wbr/></p>
3504 <p>LEGACY mode devices will only support AUTO and USE_<wbr/>SCENE_<wbr/>MODE modes.<wbr/>
3505 LIMITED mode devices will only support OFF and OFF_<wbr/>KEEP_<wbr/>STATE if they
3506 support the MANUAL_<wbr/>SENSOR and MANUAL_<wbr/>POST_<wbr/>PROCSESING capabilities.<wbr/>
3507 FULL mode devices will always support OFF and OFF_<wbr/>KEEP_<wbr/>STATE.<wbr/></p>
3508             </td>
3509           </tr>
3510
3511
3512           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3513            <!-- end of entry -->
3514
3515
3516           <tr class="entry" id="controls_android.control.sceneMode">
3517             <td class="entry_name
3518              " rowspan="5">
3519               android.<wbr/>control.<wbr/>scene<wbr/>Mode
3520             </td>
3521             <td class="entry_type">
3522                 <span class="entry_type_name entry_type_name_enum">byte</span>
3523
3524               <span class="entry_type_visibility"> [public]</span>
3525
3526
3527               <span class="entry_type_hwlevel">[legacy] </span>
3528
3529
3530
3531                 <ul class="entry_type_enum">
3532                   <li>
3533                     <span class="entry_type_enum_name">DISABLED</span>
3534                     <span class="entry_type_enum_value">0</span>
3535                     <span class="entry_type_enum_notes"><p>Indicates that no scene modes are set for a given capture request.<wbr/></p></span>
3536                   </li>
3537                   <li>
3538                     <span class="entry_type_enum_name">FACE_PRIORITY</span>
3539                     <span class="entry_type_enum_notes"><p>If face detection support exists,<wbr/> use face
3540 detection data for auto-focus,<wbr/> auto-white balance,<wbr/> and
3541 auto-exposure routines.<wbr/></p>
3542 <p>If face detection statistics are disabled
3543 (i.<wbr/>e.<wbr/> <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> is set to OFF),<wbr/>
3544 this should still operate correctly (but will not return
3545 face detection statistics to the framework).<wbr/></p>
3546 <p>Unlike the other scene modes,<wbr/> <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
3547 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>
3548 remain active when FACE_<wbr/>PRIORITY is set.<wbr/></p></span>
3549                   </li>
3550                   <li>
3551                     <span class="entry_type_enum_name">ACTION</span>
3552                     <span class="entry_type_enum_optional">[optional]</span>
3553                     <span class="entry_type_enum_notes"><p>Optimized for photos of quickly moving objects.<wbr/></p>
3554 <p>Similar to SPORTS.<wbr/></p></span>
3555                   </li>
3556                   <li>
3557                     <span class="entry_type_enum_name">PORTRAIT</span>
3558                     <span class="entry_type_enum_optional">[optional]</span>
3559                     <span class="entry_type_enum_notes"><p>Optimized for still photos of people.<wbr/></p></span>
3560                   </li>
3561                   <li>
3562                     <span class="entry_type_enum_name">LANDSCAPE</span>
3563                     <span class="entry_type_enum_optional">[optional]</span>
3564                     <span class="entry_type_enum_notes"><p>Optimized for photos of distant macroscopic objects.<wbr/></p></span>
3565                   </li>
3566                   <li>
3567                     <span class="entry_type_enum_name">NIGHT</span>
3568                     <span class="entry_type_enum_optional">[optional]</span>
3569                     <span class="entry_type_enum_notes"><p>Optimized for low-light settings.<wbr/></p></span>
3570                   </li>
3571                   <li>
3572                     <span class="entry_type_enum_name">NIGHT_PORTRAIT</span>
3573                     <span class="entry_type_enum_optional">[optional]</span>
3574                     <span class="entry_type_enum_notes"><p>Optimized for still photos of people in low-light
3575 settings.<wbr/></p></span>
3576                   </li>
3577                   <li>
3578                     <span class="entry_type_enum_name">THEATRE</span>
3579                     <span class="entry_type_enum_optional">[optional]</span>
3580                     <span class="entry_type_enum_notes"><p>Optimized for dim,<wbr/> indoor settings where flash must
3581 remain off.<wbr/></p></span>
3582                   </li>
3583                   <li>
3584                     <span class="entry_type_enum_name">BEACH</span>
3585                     <span class="entry_type_enum_optional">[optional]</span>
3586                     <span class="entry_type_enum_notes"><p>Optimized for bright,<wbr/> outdoor beach settings.<wbr/></p></span>
3587                   </li>
3588                   <li>
3589                     <span class="entry_type_enum_name">SNOW</span>
3590                     <span class="entry_type_enum_optional">[optional]</span>
3591                     <span class="entry_type_enum_notes"><p>Optimized for bright,<wbr/> outdoor settings containing snow.<wbr/></p></span>
3592                   </li>
3593                   <li>
3594                     <span class="entry_type_enum_name">SUNSET</span>
3595                     <span class="entry_type_enum_optional">[optional]</span>
3596                     <span class="entry_type_enum_notes"><p>Optimized for scenes of the setting sun.<wbr/></p></span>
3597                   </li>
3598                   <li>
3599                     <span class="entry_type_enum_name">STEADYPHOTO</span>
3600                     <span class="entry_type_enum_optional">[optional]</span>
3601                     <span class="entry_type_enum_notes"><p>Optimized to avoid blurry photos due to small amounts of
3602 device motion (for example: due to hand shake).<wbr/></p></span>
3603                   </li>
3604                   <li>
3605                     <span class="entry_type_enum_name">FIREWORKS</span>
3606                     <span class="entry_type_enum_optional">[optional]</span>
3607                     <span class="entry_type_enum_notes"><p>Optimized for nighttime photos of fireworks.<wbr/></p></span>
3608                   </li>
3609                   <li>
3610                     <span class="entry_type_enum_name">SPORTS</span>
3611                     <span class="entry_type_enum_optional">[optional]</span>
3612                     <span class="entry_type_enum_notes"><p>Optimized for photos of quickly moving people.<wbr/></p>
3613 <p>Similar to ACTION.<wbr/></p></span>
3614                   </li>
3615                   <li>
3616                     <span class="entry_type_enum_name">PARTY</span>
3617                     <span class="entry_type_enum_optional">[optional]</span>
3618                     <span class="entry_type_enum_notes"><p>Optimized for dim,<wbr/> indoor settings with multiple moving
3619 people.<wbr/></p></span>
3620                   </li>
3621                   <li>
3622                     <span class="entry_type_enum_name">CANDLELIGHT</span>
3623                     <span class="entry_type_enum_optional">[optional]</span>
3624                     <span class="entry_type_enum_notes"><p>Optimized for dim settings where the main light source
3625 is a flame.<wbr/></p></span>
3626                   </li>
3627                   <li>
3628                     <span class="entry_type_enum_name">BARCODE</span>
3629                     <span class="entry_type_enum_optional">[optional]</span>
3630                     <span class="entry_type_enum_notes"><p>Optimized for accurately capturing a photo of barcode
3631 for use by camera applications that wish to read the
3632 barcode value.<wbr/></p></span>
3633                   </li>
3634                   <li>
3635                     <span class="entry_type_enum_name">HIGH_SPEED_VIDEO</span>
3636                     <span class="entry_type_enum_optional">[optional]</span>
3637                     <span class="entry_type_enum_notes"><p>Optimized for high speed video recording (frame rate &gt;=60fps) use case.<wbr/></p>
3638 <p>The supported high speed video sizes and fps ranges are specified in
3639 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/> To get desired
3640 output frame rates,<wbr/> the application is only allowed to select video size
3641 and fps range combinations listed in this static metadata.<wbr/> The fps range
3642 can be control via <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a>.<wbr/></p>
3643 <p>In this mode,<wbr/> the camera device will override aeMode,<wbr/> awbMode,<wbr/> and afMode to
3644 ON,<wbr/> ON,<wbr/> and CONTINUOUS_<wbr/>VIDEO,<wbr/> respectively.<wbr/> All post-processing block mode
3645 controls will be overridden to be FAST.<wbr/> Therefore,<wbr/> no manual control of capture
3646 and post-processing parameters is possible.<wbr/> All other controls operate the
3647 same as when <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == AUTO.<wbr/> This means that all other
3648 android.<wbr/>control.<wbr/>* fields continue to work,<wbr/> such as</p>
3649 <ul>
3650 <li><a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a></li>
3651 <li><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a></li>
3652 <li><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a></li>
3653 <li><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a></li>
3654 <li><a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a></li>
3655 <li><a href="#controls_android.control.aeRegions">android.<wbr/>control.<wbr/>ae<wbr/>Regions</a></li>
3656 <li><a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a></li>
3657 <li><a href="#controls_android.control.awbRegions">android.<wbr/>control.<wbr/>awb<wbr/>Regions</a></li>
3658 <li><a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a></li>
3659 <li><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a></li>
3660 </ul>
3661 <p>Outside of android.<wbr/>control.<wbr/>*,<wbr/> the following controls will work:</p>
3662 <ul>
3663 <li><a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> (automatic flash for still capture will not work since aeMode is ON)</li>
3664 <li><a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a> (if it is supported)</li>
3665 <li><a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a></li>
3666 <li><a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a></li>
3667 </ul>
3668 <p>For high speed recording use case,<wbr/> the actual maximum supported frame rate may
3669 be lower than what camera can output,<wbr/> depending on the destination Surfaces for
3670 the image data.<wbr/> For example,<wbr/> if the destination surface is from video encoder,<wbr/>
3671 the application need check if the video encoder is capable of supporting the
3672 high frame rate for a given video size,<wbr/> or it will end up with lower recording
3673 frame rate.<wbr/> If the destination surface is from preview window,<wbr/> the preview frame
3674 rate will be bounded by the screen refresh rate.<wbr/></p>
3675 <p>The camera device will only support up to 2 output high speed streams
3676 (processed non-stalling format defined in <a href="#static_android.request.maxNumOutputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams</a>)
3677 in this mode.<wbr/> This control will be effective only if all of below conditions are true:</p>
3678 <ul>
3679 <li>The application created no more than maxNumHighSpeedStreams processed non-stalling
3680 format output streams,<wbr/> where maxNumHighSpeedStreams is calculated as
3681 min(2,<wbr/> <a href="#static_android.request.maxNumOutputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams</a>[Processed (but not-stalling)]).<wbr/></li>
3682 <li>The stream sizes are selected from the sizes reported by
3683 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/></li>
3684 <li>No processed non-stalling or raw streams are configured.<wbr/></li>
3685 </ul>
3686 <p>When above conditions are NOT satistied,<wbr/> the controls of this mode and
3687 <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a> will be ignored by the camera device,<wbr/>
3688 the camera device will fall back to <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> <code>==</code> AUTO,<wbr/>
3689 and the returned capture result metadata will give the fps range choosen
3690 by the camera device.<wbr/></p>
3691 <p>Switching into or out of this mode may trigger some camera ISP/<wbr/>sensor
3692 reconfigurations,<wbr/> which may introduce extra latency.<wbr/> It is recommended that
3693 the application avoids unnecessary scene mode switch as much as possible.<wbr/></p></span>
3694                   </li>
3695                   <li>
3696                     <span class="entry_type_enum_name">HDR</span>
3697                     <span class="entry_type_enum_optional">[optional]</span>
3698                     <span class="entry_type_enum_optional">[hidden]</span>
3699                     <span class="entry_type_enum_notes"><p>Turn on custom high dynamic range (HDR) mode.<wbr/></p>
3700 <p>This is intended for LEGACY mode devices only;
3701 HAL3+ camera devices should not implement this mode.<wbr/></p></span>
3702                   </li>
3703                 </ul>
3704
3705             </td> <!-- entry_type -->
3706
3707             <td class="entry_description">
3708               <p>Control for which scene mode is currently active.<wbr/></p>
3709             </td>
3710
3711             <td class="entry_units">
3712             </td>
3713
3714             <td class="entry_range">
3715               <p><a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a></p>
3716             </td>
3717
3718             <td class="entry_tags">
3719               <ul class="entry_tags">
3720                   <li><a href="#tag_BC">BC</a></li>
3721               </ul>
3722             </td>
3723
3724           </tr>
3725           <tr class="entries_header">
3726             <th class="th_details" colspan="5">Details</th>
3727           </tr>
3728           <tr class="entry_cont">
3729             <td class="entry_details" colspan="5">
3730               <p>Scene modes are custom camera modes optimized for a certain set of conditions and
3731 capture settings.<wbr/></p>
3732 <p>This is the mode that that is active when
3733 <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == USE_<wbr/>SCENE_<wbr/>MODE</code>.<wbr/> Aside from FACE_<wbr/>PRIORITY,<wbr/>
3734 these modes will disable <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
3735 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> while in use.<wbr/></p>
3736 <p>The interpretation and implementation of these scene modes is left
3737 to the implementor of the camera device.<wbr/> Their behavior will not be
3738 consistent across all devices,<wbr/> and any given device may only implement
3739 a subset of these modes.<wbr/></p>
3740             </td>
3741           </tr>
3742
3743           <tr class="entries_header">
3744             <th class="th_details" colspan="5">HAL Implementation Details</th>
3745           </tr>
3746           <tr class="entry_cont">
3747             <td class="entry_details" colspan="5">
3748               <p>HAL implementations that include scene modes are expected to provide
3749 the per-scene settings to use for <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
3750 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> in
3751 <a href="#static_android.control.sceneModeOverrides">android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides</a>.<wbr/></p>
3752 <p>For HIGH_<wbr/>SPEED_<wbr/>VIDEO mode,<wbr/> if it is included in <a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a>,<wbr/>
3753 the HAL must list supported video size and fps range in
3754 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/> For a given size,<wbr/> e.<wbr/>g.<wbr/>
3755 1280x720,<wbr/> if the HAL has two different sensor configurations for normal streaming
3756 mode and high speed streaming,<wbr/> when this scene mode is set/<wbr/>reset in a sequence of capture
3757 requests,<wbr/> the HAL may have to switch between different sensor modes.<wbr/></p>
3758             </td>
3759           </tr>
3760
3761           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3762            <!-- end of entry -->
3763
3764
3765           <tr class="entry" id="controls_android.control.videoStabilizationMode">
3766             <td class="entry_name
3767              " rowspan="3">
3768               android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode
3769             </td>
3770             <td class="entry_type">
3771                 <span class="entry_type_name entry_type_name_enum">byte</span>
3772
3773               <span class="entry_type_visibility"> [public]</span>
3774
3775
3776               <span class="entry_type_hwlevel">[legacy] </span>
3777
3778
3779
3780                 <ul class="entry_type_enum">
3781                   <li>
3782                     <span class="entry_type_enum_name">OFF</span>
3783                     <span class="entry_type_enum_notes"><p>Video stabilization is disabled.<wbr/></p></span>
3784                   </li>
3785                   <li>
3786                     <span class="entry_type_enum_name">ON</span>
3787                     <span class="entry_type_enum_notes"><p>Video stabilization is enabled.<wbr/></p></span>
3788                   </li>
3789                 </ul>
3790
3791             </td> <!-- entry_type -->
3792
3793             <td class="entry_description">
3794               <p>Whether video stabilization is
3795 active.<wbr/></p>
3796             </td>
3797
3798             <td class="entry_units">
3799             </td>
3800
3801             <td class="entry_range">
3802             </td>
3803
3804             <td class="entry_tags">
3805               <ul class="entry_tags">
3806                   <li><a href="#tag_BC">BC</a></li>
3807               </ul>
3808             </td>
3809
3810           </tr>
3811           <tr class="entries_header">
3812             <th class="th_details" colspan="5">Details</th>
3813           </tr>
3814           <tr class="entry_cont">
3815             <td class="entry_details" colspan="5">
3816               <p>Video stabilization automatically translates and scales images from
3817 the camera in order to stabilize motion between consecutive frames.<wbr/></p>
3818 <p>If enabled,<wbr/> video stabilization can modify the
3819 <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> to keep the video stream stabilized.<wbr/></p>
3820 <p>Switching between different video stabilization modes may take several
3821 frames to initialize,<wbr/> the camera device will report the current mode
3822 in capture result metadata.<wbr/> For example,<wbr/> When "ON" mode is requested,<wbr/>
3823 the video stabilization modes in the first several capture results may
3824 still be "OFF",<wbr/> and it will become "ON" when the initialization is
3825 done.<wbr/></p>
3826 <p>If a camera device supports both this mode and OIS
3827 (<a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> turning both modes on may
3828 produce undesirable interaction,<wbr/> so it is recommended not to enable
3829 both at the same time.<wbr/></p>
3830             </td>
3831           </tr>
3832
3833
3834           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3835            <!-- end of entry -->
3836
3837
3838
3839       <!-- end of kind -->
3840       </tbody>
3841       <tr><td colspan="6" class="kind">static</td></tr>
3842
3843       <thead class="entries_header">
3844         <tr>
3845           <th class="th_name">Property Name</th>
3846           <th class="th_type">Type</th>
3847           <th class="th_description">Description</th>
3848           <th class="th_units">Units</th>
3849           <th class="th_range">Range</th>
3850           <th class="th_tags">Tags</th>
3851         </tr>
3852       </thead>
3853
3854       <tbody>
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865           <tr class="entry" id="static_android.control.aeAvailableAntibandingModes">
3866             <td class="entry_name
3867              " rowspan="3">
3868               android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes
3869             </td>
3870             <td class="entry_type">
3871                 <span class="entry_type_name">byte</span>
3872                 <span class="entry_type_container">x</span>
3873
3874                 <span class="entry_type_array">
3875                   n
3876                 </span>
3877               <span class="entry_type_visibility"> [public as enumList]</span>
3878
3879
3880               <span class="entry_type_hwlevel">[legacy] </span>
3881
3882
3883                 <div class="entry_type_notes">list of enums</div>
3884
3885
3886             </td> <!-- entry_type -->
3887
3888             <td class="entry_description">
3889               <p>List of auto-exposure antibanding modes for <a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a> that are
3890 supported by this camera device.<wbr/></p>
3891             </td>
3892
3893             <td class="entry_units">
3894             </td>
3895
3896             <td class="entry_range">
3897               <p>Any value listed in <a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a></p>
3898             </td>
3899
3900             <td class="entry_tags">
3901               <ul class="entry_tags">
3902                   <li><a href="#tag_BC">BC</a></li>
3903               </ul>
3904             </td>
3905
3906           </tr>
3907           <tr class="entries_header">
3908             <th class="th_details" colspan="5">Details</th>
3909           </tr>
3910           <tr class="entry_cont">
3911             <td class="entry_details" colspan="5">
3912               <p>Not all of the auto-exposure anti-banding modes may be
3913 supported by a given camera device.<wbr/> This field lists the
3914 valid anti-banding modes that the application may request
3915 for this camera device with the
3916 <a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a> control.<wbr/> This list
3917 always includes AUTO.<wbr/></p>
3918             </td>
3919           </tr>
3920
3921
3922           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3923            <!-- end of entry -->
3924
3925
3926           <tr class="entry" id="static_android.control.aeAvailableModes">
3927             <td class="entry_name
3928              " rowspan="3">
3929               android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Modes
3930             </td>
3931             <td class="entry_type">
3932                 <span class="entry_type_name">byte</span>
3933                 <span class="entry_type_container">x</span>
3934
3935                 <span class="entry_type_array">
3936                   n
3937                 </span>
3938               <span class="entry_type_visibility"> [public as enumList]</span>
3939
3940
3941               <span class="entry_type_hwlevel">[legacy] </span>
3942
3943
3944                 <div class="entry_type_notes">list of enums</div>
3945
3946
3947             </td> <!-- entry_type -->
3948
3949             <td class="entry_description">
3950               <p>List of auto-exposure modes for <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> that are supported by this camera
3951 device.<wbr/></p>
3952             </td>
3953
3954             <td class="entry_units">
3955             </td>
3956
3957             <td class="entry_range">
3958               <p>Any value listed in <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a></p>
3959             </td>
3960
3961             <td class="entry_tags">
3962               <ul class="entry_tags">
3963                   <li><a href="#tag_BC">BC</a></li>
3964               </ul>
3965             </td>
3966
3967           </tr>
3968           <tr class="entries_header">
3969             <th class="th_details" colspan="5">Details</th>
3970           </tr>
3971           <tr class="entry_cont">
3972             <td class="entry_details" colspan="5">
3973               <p>Not all the auto-exposure modes may be supported by a
3974 given camera device,<wbr/> especially if no flash unit is
3975 available.<wbr/> This entry lists the valid modes for
3976 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> for this camera device.<wbr/></p>
3977 <p>All camera devices support ON,<wbr/> and all camera devices with flash
3978 units support ON_<wbr/>AUTO_<wbr/>FLASH and ON_<wbr/>ALWAYS_<wbr/>FLASH.<wbr/></p>
3979 <p>FULL mode camera devices always support OFF mode,<wbr/>
3980 which enables application control of camera exposure time,<wbr/>
3981 sensitivity,<wbr/> and frame duration.<wbr/></p>
3982 <p>LEGACY mode camera devices never support OFF mode.<wbr/>
3983 LIMITED mode devices support OFF if they support the MANUAL_<wbr/>SENSOR
3984 capability.<wbr/></p>
3985             </td>
3986           </tr>
3987
3988
3989           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3990            <!-- end of entry -->
3991
3992
3993           <tr class="entry" id="static_android.control.aeAvailableTargetFpsRanges">
3994             <td class="entry_name
3995              " rowspan="3">
3996               android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Target<wbr/>Fps<wbr/>Ranges
3997             </td>
3998             <td class="entry_type">
3999                 <span class="entry_type_name">int32</span>
4000                 <span class="entry_type_container">x</span>
4001
4002                 <span class="entry_type_array">
4003                   2 x n
4004                 </span>
4005               <span class="entry_type_visibility"> [public as rangeInt]</span>
4006
4007
4008               <span class="entry_type_hwlevel">[legacy] </span>
4009
4010
4011                 <div class="entry_type_notes">list of pairs of frame rates</div>
4012
4013
4014             </td> <!-- entry_type -->
4015
4016             <td class="entry_description">
4017               <p>List of frame rate ranges for <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a> supported by
4018 this camera device.<wbr/></p>
4019             </td>
4020
4021             <td class="entry_units">
4022               Frames per second (FPS)
4023             </td>
4024
4025             <td class="entry_range">
4026             </td>
4027
4028             <td class="entry_tags">
4029               <ul class="entry_tags">
4030                   <li><a href="#tag_BC">BC</a></li>
4031               </ul>
4032             </td>
4033
4034           </tr>
4035           <tr class="entries_header">
4036             <th class="th_details" colspan="5">Details</th>
4037           </tr>
4038           <tr class="entry_cont">
4039             <td class="entry_details" colspan="5">
4040               <p>For devices at the LIMITED level or above,<wbr/> this list will include at least (30,<wbr/> 30) for
4041 constant-framerate recording.<wbr/></p>
4042             </td>
4043           </tr>
4044
4045
4046           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4047            <!-- end of entry -->
4048
4049
4050           <tr class="entry" id="static_android.control.aeCompensationRange">
4051             <td class="entry_name
4052              " rowspan="1">
4053               android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range
4054             </td>
4055             <td class="entry_type">
4056                 <span class="entry_type_name">int32</span>
4057                 <span class="entry_type_container">x</span>
4058
4059                 <span class="entry_type_array">
4060                   2
4061                 </span>
4062               <span class="entry_type_visibility"> [public as rangeInt]</span>
4063
4064
4065               <span class="entry_type_hwlevel">[legacy] </span>
4066
4067
4068
4069
4070             </td> <!-- entry_type -->
4071
4072             <td class="entry_description">
4073               <p>Maximum and minimum exposure compensation values for
4074 <a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a>,<wbr/> in counts of <a href="#static_android.control.aeCompensationStep">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step</a>,<wbr/>
4075 that are supported by this camera device.<wbr/></p>
4076             </td>
4077
4078             <td class="entry_units">
4079             </td>
4080
4081             <td class="entry_range">
4082               <p><code>Min.<wbr/>exposure compensation * <a href="#static_android.control.aeCompensationStep">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step</a> &lt;= -2 EV</code></p>
4083 <p><code>Max.<wbr/>exposure compensation * <a href="#static_android.control.aeCompensationStep">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step</a> &gt;= 2 EV</code></p>
4084             </td>
4085
4086             <td class="entry_tags">
4087               <ul class="entry_tags">
4088                   <li><a href="#tag_BC">BC</a></li>
4089               </ul>
4090             </td>
4091
4092           </tr>
4093
4094
4095           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4096            <!-- end of entry -->
4097
4098
4099           <tr class="entry" id="static_android.control.aeCompensationStep">
4100             <td class="entry_name
4101              " rowspan="5">
4102               android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step
4103             </td>
4104             <td class="entry_type">
4105                 <span class="entry_type_name">rational</span>
4106
4107               <span class="entry_type_visibility"> [public]</span>
4108
4109
4110               <span class="entry_type_hwlevel">[legacy] </span>
4111
4112
4113
4114
4115             </td> <!-- entry_type -->
4116
4117             <td class="entry_description">
4118               <p>Smallest step by which the exposure compensation
4119 can be changed.<wbr/></p>
4120             </td>
4121
4122             <td class="entry_units">
4123               Exposure Value (EV)
4124             </td>
4125
4126             <td class="entry_range">
4127             </td>
4128
4129             <td class="entry_tags">
4130               <ul class="entry_tags">
4131                   <li><a href="#tag_BC">BC</a></li>
4132               </ul>
4133             </td>
4134
4135           </tr>
4136           <tr class="entries_header">
4137             <th class="th_details" colspan="5">Details</th>
4138           </tr>
4139           <tr class="entry_cont">
4140             <td class="entry_details" colspan="5">
4141               <p>This is the unit for <a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a>.<wbr/> For example,<wbr/> if this key has
4142 a value of <code>1/<wbr/>2</code>,<wbr/> then a setting of <code>-2</code> for <a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a> means
4143 that the target EV offset for the auto-exposure routine is -1 EV.<wbr/></p>
4144 <p>One unit of EV compensation changes the brightness of the captured image by a factor
4145 of two.<wbr/> +1 EV doubles the image brightness,<wbr/> while -1 EV halves the image brightness.<wbr/></p>
4146             </td>
4147           </tr>
4148
4149           <tr class="entries_header">
4150             <th class="th_details" colspan="5">HAL Implementation Details</th>
4151           </tr>
4152           <tr class="entry_cont">
4153             <td class="entry_details" colspan="5">
4154               <p>This must be less than or equal to 1/<wbr/>2.<wbr/></p>
4155             </td>
4156           </tr>
4157
4158           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4159            <!-- end of entry -->
4160
4161
4162           <tr class="entry" id="static_android.control.afAvailableModes">
4163             <td class="entry_name
4164              " rowspan="3">
4165               android.<wbr/>control.<wbr/>af<wbr/>Available<wbr/>Modes
4166             </td>
4167             <td class="entry_type">
4168                 <span class="entry_type_name">byte</span>
4169                 <span class="entry_type_container">x</span>
4170
4171                 <span class="entry_type_array">
4172                   n
4173                 </span>
4174               <span class="entry_type_visibility"> [public as enumList]</span>
4175
4176
4177               <span class="entry_type_hwlevel">[legacy] </span>
4178
4179
4180                 <div class="entry_type_notes">List of enums</div>
4181
4182
4183             </td> <!-- entry_type -->
4184
4185             <td class="entry_description">
4186               <p>List of auto-focus (AF) modes for <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> that are
4187 supported by this camera device.<wbr/></p>
4188             </td>
4189
4190             <td class="entry_units">
4191             </td>
4192
4193             <td class="entry_range">
4194               <p>Any value listed in <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a></p>
4195             </td>
4196
4197             <td class="entry_tags">
4198               <ul class="entry_tags">
4199                   <li><a href="#tag_BC">BC</a></li>
4200               </ul>
4201             </td>
4202
4203           </tr>
4204           <tr class="entries_header">
4205             <th class="th_details" colspan="5">Details</th>
4206           </tr>
4207           <tr class="entry_cont">
4208             <td class="entry_details" colspan="5">
4209               <p>Not all the auto-focus modes may be supported by a
4210 given camera device.<wbr/> This entry lists the valid modes for
4211 <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> for this camera device.<wbr/></p>
4212 <p>All LIMITED and FULL mode camera devices will support OFF mode,<wbr/> and all
4213 camera devices with adjustable focuser units
4214 (<code><a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> &gt; 0</code>) will support AUTO mode.<wbr/></p>
4215 <p>LEGACY devices will support OFF mode only if they support
4216 focusing to infinity (by also setting <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> to
4217 <code>0.<wbr/>0f</code>).<wbr/></p>
4218             </td>
4219           </tr>
4220
4221
4222           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4223            <!-- end of entry -->
4224
4225
4226           <tr class="entry" id="static_android.control.availableEffects">
4227             <td class="entry_name
4228              " rowspan="3">
4229               android.<wbr/>control.<wbr/>available<wbr/>Effects
4230             </td>
4231             <td class="entry_type">
4232                 <span class="entry_type_name">byte</span>
4233                 <span class="entry_type_container">x</span>
4234
4235                 <span class="entry_type_array">
4236                   n
4237                 </span>
4238               <span class="entry_type_visibility"> [public as enumList]</span>
4239
4240
4241               <span class="entry_type_hwlevel">[legacy] </span>
4242
4243
4244                 <div class="entry_type_notes">List of enums (android.<wbr/>control.<wbr/>effect<wbr/>Mode).<wbr/></div>
4245
4246
4247             </td> <!-- entry_type -->
4248
4249             <td class="entry_description">
4250               <p>List of color effects for <a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a> that are supported by this camera
4251 device.<wbr/></p>
4252             </td>
4253
4254             <td class="entry_units">
4255             </td>
4256
4257             <td class="entry_range">
4258               <p>Any value listed in <a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a></p>
4259             </td>
4260
4261             <td class="entry_tags">
4262               <ul class="entry_tags">
4263                   <li><a href="#tag_BC">BC</a></li>
4264               </ul>
4265             </td>
4266
4267           </tr>
4268           <tr class="entries_header">
4269             <th class="th_details" colspan="5">Details</th>
4270           </tr>
4271           <tr class="entry_cont">
4272             <td class="entry_details" colspan="5">
4273               <p>This list contains the color effect modes that can be applied to
4274 images produced by the camera device.<wbr/>
4275 Implementations are not expected to be consistent across all devices.<wbr/>
4276 If no color effect modes are available for a device,<wbr/> this will only list
4277 OFF.<wbr/></p>
4278 <p>A color effect will only be applied if
4279 <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> != OFF.<wbr/>  OFF is always included in this list.<wbr/></p>
4280 <p>This control has no effect on the operation of other control routines such
4281 as auto-exposure,<wbr/> white balance,<wbr/> or focus.<wbr/></p>
4282             </td>
4283           </tr>
4284
4285
4286           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4287            <!-- end of entry -->
4288
4289
4290           <tr class="entry" id="static_android.control.availableSceneModes">
4291             <td class="entry_name
4292              " rowspan="3">
4293               android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes
4294             </td>
4295             <td class="entry_type">
4296                 <span class="entry_type_name">byte</span>
4297                 <span class="entry_type_container">x</span>
4298
4299                 <span class="entry_type_array">
4300                   n
4301                 </span>
4302               <span class="entry_type_visibility"> [public as enumList]</span>
4303
4304
4305               <span class="entry_type_hwlevel">[legacy] </span>
4306
4307
4308                 <div class="entry_type_notes">List of enums (android.<wbr/>control.<wbr/>scene<wbr/>Mode).<wbr/></div>
4309
4310
4311             </td> <!-- entry_type -->
4312
4313             <td class="entry_description">
4314               <p>List of scene modes for <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a> that are supported by this camera
4315 device.<wbr/></p>
4316             </td>
4317
4318             <td class="entry_units">
4319             </td>
4320
4321             <td class="entry_range">
4322               <p>Any value listed in <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a></p>
4323             </td>
4324
4325             <td class="entry_tags">
4326               <ul class="entry_tags">
4327                   <li><a href="#tag_BC">BC</a></li>
4328               </ul>
4329             </td>
4330
4331           </tr>
4332           <tr class="entries_header">
4333             <th class="th_details" colspan="5">Details</th>
4334           </tr>
4335           <tr class="entry_cont">
4336             <td class="entry_details" colspan="5">
4337               <p>This list contains scene modes that can be set for the camera device.<wbr/>
4338 Only scene modes that have been fully implemented for the
4339 camera device may be included here.<wbr/> Implementations are not expected
4340 to be consistent across all devices.<wbr/></p>
4341 <p>If no scene modes are supported by the camera device,<wbr/> this
4342 will be set to DISABLED.<wbr/> Otherwise DISABLED will not be listed.<wbr/></p>
4343 <p>FACE_<wbr/>PRIORITY is always listed if face detection is
4344 supported (i.<wbr/>e.<wbr/><code><a href="#static_android.statistics.info.maxFaceCount">android.<wbr/>statistics.<wbr/>info.<wbr/>max<wbr/>Face<wbr/>Count</a> &gt;
4345 0</code>).<wbr/></p>
4346             </td>
4347           </tr>
4348
4349
4350           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4351            <!-- end of entry -->
4352
4353
4354           <tr class="entry" id="static_android.control.availableVideoStabilizationModes">
4355             <td class="entry_name
4356              " rowspan="3">
4357               android.<wbr/>control.<wbr/>available<wbr/>Video<wbr/>Stabilization<wbr/>Modes
4358             </td>
4359             <td class="entry_type">
4360                 <span class="entry_type_name">byte</span>
4361                 <span class="entry_type_container">x</span>
4362
4363                 <span class="entry_type_array">
4364                   n
4365                 </span>
4366               <span class="entry_type_visibility"> [public as enumList]</span>
4367
4368
4369               <span class="entry_type_hwlevel">[legacy] </span>
4370
4371
4372                 <div class="entry_type_notes">List of enums.<wbr/></div>
4373
4374
4375             </td> <!-- entry_type -->
4376
4377             <td class="entry_description">
4378               <p>List of video stabilization modes for <a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>
4379 that are supported by this camera device.<wbr/></p>
4380             </td>
4381
4382             <td class="entry_units">
4383             </td>
4384
4385             <td class="entry_range">
4386               <p>Any value listed in <a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a></p>
4387             </td>
4388
4389             <td class="entry_tags">
4390               <ul class="entry_tags">
4391                   <li><a href="#tag_BC">BC</a></li>
4392               </ul>
4393             </td>
4394
4395           </tr>
4396           <tr class="entries_header">
4397             <th class="th_details" colspan="5">Details</th>
4398           </tr>
4399           <tr class="entry_cont">
4400             <td class="entry_details" colspan="5">
4401               <p>OFF will always be listed.<wbr/></p>
4402             </td>
4403           </tr>
4404
4405
4406           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4407            <!-- end of entry -->
4408
4409
4410           <tr class="entry" id="static_android.control.awbAvailableModes">
4411             <td class="entry_name
4412              " rowspan="3">
4413               android.<wbr/>control.<wbr/>awb<wbr/>Available<wbr/>Modes
4414             </td>
4415             <td class="entry_type">
4416                 <span class="entry_type_name">byte</span>
4417                 <span class="entry_type_container">x</span>
4418
4419                 <span class="entry_type_array">
4420                   n
4421                 </span>
4422               <span class="entry_type_visibility"> [public as enumList]</span>
4423
4424
4425               <span class="entry_type_hwlevel">[legacy] </span>
4426
4427
4428                 <div class="entry_type_notes">List of enums</div>
4429
4430
4431             </td> <!-- entry_type -->
4432
4433             <td class="entry_description">
4434               <p>List of auto-white-balance modes for <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> that are supported by this
4435 camera device.<wbr/></p>
4436             </td>
4437
4438             <td class="entry_units">
4439             </td>
4440
4441             <td class="entry_range">
4442               <p>Any value listed in <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a></p>
4443             </td>
4444
4445             <td class="entry_tags">
4446               <ul class="entry_tags">
4447                   <li><a href="#tag_BC">BC</a></li>
4448               </ul>
4449             </td>
4450
4451           </tr>
4452           <tr class="entries_header">
4453             <th class="th_details" colspan="5">Details</th>
4454           </tr>
4455           <tr class="entry_cont">
4456             <td class="entry_details" colspan="5">
4457               <p>Not all the auto-white-balance modes may be supported by a
4458 given camera device.<wbr/> This entry lists the valid modes for
4459 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> for this camera device.<wbr/></p>
4460 <p>All camera devices will support ON mode.<wbr/></p>
4461 <p>Camera devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability will always support OFF
4462 mode,<wbr/> which enables application control of white balance,<wbr/> by using
4463 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a>(<a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> must be set to TRANSFORM_<wbr/>MATRIX).<wbr/> This includes all FULL
4464 mode camera devices.<wbr/></p>
4465             </td>
4466           </tr>
4467
4468
4469           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4470            <!-- end of entry -->
4471
4472
4473           <tr class="entry" id="static_android.control.maxRegions">
4474             <td class="entry_name
4475              " rowspan="1">
4476               android.<wbr/>control.<wbr/>max<wbr/>Regions
4477             </td>
4478             <td class="entry_type">
4479                 <span class="entry_type_name">int32</span>
4480                 <span class="entry_type_container">x</span>
4481
4482                 <span class="entry_type_array">
4483                   3
4484                 </span>
4485               <span class="entry_type_visibility"> [hidden]</span>
4486
4487
4488               <span class="entry_type_hwlevel">[legacy] </span>
4489
4490
4491
4492
4493             </td> <!-- entry_type -->
4494
4495             <td class="entry_description">
4496               <p>List of the maximum number of regions that can be used for metering in
4497 auto-exposure (AE),<wbr/> auto-white balance (AWB),<wbr/> and auto-focus (AF);
4498 this corresponds to the the maximum number of elements in
4499 <a href="#controls_android.control.aeRegions">android.<wbr/>control.<wbr/>ae<wbr/>Regions</a>,<wbr/> <a href="#controls_android.control.awbRegions">android.<wbr/>control.<wbr/>awb<wbr/>Regions</a>,<wbr/>
4500 and <a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a>.<wbr/></p>
4501             </td>
4502
4503             <td class="entry_units">
4504             </td>
4505
4506             <td class="entry_range">
4507               <p>Value must be &gt;= 0 for each element.<wbr/> For full-capability devices
4508 this value must be &gt;= 1 for AE and AF.<wbr/> The order of the elements is:
4509 <code>(AE,<wbr/> AWB,<wbr/> AF)</code>.<wbr/></p>
4510             </td>
4511
4512             <td class="entry_tags">
4513               <ul class="entry_tags">
4514                   <li><a href="#tag_BC">BC</a></li>
4515               </ul>
4516             </td>
4517
4518           </tr>
4519
4520
4521           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4522            <!-- end of entry -->
4523
4524
4525           <tr class="entry" id="static_android.control.maxRegionsAe">
4526             <td class="entry_name
4527              " rowspan="5">
4528               android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae
4529             </td>
4530             <td class="entry_type">
4531                 <span class="entry_type_name">int32</span>
4532
4533               <span class="entry_type_visibility"> [public]</span>
4534
4535               <span class="entry_type_synthetic">[synthetic] </span>
4536
4537               <span class="entry_type_hwlevel">[legacy] </span>
4538
4539
4540
4541
4542             </td> <!-- entry_type -->
4543
4544             <td class="entry_description">
4545               <p>The maximum number of metering regions that can be used by the auto-exposure (AE)
4546 routine.<wbr/></p>
4547             </td>
4548
4549             <td class="entry_units">
4550             </td>
4551
4552             <td class="entry_range">
4553               <p>Value will be &gt;= 0.<wbr/> For FULL-capability devices,<wbr/> this
4554 value will be &gt;= 1.<wbr/></p>
4555             </td>
4556
4557             <td class="entry_tags">
4558             </td>
4559
4560           </tr>
4561           <tr class="entries_header">
4562             <th class="th_details" colspan="5">Details</th>
4563           </tr>
4564           <tr class="entry_cont">
4565             <td class="entry_details" colspan="5">
4566               <p>This corresponds to the the maximum allowed number of elements in
4567 <a href="#controls_android.control.aeRegions">android.<wbr/>control.<wbr/>ae<wbr/>Regions</a>.<wbr/></p>
4568             </td>
4569           </tr>
4570
4571           <tr class="entries_header">
4572             <th class="th_details" colspan="5">HAL Implementation Details</th>
4573           </tr>
4574           <tr class="entry_cont">
4575             <td class="entry_details" colspan="5">
4576               <p>This entry is private to the framework.<wbr/> Fill in
4577 maxRegions to have this entry be automatically populated.<wbr/></p>
4578             </td>
4579           </tr>
4580
4581           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4582            <!-- end of entry -->
4583
4584
4585           <tr class="entry" id="static_android.control.maxRegionsAwb">
4586             <td class="entry_name
4587              " rowspan="5">
4588               android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb
4589             </td>
4590             <td class="entry_type">
4591                 <span class="entry_type_name">int32</span>
4592
4593               <span class="entry_type_visibility"> [public]</span>
4594
4595               <span class="entry_type_synthetic">[synthetic] </span>
4596
4597               <span class="entry_type_hwlevel">[legacy] </span>
4598
4599
4600
4601
4602             </td> <!-- entry_type -->
4603
4604             <td class="entry_description">
4605               <p>The maximum number of metering regions that can be used by the auto-white balance (AWB)
4606 routine.<wbr/></p>
4607             </td>
4608
4609             <td class="entry_units">
4610             </td>
4611
4612             <td class="entry_range">
4613               <p>Value will be &gt;= 0.<wbr/></p>
4614             </td>
4615
4616             <td class="entry_tags">
4617             </td>
4618
4619           </tr>
4620           <tr class="entries_header">
4621             <th class="th_details" colspan="5">Details</th>
4622           </tr>
4623           <tr class="entry_cont">
4624             <td class="entry_details" colspan="5">
4625               <p>This corresponds to the the maximum allowed number of elements in
4626 <a href="#controls_android.control.awbRegions">android.<wbr/>control.<wbr/>awb<wbr/>Regions</a>.<wbr/></p>
4627             </td>
4628           </tr>
4629
4630           <tr class="entries_header">
4631             <th class="th_details" colspan="5">HAL Implementation Details</th>
4632           </tr>
4633           <tr class="entry_cont">
4634             <td class="entry_details" colspan="5">
4635               <p>This entry is private to the framework.<wbr/> Fill in
4636 maxRegions to have this entry be automatically populated.<wbr/></p>
4637             </td>
4638           </tr>
4639
4640           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4641            <!-- end of entry -->
4642
4643
4644           <tr class="entry" id="static_android.control.maxRegionsAf">
4645             <td class="entry_name
4646              " rowspan="5">
4647               android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af
4648             </td>
4649             <td class="entry_type">
4650                 <span class="entry_type_name">int32</span>
4651
4652               <span class="entry_type_visibility"> [public]</span>
4653
4654               <span class="entry_type_synthetic">[synthetic] </span>
4655
4656               <span class="entry_type_hwlevel">[legacy] </span>
4657
4658
4659
4660
4661             </td> <!-- entry_type -->
4662
4663             <td class="entry_description">
4664               <p>The maximum number of metering regions that can be used by the auto-focus (AF) routine.<wbr/></p>
4665             </td>
4666
4667             <td class="entry_units">
4668             </td>
4669
4670             <td class="entry_range">
4671               <p>Value will be &gt;= 0.<wbr/> For FULL-capability devices,<wbr/> this
4672 value will be &gt;= 1.<wbr/></p>
4673             </td>
4674
4675             <td class="entry_tags">
4676             </td>
4677
4678           </tr>
4679           <tr class="entries_header">
4680             <th class="th_details" colspan="5">Details</th>
4681           </tr>
4682           <tr class="entry_cont">
4683             <td class="entry_details" colspan="5">
4684               <p>This corresponds to the the maximum allowed number of elements in
4685 <a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a>.<wbr/></p>
4686             </td>
4687           </tr>
4688
4689           <tr class="entries_header">
4690             <th class="th_details" colspan="5">HAL Implementation Details</th>
4691           </tr>
4692           <tr class="entry_cont">
4693             <td class="entry_details" colspan="5">
4694               <p>This entry is private to the framework.<wbr/> Fill in
4695 maxRegions to have this entry be automatically populated.<wbr/></p>
4696             </td>
4697           </tr>
4698
4699           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4700            <!-- end of entry -->
4701
4702
4703           <tr class="entry" id="static_android.control.sceneModeOverrides">
4704             <td class="entry_name
4705              " rowspan="5">
4706               android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides
4707             </td>
4708             <td class="entry_type">
4709                 <span class="entry_type_name">byte</span>
4710                 <span class="entry_type_container">x</span>
4711
4712                 <span class="entry_type_array">
4713                   3 x length(availableSceneModes)
4714                 </span>
4715               <span class="entry_type_visibility"> [system]</span>
4716
4717
4718               <span class="entry_type_hwlevel">[limited] </span>
4719
4720
4721
4722
4723             </td> <!-- entry_type -->
4724
4725             <td class="entry_description">
4726               <p>Ordered list of auto-exposure,<wbr/> auto-white balance,<wbr/> and auto-focus
4727 settings to use with each available scene mode.<wbr/></p>
4728             </td>
4729
4730             <td class="entry_units">
4731             </td>
4732
4733             <td class="entry_range">
4734               <p>For each available scene mode,<wbr/> the list must contain three
4735 entries containing the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
4736 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> values used
4737 by the camera device.<wbr/> The entry order is <code>(aeMode,<wbr/> awbMode,<wbr/> afMode)</code>
4738 where aeMode has the lowest index position.<wbr/></p>
4739             </td>
4740
4741             <td class="entry_tags">
4742               <ul class="entry_tags">
4743                   <li><a href="#tag_BC">BC</a></li>
4744               </ul>
4745             </td>
4746
4747           </tr>
4748           <tr class="entries_header">
4749             <th class="th_details" colspan="5">Details</th>
4750           </tr>
4751           <tr class="entry_cont">
4752             <td class="entry_details" colspan="5">
4753               <p>When a scene mode is enabled,<wbr/> the camera device is expected
4754 to override <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/> <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/>
4755 and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> with its preferred settings for
4756 that scene mode.<wbr/></p>
4757 <p>The order of this list matches that of availableSceneModes,<wbr/>
4758 with 3 entries for each mode.<wbr/>  The overrides listed
4759 for FACE_<wbr/>PRIORITY are ignored,<wbr/> since for that
4760 mode the application-set <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
4761 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> values are
4762 used instead,<wbr/> matching the behavior when <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a>
4763 is set to AUTO.<wbr/> It is recommended that the FACE_<wbr/>PRIORITY
4764 overrides should be set to 0.<wbr/></p>
4765 <p>For example,<wbr/> if availableSceneModes contains
4766 <code>(FACE_<wbr/>PRIORITY,<wbr/> ACTION,<wbr/> NIGHT)</code>,<wbr/>  then the camera framework
4767 expects sceneModeOverrides to have 9 entries formatted like:
4768 <code>(0,<wbr/> 0,<wbr/> 0,<wbr/> ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/> AUTO,<wbr/> CONTINUOUS_<wbr/>PICTURE,<wbr/>
4769 ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/> INCANDESCENT,<wbr/> AUTO)</code>.<wbr/></p>
4770             </td>
4771           </tr>
4772
4773           <tr class="entries_header">
4774             <th class="th_details" colspan="5">HAL Implementation Details</th>
4775           </tr>
4776           <tr class="entry_cont">
4777             <td class="entry_details" colspan="5">
4778               <p>To maintain backward compatibility,<wbr/> this list will be made available
4779 in the static metadata of the camera service.<wbr/>  The camera service will
4780 use these values to set <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
4781 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> when using a scene
4782 mode other than FACE_<wbr/>PRIORITY.<wbr/></p>
4783             </td>
4784           </tr>
4785
4786           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4787            <!-- end of entry -->
4788
4789
4790           <tr class="entry" id="static_android.control.availableHighSpeedVideoConfigurations">
4791             <td class="entry_name
4792              " rowspan="5">
4793               android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations
4794             </td>
4795             <td class="entry_type">
4796                 <span class="entry_type_name">int32</span>
4797                 <span class="entry_type_container">x</span>
4798
4799                 <span class="entry_type_array">
4800                   4 x n
4801                 </span>
4802               <span class="entry_type_visibility"> [hidden as highSpeedVideoConfiguration]</span>
4803
4804
4805               <span class="entry_type_hwlevel">[limited] </span>
4806
4807
4808
4809
4810             </td> <!-- entry_type -->
4811
4812             <td class="entry_description">
4813               <p>List of available high speed video size and fps range configurations
4814 supported by the camera device,<wbr/> in the format of (width,<wbr/> height,<wbr/> fps_<wbr/>min,<wbr/> fps_<wbr/>max).<wbr/></p>
4815             </td>
4816
4817             <td class="entry_units">
4818             </td>
4819
4820             <td class="entry_range">
4821               <p>For each configuration,<wbr/> the fps_<wbr/>max &gt;= 60fps.<wbr/></p>
4822             </td>
4823
4824             <td class="entry_tags">
4825               <ul class="entry_tags">
4826                   <li><a href="#tag_V1">V1</a></li>
4827               </ul>
4828             </td>
4829
4830           </tr>
4831           <tr class="entries_header">
4832             <th class="th_details" colspan="5">Details</th>
4833           </tr>
4834           <tr class="entry_cont">
4835             <td class="entry_details" colspan="5">
4836               <p>When HIGH_<wbr/>SPEED_<wbr/>VIDEO is supported in <a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a>,<wbr/>
4837 this metadata will list the supported high speed video size and fps range
4838 configurations.<wbr/> All the sizes listed in this configuration will be a subset
4839 of the sizes reported by StreamConfigurationMap#getOutputSizes for processed
4840 non-stalling formats.<wbr/></p>
4841 <p>For the high speed video use case,<wbr/> where the application will set
4842 <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a> to HIGH_<wbr/>SPEED_<wbr/>VIDEO in capture requests,<wbr/> the application must
4843 select the video size and fps range from this metadata to configure the recording and
4844 preview streams and setup the recording requests.<wbr/> For example,<wbr/> if the application intends
4845 to do high speed recording,<wbr/> it can select the maximum size reported by this metadata to
4846 configure output streams.<wbr/> Once the size is selected,<wbr/> application can filter this metadata
4847 by selected size and get the supported fps ranges,<wbr/> and use these fps ranges to setup the
4848 recording requests.<wbr/> Note that for the use case of multiple output streams,<wbr/> application
4849 must select one unique size from this metadata to use.<wbr/> Otherwise a request error might
4850 occur.<wbr/></p>
4851 <p>For normal video recording use case,<wbr/> where some application will NOT set
4852 <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a> to HIGH_<wbr/>SPEED_<wbr/>VIDEO in capture requests,<wbr/> the fps ranges
4853 reported in this metadata must not be used to setup capture requests,<wbr/> or it will cause
4854 request error.<wbr/></p>
4855             </td>
4856           </tr>
4857
4858           <tr class="entries_header">
4859             <th class="th_details" colspan="5">HAL Implementation Details</th>
4860           </tr>
4861           <tr class="entry_cont">
4862             <td class="entry_details" colspan="5">
4863               <p>All the sizes listed in this configuration will be a subset of the sizes reported by
4864 <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a> for processed non-stalling output formats.<wbr/>
4865 Note that for all high speed video configurations,<wbr/> HAL must be able to support a minimum
4866 of two streams,<wbr/> though the application might choose to configure just one stream.<wbr/></p>
4867 <p>Since the HIGH_<wbr/>SPEED_<wbr/>VIDEO mode may be turned on for preview view only case,<wbr/> the preview
4868 fps is bounded by device refresh rate (e.<wbr/>g.<wbr/> 60fps).<wbr/> For a given resolution,<wbr/> it is
4869 recommended that this list includes some fps ranges (e.<wbr/>g.<wbr/> [30,<wbr/> 60]) that is suitable
4870 for preview only streaming case.<wbr/></p>
4871             </td>
4872           </tr>
4873
4874           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4875            <!-- end of entry -->
4876
4877
4878
4879       <!-- end of kind -->
4880       </tbody>
4881       <tr><td colspan="6" class="kind">dynamic</td></tr>
4882
4883       <thead class="entries_header">
4884         <tr>
4885           <th class="th_name">Property Name</th>
4886           <th class="th_type">Type</th>
4887           <th class="th_description">Description</th>
4888           <th class="th_units">Units</th>
4889           <th class="th_range">Range</th>
4890           <th class="th_tags">Tags</th>
4891         </tr>
4892       </thead>
4893
4894       <tbody>
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905           <tr class="entry" id="dynamic_android.control.aePrecaptureId">
4906             <td class="entry_name
4907                 entry_name_deprecated
4908              " rowspan="3">
4909               android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Id
4910             </td>
4911             <td class="entry_type">
4912                 <span class="entry_type_name">int32</span>
4913
4914               <span class="entry_type_visibility"> [system]</span>
4915
4916
4917
4918               <span class="entry_type_deprecated">[deprecated] </span>
4919
4920
4921
4922             </td> <!-- entry_type -->
4923
4924             <td class="entry_description">
4925               <p>The ID sent with the latest
4926 CAMERA2_<wbr/>TRIGGER_<wbr/>PRECAPTURE_<wbr/>METERING call</p>
4927             </td>
4928
4929             <td class="entry_units">
4930             </td>
4931
4932             <td class="entry_range">
4933               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
4934             </td>
4935
4936             <td class="entry_tags">
4937             </td>
4938
4939           </tr>
4940           <tr class="entries_header">
4941             <th class="th_details" colspan="5">Details</th>
4942           </tr>
4943           <tr class="entry_cont">
4944             <td class="entry_details" colspan="5">
4945               <p>Must be 0 if no
4946 CAMERA2_<wbr/>TRIGGER_<wbr/>PRECAPTURE_<wbr/>METERING trigger received yet
4947 by HAL.<wbr/> Always updated even if AE algorithm ignores the
4948 trigger</p>
4949             </td>
4950           </tr>
4951
4952
4953           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4954            <!-- end of entry -->
4955
4956
4957           <tr class="entry" id="dynamic_android.control.aeAntibandingMode">
4958             <td class="entry_name
4959              " rowspan="5">
4960               android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode
4961             </td>
4962             <td class="entry_type">
4963                 <span class="entry_type_name entry_type_name_enum">byte</span>
4964
4965               <span class="entry_type_visibility"> [public]</span>
4966
4967
4968               <span class="entry_type_hwlevel">[legacy] </span>
4969
4970
4971
4972                 <ul class="entry_type_enum">
4973                   <li>
4974                     <span class="entry_type_enum_name">OFF</span>
4975                     <span class="entry_type_enum_notes"><p>The camera device will not adjust exposure duration to
4976 avoid banding problems.<wbr/></p></span>
4977                   </li>
4978                   <li>
4979                     <span class="entry_type_enum_name">50HZ</span>
4980                     <span class="entry_type_enum_notes"><p>The camera device will adjust exposure duration to
4981 avoid banding problems with 50Hz illumination sources.<wbr/></p></span>
4982                   </li>
4983                   <li>
4984                     <span class="entry_type_enum_name">60HZ</span>
4985                     <span class="entry_type_enum_notes"><p>The camera device will adjust exposure duration to
4986 avoid banding problems with 60Hz illumination
4987 sources.<wbr/></p></span>
4988                   </li>
4989                   <li>
4990                     <span class="entry_type_enum_name">AUTO</span>
4991                     <span class="entry_type_enum_notes"><p>The camera device will automatically adapt its
4992 antibanding routine to the current illumination
4993 conditions.<wbr/> This is the default.<wbr/></p></span>
4994                   </li>
4995                 </ul>
4996
4997             </td> <!-- entry_type -->
4998
4999             <td class="entry_description">
5000               <p>The desired setting for the camera device's auto-exposure
5001 algorithm's antibanding compensation.<wbr/></p>
5002             </td>
5003
5004             <td class="entry_units">
5005             </td>
5006
5007             <td class="entry_range">
5008               <p><a href="#static_android.control.aeAvailableAntibandingModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes</a></p>
5009             </td>
5010
5011             <td class="entry_tags">
5012               <ul class="entry_tags">
5013                   <li><a href="#tag_BC">BC</a></li>
5014               </ul>
5015             </td>
5016
5017           </tr>
5018           <tr class="entries_header">
5019             <th class="th_details" colspan="5">Details</th>
5020           </tr>
5021           <tr class="entry_cont">
5022             <td class="entry_details" colspan="5">
5023               <p>Some kinds of lighting fixtures,<wbr/> such as some fluorescent
5024 lights,<wbr/> flicker at the rate of the power supply frequency
5025 (60Hz or 50Hz,<wbr/> depending on country).<wbr/> While this is
5026 typically not noticeable to a person,<wbr/> it can be visible to
5027 a camera device.<wbr/> If a camera sets its exposure time to the
5028 wrong value,<wbr/> the flicker may become visible in the
5029 viewfinder as flicker or in a final captured image,<wbr/> as a
5030 set of variable-brightness bands across the image.<wbr/></p>
5031 <p>Therefore,<wbr/> the auto-exposure routines of camera devices
5032 include antibanding routines that ensure that the chosen
5033 exposure value will not cause such banding.<wbr/> The choice of
5034 exposure time depends on the rate of flicker,<wbr/> which the
5035 camera device can detect automatically,<wbr/> or the expected
5036 rate can be selected by the application using this
5037 control.<wbr/></p>
5038 <p>A given camera device may not support all of the possible
5039 options for the antibanding mode.<wbr/> The
5040 <a href="#static_android.control.aeAvailableAntibandingModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes</a> key contains
5041 the available modes for a given camera device.<wbr/></p>
5042 <p>The default mode is AUTO,<wbr/> which is supported by all
5043 camera devices.<wbr/></p>
5044 <p>If manual exposure control is enabled (by setting
5045 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> to OFF),<wbr/>
5046 then this setting has no effect,<wbr/> and the application must
5047 ensure it selects exposure times that do not cause banding
5048 issues.<wbr/> The <a href="#dynamic_android.statistics.sceneFlicker">android.<wbr/>statistics.<wbr/>scene<wbr/>Flicker</a> key can assist
5049 the application in this.<wbr/></p>
5050             </td>
5051           </tr>
5052
5053           <tr class="entries_header">
5054             <th class="th_details" colspan="5">HAL Implementation Details</th>
5055           </tr>
5056           <tr class="entry_cont">
5057             <td class="entry_details" colspan="5">
5058               <p>For all capture request templates,<wbr/> this field must be set
5059 to AUTO.<wbr/>  AUTO is the only mode that must supported;
5060 OFF,<wbr/> 50HZ,<wbr/> 60HZ are all optional.<wbr/></p>
5061 <p>If manual exposure control is enabled (by setting
5062 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> to OFF),<wbr/>
5063 then the exposure values provided by the application must not be
5064 adjusted for antibanding.<wbr/></p>
5065             </td>
5066           </tr>
5067
5068           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5069            <!-- end of entry -->
5070
5071
5072           <tr class="entry" id="dynamic_android.control.aeExposureCompensation">
5073             <td class="entry_name
5074              " rowspan="3">
5075               android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation
5076             </td>
5077             <td class="entry_type">
5078                 <span class="entry_type_name">int32</span>
5079
5080               <span class="entry_type_visibility"> [public]</span>
5081
5082
5083               <span class="entry_type_hwlevel">[legacy] </span>
5084
5085
5086
5087
5088             </td> <!-- entry_type -->
5089
5090             <td class="entry_description">
5091               <p>Adjustment to auto-exposure (AE) target image
5092 brightness.<wbr/></p>
5093             </td>
5094
5095             <td class="entry_units">
5096               Compensation steps
5097             </td>
5098
5099             <td class="entry_range">
5100               <p><a href="#static_android.control.aeCompensationRange">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range</a></p>
5101             </td>
5102
5103             <td class="entry_tags">
5104               <ul class="entry_tags">
5105                   <li><a href="#tag_BC">BC</a></li>
5106               </ul>
5107             </td>
5108
5109           </tr>
5110           <tr class="entries_header">
5111             <th class="th_details" colspan="5">Details</th>
5112           </tr>
5113           <tr class="entry_cont">
5114             <td class="entry_details" colspan="5">
5115               <p>The adjustment is measured as a count of steps,<wbr/> with the
5116 step size defined by <a href="#static_android.control.aeCompensationStep">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step</a> and the
5117 allowed range by <a href="#static_android.control.aeCompensationRange">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range</a>.<wbr/></p>
5118 <p>For example,<wbr/> if the exposure value (EV) step is 0.<wbr/>333,<wbr/> '6'
5119 will mean an exposure compensation of +2 EV; -3 will mean an
5120 exposure compensation of -1 EV.<wbr/> One EV represents a doubling
5121 of image brightness.<wbr/> Note that this control will only be
5122 effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>!=</code> OFF.<wbr/> This control
5123 will take effect even when <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> <code>== true</code>.<wbr/></p>
5124 <p>In the event of exposure compensation value being changed,<wbr/> camera device
5125 may take several frames to reach the newly requested exposure target.<wbr/>
5126 During that time,<wbr/> <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> field will be in the SEARCHING
5127 state.<wbr/> Once the new exposure target is reached,<wbr/> <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> will
5128 change from SEARCHING to either CONVERGED,<wbr/> LOCKED (if AE lock is enabled),<wbr/> or
5129 FLASH_<wbr/>REQUIRED (if the scene is too dark for still capture).<wbr/></p>
5130             </td>
5131           </tr>
5132
5133
5134           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5135            <!-- end of entry -->
5136
5137
5138           <tr class="entry" id="dynamic_android.control.aeLock">
5139             <td class="entry_name
5140              " rowspan="3">
5141               android.<wbr/>control.<wbr/>ae<wbr/>Lock
5142             </td>
5143             <td class="entry_type">
5144                 <span class="entry_type_name entry_type_name_enum">byte</span>
5145
5146               <span class="entry_type_visibility"> [public as boolean]</span>
5147
5148
5149               <span class="entry_type_hwlevel">[legacy] </span>
5150
5151
5152
5153                 <ul class="entry_type_enum">
5154                   <li>
5155                     <span class="entry_type_enum_name">OFF</span>
5156                     <span class="entry_type_enum_notes"><p>Auto-exposure lock is disabled; the AE algorithm
5157 is free to update its parameters.<wbr/></p></span>
5158                   </li>
5159                   <li>
5160                     <span class="entry_type_enum_name">ON</span>
5161                     <span class="entry_type_enum_notes"><p>Auto-exposure lock is enabled; the AE algorithm
5162 must not update the exposure and sensitivity parameters
5163 while the lock is active.<wbr/></p>
5164 <p><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a> setting changes
5165 will still take effect while auto-exposure is locked.<wbr/></p>
5166 <p>Some rare LEGACY devices may not support
5167 this,<wbr/> in which case the value will always be overridden to OFF.<wbr/></p></span>
5168                   </li>
5169                 </ul>
5170
5171             </td> <!-- entry_type -->
5172
5173             <td class="entry_description">
5174               <p>Whether auto-exposure (AE) is currently locked to its latest
5175 calculated values.<wbr/></p>
5176             </td>
5177
5178             <td class="entry_units">
5179             </td>
5180
5181             <td class="entry_range">
5182             </td>
5183
5184             <td class="entry_tags">
5185               <ul class="entry_tags">
5186                   <li><a href="#tag_BC">BC</a></li>
5187               </ul>
5188             </td>
5189
5190           </tr>
5191           <tr class="entries_header">
5192             <th class="th_details" colspan="5">Details</th>
5193           </tr>
5194           <tr class="entry_cont">
5195             <td class="entry_details" colspan="5">
5196               <p>When set to <code>true</code> (ON),<wbr/> the AE algorithm is locked to its latest parameters,<wbr/>
5197 and will not change exposure settings until the lock is set to <code>false</code> (OFF).<wbr/></p>
5198 <p>Note that even when AE is locked,<wbr/> the flash may be fired if
5199 the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is ON_<wbr/>AUTO_<wbr/>FLASH /<wbr/>
5200 ON_<wbr/>ALWAYS_<wbr/>FLASH /<wbr/> ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE.<wbr/></p>
5201 <p>When <a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a> is changed,<wbr/> even if the AE lock
5202 is ON,<wbr/> the camera device will still adjust its exposure value.<wbr/></p>
5203 <p>If AE precapture is triggered (see <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>)
5204 when AE is already locked,<wbr/> the camera device will not change the exposure time
5205 (<a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>) and sensitivity (<a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>)
5206 parameters.<wbr/> The flash may be fired if the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>
5207 is ON_<wbr/>AUTO_<wbr/>FLASH/<wbr/>ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE and the scene is too dark.<wbr/> If the
5208 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is ON_<wbr/>ALWAYS_<wbr/>FLASH,<wbr/> the scene may become overexposed.<wbr/></p>
5209 <p>Since the camera device has a pipeline of in-flight requests,<wbr/> the settings that
5210 get locked do not necessarily correspond to the settings that were present in the
5211 latest capture result received from the camera device,<wbr/> since additional captures
5212 and AE updates may have occurred even before the result was sent out.<wbr/> If an
5213 application is switching between automatic and manual control and wishes to eliminate
5214 any flicker during the switch,<wbr/> the following procedure is recommended:</p>
5215 <ol>
5216 <li>Starting in auto-AE mode:</li>
5217 <li>Lock AE</li>
5218 <li>Wait for the first result to be output that has the AE locked</li>
5219 <li>Copy exposure settings from that result into a request,<wbr/> set the request to manual AE</li>
5220 <li>Submit the capture request,<wbr/> proceed to run manual AE as desired.<wbr/></li>
5221 </ol>
5222 <p>See <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> for AE lock related state transition details.<wbr/></p>
5223             </td>
5224           </tr>
5225
5226
5227           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5228            <!-- end of entry -->
5229
5230
5231           <tr class="entry" id="dynamic_android.control.aeMode">
5232             <td class="entry_name
5233              " rowspan="3">
5234               android.<wbr/>control.<wbr/>ae<wbr/>Mode
5235             </td>
5236             <td class="entry_type">
5237                 <span class="entry_type_name entry_type_name_enum">byte</span>
5238
5239               <span class="entry_type_visibility"> [public]</span>
5240
5241
5242               <span class="entry_type_hwlevel">[legacy] </span>
5243
5244
5245
5246                 <ul class="entry_type_enum">
5247                   <li>
5248                     <span class="entry_type_enum_name">OFF</span>
5249                     <span class="entry_type_enum_notes"><p>The camera device's autoexposure routine is disabled.<wbr/></p>
5250 <p>The application-selected <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
5251 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a> and
5252 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> are used by the camera
5253 device,<wbr/> along with android.<wbr/>flash.<wbr/>* fields,<wbr/> if there's
5254 a flash unit for this camera device.<wbr/></p>
5255 <p>LEGACY devices do not support the OFF mode and will
5256 override attempts to use this value to ON.<wbr/></p></span>
5257                   </li>
5258                   <li>
5259                     <span class="entry_type_enum_name">ON</span>
5260                     <span class="entry_type_enum_notes"><p>The camera device's autoexposure routine is active,<wbr/>
5261 with no flash control.<wbr/></p>
5262 <p>The application's values for
5263 <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
5264 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> and
5265 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> are ignored.<wbr/> The
5266 application has control over the various
5267 android.<wbr/>flash.<wbr/>* fields.<wbr/></p></span>
5268                   </li>
5269                   <li>
5270                     <span class="entry_type_enum_name">ON_AUTO_FLASH</span>
5271                     <span class="entry_type_enum_notes"><p>Like ON,<wbr/> except that the camera device also controls
5272 the camera's flash unit,<wbr/> firing it in low-light
5273 conditions.<wbr/></p>
5274 <p>The flash may be fired during a precapture sequence
5275 (triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>) and
5276 may be fired for captures for which the
5277 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> field is set to
5278 STILL_<wbr/>CAPTURE</p></span>
5279                   </li>
5280                   <li>
5281                     <span class="entry_type_enum_name">ON_ALWAYS_FLASH</span>
5282                     <span class="entry_type_enum_notes"><p>Like ON,<wbr/> except that the camera device also controls
5283 the camera's flash unit,<wbr/> always firing it for still
5284 captures.<wbr/></p>
5285 <p>The flash may be fired during a precapture sequence
5286 (triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>) and
5287 will always be fired for captures for which the
5288 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> field is set to
5289 STILL_<wbr/>CAPTURE</p></span>
5290                   </li>
5291                   <li>
5292                     <span class="entry_type_enum_name">ON_AUTO_FLASH_REDEYE</span>
5293                     <span class="entry_type_enum_notes"><p>Like ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/> but with automatic red eye
5294 reduction.<wbr/></p>
5295 <p>If deemed necessary by the camera device,<wbr/> a red eye
5296 reduction flash will fire during the precapture
5297 sequence.<wbr/></p></span>
5298                   </li>
5299                 </ul>
5300
5301             </td> <!-- entry_type -->
5302
5303             <td class="entry_description">
5304               <p>The desired mode for the camera device's
5305 auto-exposure routine.<wbr/></p>
5306             </td>
5307
5308             <td class="entry_units">
5309             </td>
5310
5311             <td class="entry_range">
5312               <p><a href="#static_android.control.aeAvailableModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Modes</a></p>
5313             </td>
5314
5315             <td class="entry_tags">
5316               <ul class="entry_tags">
5317                   <li><a href="#tag_BC">BC</a></li>
5318               </ul>
5319             </td>
5320
5321           </tr>
5322           <tr class="entries_header">
5323             <th class="th_details" colspan="5">Details</th>
5324           </tr>
5325           <tr class="entry_cont">
5326             <td class="entry_details" colspan="5">
5327               <p>This control is only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is
5328 AUTO.<wbr/></p>
5329 <p>When set to any of the ON modes,<wbr/> the camera device's
5330 auto-exposure routine is enabled,<wbr/> overriding the
5331 application's selected exposure time,<wbr/> sensor sensitivity,<wbr/>
5332 and frame duration (<a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
5333 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> and
5334 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>).<wbr/> If one of the FLASH modes
5335 is selected,<wbr/> the camera device's flash unit controls are
5336 also overridden.<wbr/></p>
5337 <p>The FLASH modes are only available if the camera device
5338 has a flash unit (<a href="#static_android.flash.info.available">android.<wbr/>flash.<wbr/>info.<wbr/>available</a> is <code>true</code>).<wbr/></p>
5339 <p>If flash TORCH mode is desired,<wbr/> this field must be set to
5340 ON or OFF,<wbr/> and <a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> set to TORCH.<wbr/></p>
5341 <p>When set to any of the ON modes,<wbr/> the values chosen by the
5342 camera device auto-exposure routine for the overridden
5343 fields for a given capture will be available in its
5344 CaptureResult.<wbr/></p>
5345             </td>
5346           </tr>
5347
5348
5349           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5350            <!-- end of entry -->
5351
5352
5353           <tr class="entry" id="dynamic_android.control.aeRegions">
5354             <td class="entry_name
5355              " rowspan="5">
5356               android.<wbr/>control.<wbr/>ae<wbr/>Regions
5357             </td>
5358             <td class="entry_type">
5359                 <span class="entry_type_name">int32</span>
5360                 <span class="entry_type_container">x</span>
5361
5362                 <span class="entry_type_array">
5363                   5 x area_count
5364                 </span>
5365               <span class="entry_type_visibility"> [public as meteringRectangle]</span>
5366
5367
5368
5369
5370
5371
5372             </td> <!-- entry_type -->
5373
5374             <td class="entry_description">
5375               <p>List of metering areas to use for auto-exposure adjustment.<wbr/></p>
5376             </td>
5377
5378             <td class="entry_units">
5379               Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
5380             </td>
5381
5382             <td class="entry_range">
5383               <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
5384 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
5385             </td>
5386
5387             <td class="entry_tags">
5388               <ul class="entry_tags">
5389                   <li><a href="#tag_BC">BC</a></li>
5390               </ul>
5391             </td>
5392
5393           </tr>
5394           <tr class="entries_header">
5395             <th class="th_details" colspan="5">Details</th>
5396           </tr>
5397           <tr class="entry_cont">
5398             <td class="entry_details" colspan="5">
5399               <p>Not available if <a href="#static_android.control.maxRegionsAe">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae</a> is 0.<wbr/>
5400 Otherwise will always be present.<wbr/></p>
5401 <p>The maximum number of regions supported by the device is determined by the value
5402 of <a href="#static_android.control.maxRegionsAe">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae</a>.<wbr/></p>
5403 <p>The coordinate system is based on the active pixel array,<wbr/>
5404 with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
5405 (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
5406 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
5407 bottom-right pixel in the active pixel array.<wbr/></p>
5408 <p>The weight must be within <code>[0,<wbr/> 1000]</code>,<wbr/> and represents a weight
5409 for every pixel in the area.<wbr/> This means that a large metering area
5410 with the same weight as a smaller area will have more effect in
5411 the metering result.<wbr/> Metering areas can partially overlap and the
5412 camera device will add the weights in the overlap region.<wbr/></p>
5413 <p>The weights are relative to weights of other exposure metering regions,<wbr/> so if only one
5414 region is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with 0
5415 weight is ignored.<wbr/></p>
5416 <p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
5417 camera device.<wbr/></p>
5418 <p>If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> returned in
5419 capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
5420 region and output only the intersection rectangle as the metering region in the result
5421 metadata.<wbr/>  If the region is entirely outside the crop region,<wbr/> it will be ignored and
5422 not reported in the result metadata.<wbr/></p>
5423             </td>
5424           </tr>
5425
5426           <tr class="entries_header">
5427             <th class="th_details" colspan="5">HAL Implementation Details</th>
5428           </tr>
5429           <tr class="entry_cont">
5430             <td class="entry_details" colspan="5">
5431               <p>The HAL level representation of MeteringRectangle[] is a
5432 int[5 * area_<wbr/>count].<wbr/>
5433 Every five elements represent a metering region of
5434 (xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
5435 The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
5436 exclusive on xmax and ymax.<wbr/></p>
5437             </td>
5438           </tr>
5439
5440           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5441            <!-- end of entry -->
5442
5443
5444           <tr class="entry" id="dynamic_android.control.aeTargetFpsRange">
5445             <td class="entry_name
5446              " rowspan="3">
5447               android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range
5448             </td>
5449             <td class="entry_type">
5450                 <span class="entry_type_name">int32</span>
5451                 <span class="entry_type_container">x</span>
5452
5453                 <span class="entry_type_array">
5454                   2
5455                 </span>
5456               <span class="entry_type_visibility"> [public as rangeInt]</span>
5457
5458
5459               <span class="entry_type_hwlevel">[legacy] </span>
5460
5461
5462
5463
5464             </td> <!-- entry_type -->
5465
5466             <td class="entry_description">
5467               <p>Range over which the auto-exposure routine can
5468 adjust the capture frame rate to maintain good
5469 exposure.<wbr/></p>
5470             </td>
5471
5472             <td class="entry_units">
5473               Frames per second (FPS)
5474             </td>
5475
5476             <td class="entry_range">
5477               <p>Any of the entries in <a href="#static_android.control.aeAvailableTargetFpsRanges">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Target<wbr/>Fps<wbr/>Ranges</a></p>
5478             </td>
5479
5480             <td class="entry_tags">
5481               <ul class="entry_tags">
5482                   <li><a href="#tag_BC">BC</a></li>
5483               </ul>
5484             </td>
5485
5486           </tr>
5487           <tr class="entries_header">
5488             <th class="th_details" colspan="5">Details</th>
5489           </tr>
5490           <tr class="entry_cont">
5491             <td class="entry_details" colspan="5">
5492               <p>Only constrains auto-exposure (AE) algorithm,<wbr/> not
5493 manual control of <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a> and
5494 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>.<wbr/></p>
5495             </td>
5496           </tr>
5497
5498
5499           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5500            <!-- end of entry -->
5501
5502
5503           <tr class="entry" id="dynamic_android.control.aePrecaptureTrigger">
5504             <td class="entry_name
5505              " rowspan="3">
5506               android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger
5507             </td>
5508             <td class="entry_type">
5509                 <span class="entry_type_name entry_type_name_enum">byte</span>
5510
5511               <span class="entry_type_visibility"> [public]</span>
5512
5513
5514               <span class="entry_type_hwlevel">[limited] </span>
5515
5516
5517
5518                 <ul class="entry_type_enum">
5519                   <li>
5520                     <span class="entry_type_enum_name">IDLE</span>
5521                     <span class="entry_type_enum_notes"><p>The trigger is idle.<wbr/></p></span>
5522                   </li>
5523                   <li>
5524                     <span class="entry_type_enum_name">START</span>
5525                     <span class="entry_type_enum_notes"><p>The precapture metering sequence will be started
5526 by the camera device.<wbr/></p>
5527 <p>The exact effect of the precapture trigger depends on
5528 the current AE mode and state.<wbr/></p></span>
5529                   </li>
5530                 </ul>
5531
5532             </td> <!-- entry_type -->
5533
5534             <td class="entry_description">
5535               <p>Whether the camera device will trigger a precapture
5536 metering sequence when it processes this request.<wbr/></p>
5537             </td>
5538
5539             <td class="entry_units">
5540             </td>
5541
5542             <td class="entry_range">
5543             </td>
5544
5545             <td class="entry_tags">
5546               <ul class="entry_tags">
5547                   <li><a href="#tag_BC">BC</a></li>
5548               </ul>
5549             </td>
5550
5551           </tr>
5552           <tr class="entries_header">
5553             <th class="th_details" colspan="5">Details</th>
5554           </tr>
5555           <tr class="entry_cont">
5556             <td class="entry_details" colspan="5">
5557               <p>This entry is normally set to IDLE,<wbr/> or is not
5558 included at all in the request settings.<wbr/> When included and
5559 set to START,<wbr/> the camera device will trigger the autoexposure
5560 precapture metering sequence.<wbr/></p>
5561 <p>The precapture sequence should triggered before starting a
5562 high-quality still capture for final metering decisions to
5563 be made,<wbr/> and for firing pre-capture flash pulses to estimate
5564 scene brightness and required final capture flash power,<wbr/> when
5565 the flash is enabled.<wbr/></p>
5566 <p>Normally,<wbr/> this entry should be set to START for only a
5567 single request,<wbr/> and the application should wait until the
5568 sequence completes before starting a new one.<wbr/></p>
5569 <p>The exact effect of auto-exposure (AE) precapture trigger
5570 depends on the current AE mode and state; see
5571 <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> for AE precapture state transition
5572 details.<wbr/></p>
5573 <p>On LEGACY-level devices,<wbr/> the precapture trigger is not supported;
5574 capturing a high-resolution JPEG image will automatically trigger a
5575 precapture sequence before the high-resolution capture,<wbr/> including
5576 potentially firing a pre-capture flash.<wbr/></p>
5577             </td>
5578           </tr>
5579
5580
5581           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5582            <!-- end of entry -->
5583
5584
5585           <tr class="entry" id="dynamic_android.control.aeState">
5586             <td class="entry_name
5587              " rowspan="3">
5588               android.<wbr/>control.<wbr/>ae<wbr/>State
5589             </td>
5590             <td class="entry_type">
5591                 <span class="entry_type_name entry_type_name_enum">byte</span>
5592
5593               <span class="entry_type_visibility"> [public]</span>
5594
5595
5596               <span class="entry_type_hwlevel">[limited] </span>
5597
5598
5599
5600                 <ul class="entry_type_enum">
5601                   <li>
5602                     <span class="entry_type_enum_name">INACTIVE</span>
5603                     <span class="entry_type_enum_notes"><p>AE is off or recently reset.<wbr/></p>
5604 <p>When a camera device is opened,<wbr/> it starts in
5605 this state.<wbr/> This is a transient state,<wbr/> the camera device may skip reporting
5606 this state in capture result.<wbr/></p></span>
5607                   </li>
5608                   <li>
5609                     <span class="entry_type_enum_name">SEARCHING</span>
5610                     <span class="entry_type_enum_notes"><p>AE doesn't yet have a good set of control values
5611 for the current scene.<wbr/></p>
5612 <p>This is a transient state,<wbr/> the camera device may skip
5613 reporting this state in capture result.<wbr/></p></span>
5614                   </li>
5615                   <li>
5616                     <span class="entry_type_enum_name">CONVERGED</span>
5617                     <span class="entry_type_enum_notes"><p>AE has a good set of control values for the
5618 current scene.<wbr/></p></span>
5619                   </li>
5620                   <li>
5621                     <span class="entry_type_enum_name">LOCKED</span>
5622                     <span class="entry_type_enum_notes"><p>AE has been locked.<wbr/></p></span>
5623                   </li>
5624                   <li>
5625                     <span class="entry_type_enum_name">FLASH_REQUIRED</span>
5626                     <span class="entry_type_enum_notes"><p>AE has a good set of control values,<wbr/> but flash
5627 needs to be fired for good quality still
5628 capture.<wbr/></p></span>
5629                   </li>
5630                   <li>
5631                     <span class="entry_type_enum_name">PRECAPTURE</span>
5632                     <span class="entry_type_enum_notes"><p>AE has been asked to do a precapture sequence
5633 and is currently executing it.<wbr/></p>
5634 <p>Precapture can be triggered through setting
5635 <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> to START.<wbr/></p>
5636 <p>Once PRECAPTURE completes,<wbr/> AE will transition to CONVERGED
5637 or FLASH_<wbr/>REQUIRED as appropriate.<wbr/> This is a transient
5638 state,<wbr/> the camera device may skip reporting this state in
5639 capture result.<wbr/></p></span>
5640                   </li>
5641                 </ul>
5642
5643             </td> <!-- entry_type -->
5644
5645             <td class="entry_description">
5646               <p>Current state of the auto-exposure (AE) algorithm.<wbr/></p>
5647             </td>
5648
5649             <td class="entry_units">
5650             </td>
5651
5652             <td class="entry_range">
5653             </td>
5654
5655             <td class="entry_tags">
5656             </td>
5657
5658           </tr>
5659           <tr class="entries_header">
5660             <th class="th_details" colspan="5">Details</th>
5661           </tr>
5662           <tr class="entry_cont">
5663             <td class="entry_details" colspan="5">
5664               <p>Switching between or enabling AE modes (<a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>) always
5665 resets the AE state to INACTIVE.<wbr/> Similarly,<wbr/> switching between <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a>,<wbr/>
5666 or <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a> if <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == USE_<wbr/>SCENE_<wbr/>MODE</code> resets all
5667 the algorithm states to INACTIVE.<wbr/></p>
5668 <p>The camera device can do several state transitions between two results,<wbr/> if it is
5669 allowed by the state transition table.<wbr/> For example: INACTIVE may never actually be
5670 seen in a result.<wbr/></p>
5671 <p>The state in the result is the state for this image (in sync with this image): if
5672 AE state becomes CONVERGED,<wbr/> then the image data associated with this result should
5673 be good to use.<wbr/></p>
5674 <p>Below are state transition tables for different AE modes.<wbr/></p>
5675 <table>
5676 <thead>
5677 <tr>
5678 <th align="center">State</th>
5679 <th align="center">Transition Cause</th>
5680 <th align="center">New State</th>
5681 <th align="center">Notes</th>
5682 </tr>
5683 </thead>
5684 <tbody>
5685 <tr>
5686 <td align="center">INACTIVE</td>
5687 <td align="center"></td>
5688 <td align="center">INACTIVE</td>
5689 <td align="center">Camera device auto exposure algorithm is disabled</td>
5690 </tr>
5691 </tbody>
5692 </table>
5693 <p>When <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is AE_<wbr/>MODE_<wbr/>ON_<wbr/>*:</p>
5694 <table>
5695 <thead>
5696 <tr>
5697 <th align="center">State</th>
5698 <th align="center">Transition Cause</th>
5699 <th align="center">New State</th>
5700 <th align="center">Notes</th>
5701 </tr>
5702 </thead>
5703 <tbody>
5704 <tr>
5705 <td align="center">INACTIVE</td>
5706 <td align="center">Camera device initiates AE scan</td>
5707 <td align="center">SEARCHING</td>
5708 <td align="center">Values changing</td>
5709 </tr>
5710 <tr>
5711 <td align="center">INACTIVE</td>
5712 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
5713 <td align="center">LOCKED</td>
5714 <td align="center">Values locked</td>
5715 </tr>
5716 <tr>
5717 <td align="center">SEARCHING</td>
5718 <td align="center">Camera device finishes AE scan</td>
5719 <td align="center">CONVERGED</td>
5720 <td align="center">Good values,<wbr/> not changing</td>
5721 </tr>
5722 <tr>
5723 <td align="center">SEARCHING</td>
5724 <td align="center">Camera device finishes AE scan</td>
5725 <td align="center">FLASH_<wbr/>REQUIRED</td>
5726 <td align="center">Converged but too dark w/<wbr/>o flash</td>
5727 </tr>
5728 <tr>
5729 <td align="center">SEARCHING</td>
5730 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
5731 <td align="center">LOCKED</td>
5732 <td align="center">Values locked</td>
5733 </tr>
5734 <tr>
5735 <td align="center">CONVERGED</td>
5736 <td align="center">Camera device initiates AE scan</td>
5737 <td align="center">SEARCHING</td>
5738 <td align="center">Values changing</td>
5739 </tr>
5740 <tr>
5741 <td align="center">CONVERGED</td>
5742 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
5743 <td align="center">LOCKED</td>
5744 <td align="center">Values locked</td>
5745 </tr>
5746 <tr>
5747 <td align="center">FLASH_<wbr/>REQUIRED</td>
5748 <td align="center">Camera device initiates AE scan</td>
5749 <td align="center">SEARCHING</td>
5750 <td align="center">Values changing</td>
5751 </tr>
5752 <tr>
5753 <td align="center">FLASH_<wbr/>REQUIRED</td>
5754 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
5755 <td align="center">LOCKED</td>
5756 <td align="center">Values locked</td>
5757 </tr>
5758 <tr>
5759 <td align="center">LOCKED</td>
5760 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is OFF</td>
5761 <td align="center">SEARCHING</td>
5762 <td align="center">Values not good after unlock</td>
5763 </tr>
5764 <tr>
5765 <td align="center">LOCKED</td>
5766 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is OFF</td>
5767 <td align="center">CONVERGED</td>
5768 <td align="center">Values good after unlock</td>
5769 </tr>
5770 <tr>
5771 <td align="center">LOCKED</td>
5772 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is OFF</td>
5773 <td align="center">FLASH_<wbr/>REQUIRED</td>
5774 <td align="center">Exposure good,<wbr/> but too dark</td>
5775 </tr>
5776 <tr>
5777 <td align="center">PRECAPTURE</td>
5778 <td align="center">Sequence done.<wbr/> <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is OFF</td>
5779 <td align="center">CONVERGED</td>
5780 <td align="center">Ready for high-quality capture</td>
5781 </tr>
5782 <tr>
5783 <td align="center">PRECAPTURE</td>
5784 <td align="center">Sequence done.<wbr/> <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
5785 <td align="center">LOCKED</td>
5786 <td align="center">Ready for high-quality capture</td>
5787 </tr>
5788 <tr>
5789 <td align="center">Any state</td>
5790 <td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> is START</td>
5791 <td align="center">PRECAPTURE</td>
5792 <td align="center">Start AE precapture metering sequence</td>
5793 </tr>
5794 </tbody>
5795 </table>
5796 <p>For the above table,<wbr/> the camera device may skip reporting any state changes that happen
5797 without application intervention (i.<wbr/>e.<wbr/> mode switch,<wbr/> trigger,<wbr/> locking).<wbr/> Any state that
5798 can be skipped in that manner is called a transient state.<wbr/></p>
5799 <p>For example,<wbr/> for above AE modes (AE_<wbr/>MODE_<wbr/>ON_<wbr/>*),<wbr/> in addition to the state transitions
5800 listed in above table,<wbr/> it is also legal for the camera device to skip one or more
5801 transient states between two results.<wbr/> See below table for examples:</p>
5802 <table>
5803 <thead>
5804 <tr>
5805 <th align="center">State</th>
5806 <th align="center">Transition Cause</th>
5807 <th align="center">New State</th>
5808 <th align="center">Notes</th>
5809 </tr>
5810 </thead>
5811 <tbody>
5812 <tr>
5813 <td align="center">INACTIVE</td>
5814 <td align="center">Camera device finished AE scan</td>
5815 <td align="center">CONVERGED</td>
5816 <td align="center">Values are already good,<wbr/> transient states are skipped by camera device.<wbr/></td>
5817 </tr>
5818 <tr>
5819 <td align="center">Any state</td>
5820 <td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> is START,<wbr/> sequence done</td>
5821 <td align="center">FLASH_<wbr/>REQUIRED</td>
5822 <td align="center">Converged but too dark w/<wbr/>o flash after a precapture sequence,<wbr/> transient states are skipped by camera device.<wbr/></td>
5823 </tr>
5824 <tr>
5825 <td align="center">Any state</td>
5826 <td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> is START,<wbr/> sequence done</td>
5827 <td align="center">CONVERGED</td>
5828 <td align="center">Converged after a precapture sequence,<wbr/> transient states are skipped by camera device.<wbr/></td>
5829 </tr>
5830 <tr>
5831 <td align="center">CONVERGED</td>
5832 <td align="center">Camera device finished AE scan</td>
5833 <td align="center">FLASH_<wbr/>REQUIRED</td>
5834 <td align="center">Converged but too dark w/<wbr/>o flash after a new scan,<wbr/> transient states are skipped by camera device.<wbr/></td>
5835 </tr>
5836 <tr>
5837 <td align="center">FLASH_<wbr/>REQUIRED</td>
5838 <td align="center">Camera device finished AE scan</td>
5839 <td align="center">CONVERGED</td>
5840 <td align="center">Converged after a new scan,<wbr/> transient states are skipped by camera device.<wbr/></td>
5841 </tr>
5842 </tbody>
5843 </table>
5844             </td>
5845           </tr>
5846
5847
5848           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5849            <!-- end of entry -->
5850
5851
5852           <tr class="entry" id="dynamic_android.control.afMode">
5853             <td class="entry_name
5854              " rowspan="5">
5855               android.<wbr/>control.<wbr/>af<wbr/>Mode
5856             </td>
5857             <td class="entry_type">
5858                 <span class="entry_type_name entry_type_name_enum">byte</span>
5859
5860               <span class="entry_type_visibility"> [public]</span>
5861
5862
5863               <span class="entry_type_hwlevel">[legacy] </span>
5864
5865
5866
5867                 <ul class="entry_type_enum">
5868                   <li>
5869                     <span class="entry_type_enum_name">OFF</span>
5870                     <span class="entry_type_enum_notes"><p>The auto-focus routine does not control the lens;
5871 <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> is controlled by the
5872 application.<wbr/></p></span>
5873                   </li>
5874                   <li>
5875                     <span class="entry_type_enum_name">AUTO</span>
5876                     <span class="entry_type_enum_notes"><p>Basic automatic focus mode.<wbr/></p>
5877 <p>In this mode,<wbr/> the lens does not move unless
5878 the autofocus trigger action is called.<wbr/> When that trigger
5879 is activated,<wbr/> AF will transition to ACTIVE_<wbr/>SCAN,<wbr/> then to
5880 the outcome of the scan (FOCUSED or NOT_<wbr/>FOCUSED).<wbr/></p>
5881 <p>Always supported if lens is not fixed focus.<wbr/></p>
5882 <p>Use <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> to determine if lens
5883 is fixed-focus.<wbr/></p>
5884 <p>Triggering AF_<wbr/>CANCEL resets the lens position to default,<wbr/>
5885 and sets the AF state to INACTIVE.<wbr/></p></span>
5886                   </li>
5887                   <li>
5888                     <span class="entry_type_enum_name">MACRO</span>
5889                     <span class="entry_type_enum_notes"><p>Close-up focusing mode.<wbr/></p>
5890 <p>In this mode,<wbr/> the lens does not move unless the
5891 autofocus trigger action is called.<wbr/> When that trigger is
5892 activated,<wbr/> AF will transition to ACTIVE_<wbr/>SCAN,<wbr/> then to
5893 the outcome of the scan (FOCUSED or NOT_<wbr/>FOCUSED).<wbr/> This
5894 mode is optimized for focusing on objects very close to
5895 the camera.<wbr/></p>
5896 <p>When that trigger is activated,<wbr/> AF will transition to
5897 ACTIVE_<wbr/>SCAN,<wbr/> then to the outcome of the scan (FOCUSED or
5898 NOT_<wbr/>FOCUSED).<wbr/> Triggering cancel AF resets the lens
5899 position to default,<wbr/> and sets the AF state to
5900 INACTIVE.<wbr/></p></span>
5901                   </li>
5902                   <li>
5903                     <span class="entry_type_enum_name">CONTINUOUS_VIDEO</span>
5904                     <span class="entry_type_enum_notes"><p>In this mode,<wbr/> the AF algorithm modifies the lens
5905 position continually to attempt to provide a
5906 constantly-in-focus image stream.<wbr/></p>
5907 <p>The focusing behavior should be suitable for good quality
5908 video recording; typically this means slower focus
5909 movement and no overshoots.<wbr/> When the AF trigger is not
5910 involved,<wbr/> the AF algorithm should start in INACTIVE state,<wbr/>
5911 and then transition into PASSIVE_<wbr/>SCAN and PASSIVE_<wbr/>FOCUSED
5912 states as appropriate.<wbr/> When the AF trigger is activated,<wbr/>
5913 the algorithm should immediately transition into
5914 AF_<wbr/>FOCUSED or AF_<wbr/>NOT_<wbr/>FOCUSED as appropriate,<wbr/> and lock the
5915 lens position until a cancel AF trigger is received.<wbr/></p>
5916 <p>Once cancel is received,<wbr/> the algorithm should transition
5917 back to INACTIVE and resume passive scan.<wbr/> Note that this
5918 behavior is not identical to CONTINUOUS_<wbr/>PICTURE,<wbr/> since an
5919 ongoing PASSIVE_<wbr/>SCAN must immediately be
5920 canceled.<wbr/></p></span>
5921                   </li>
5922                   <li>
5923                     <span class="entry_type_enum_name">CONTINUOUS_PICTURE</span>
5924                     <span class="entry_type_enum_notes"><p>In this mode,<wbr/> the AF algorithm modifies the lens
5925 position continually to attempt to provide a
5926 constantly-in-focus image stream.<wbr/></p>
5927 <p>The focusing behavior should be suitable for still image
5928 capture; typically this means focusing as fast as
5929 possible.<wbr/> When the AF trigger is not involved,<wbr/> the AF
5930 algorithm should start in INACTIVE state,<wbr/> and then
5931 transition into PASSIVE_<wbr/>SCAN and PASSIVE_<wbr/>FOCUSED states as
5932 appropriate as it attempts to maintain focus.<wbr/> When the AF
5933 trigger is activated,<wbr/> the algorithm should finish its
5934 PASSIVE_<wbr/>SCAN if active,<wbr/> and then transition into
5935 AF_<wbr/>FOCUSED or AF_<wbr/>NOT_<wbr/>FOCUSED as appropriate,<wbr/> and lock the
5936 lens position until a cancel AF trigger is received.<wbr/></p>
5937 <p>When the AF cancel trigger is activated,<wbr/> the algorithm
5938 should transition back to INACTIVE and then act as if it
5939 has just been started.<wbr/></p></span>
5940                   </li>
5941                   <li>
5942                     <span class="entry_type_enum_name">EDOF</span>
5943                     <span class="entry_type_enum_notes"><p>Extended depth of field (digital focus) mode.<wbr/></p>
5944 <p>The camera device will produce images with an extended
5945 depth of field automatically; no special focusing
5946 operations need to be done before taking a picture.<wbr/></p>
5947 <p>AF triggers are ignored,<wbr/> and the AF state will always be
5948 INACTIVE.<wbr/></p></span>
5949                   </li>
5950                 </ul>
5951
5952             </td> <!-- entry_type -->
5953
5954             <td class="entry_description">
5955               <p>Whether auto-focus (AF) is currently enabled,<wbr/> and what
5956 mode it is set to.<wbr/></p>
5957             </td>
5958
5959             <td class="entry_units">
5960             </td>
5961
5962             <td class="entry_range">
5963               <p><a href="#static_android.control.afAvailableModes">android.<wbr/>control.<wbr/>af<wbr/>Available<wbr/>Modes</a></p>
5964             </td>
5965
5966             <td class="entry_tags">
5967               <ul class="entry_tags">
5968                   <li><a href="#tag_BC">BC</a></li>
5969               </ul>
5970             </td>
5971
5972           </tr>
5973           <tr class="entries_header">
5974             <th class="th_details" colspan="5">Details</th>
5975           </tr>
5976           <tr class="entry_cont">
5977             <td class="entry_details" colspan="5">
5978               <p>Only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> = AUTO and the lens is not fixed focus
5979 (i.<wbr/>e.<wbr/> <code><a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> &gt; 0</code>).<wbr/></p>
5980 <p>If the lens is controlled by the camera device auto-focus algorithm,<wbr/>
5981 the camera device will report the current AF status in <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a>
5982 in result metadata.<wbr/></p>
5983             </td>
5984           </tr>
5985
5986           <tr class="entries_header">
5987             <th class="th_details" colspan="5">HAL Implementation Details</th>
5988           </tr>
5989           <tr class="entry_cont">
5990             <td class="entry_details" colspan="5">
5991               <p>When afMode is AUTO or MACRO,<wbr/> the lens must not move until an AF trigger is sent in a
5992 request (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a> <code>==</code> START).<wbr/> After an AF trigger,<wbr/> the afState will end
5993 up with either FOCUSED_<wbr/>LOCKED or NOT_<wbr/>FOCUSED_<wbr/>LOCKED state (see
5994 <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a> for detailed state transitions),<wbr/> which indicates that the lens is
5995 locked and will not move.<wbr/> If camera movement (e.<wbr/>g.<wbr/> tilting camera) causes the lens to move
5996 after the lens is locked,<wbr/> the HAL must compensate this movement appropriately such that
5997 the same focal plane remains in focus.<wbr/></p>
5998 <p>When afMode is one of the continuous auto focus modes,<wbr/> the HAL is free to start a AF
5999 scan whenever it's not locked.<wbr/> When the lens is locked after an AF trigger
6000 (see <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a> for detailed state transitions),<wbr/> the HAL should maintain the
6001 same lock behavior as above.<wbr/></p>
6002 <p>When afMode is OFF,<wbr/> the application controls focus manually.<wbr/> The accuracy of the
6003 focus distance control depends on the <a href="#static_android.lens.info.focusDistanceCalibration">android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration</a>.<wbr/>
6004 However,<wbr/> the lens must not move regardless of the camera movement for any focus distance
6005 manual control.<wbr/></p>
6006 <p>To put this in concrete terms,<wbr/> if the camera has lens elements which may move based on
6007 camera orientation or motion (e.<wbr/>g.<wbr/> due to gravity),<wbr/> then the HAL must drive the lens to
6008 remain in a fixed position invariant to the camera's orientation or motion,<wbr/> for example,<wbr/>
6009 by using accelerometer measurements in the lens control logic.<wbr/> This is a typical issue
6010 that will arise on camera modules with open-loop VCMs.<wbr/></p>
6011             </td>
6012           </tr>
6013
6014           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6015            <!-- end of entry -->
6016
6017
6018           <tr class="entry" id="dynamic_android.control.afRegions">
6019             <td class="entry_name
6020              " rowspan="5">
6021               android.<wbr/>control.<wbr/>af<wbr/>Regions
6022             </td>
6023             <td class="entry_type">
6024                 <span class="entry_type_name">int32</span>
6025                 <span class="entry_type_container">x</span>
6026
6027                 <span class="entry_type_array">
6028                   5 x area_count
6029                 </span>
6030               <span class="entry_type_visibility"> [public as meteringRectangle]</span>
6031
6032
6033
6034
6035
6036
6037             </td> <!-- entry_type -->
6038
6039             <td class="entry_description">
6040               <p>List of metering areas to use for auto-focus.<wbr/></p>
6041             </td>
6042
6043             <td class="entry_units">
6044               Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
6045             </td>
6046
6047             <td class="entry_range">
6048               <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
6049 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
6050             </td>
6051
6052             <td class="entry_tags">
6053               <ul class="entry_tags">
6054                   <li><a href="#tag_BC">BC</a></li>
6055               </ul>
6056             </td>
6057
6058           </tr>
6059           <tr class="entries_header">
6060             <th class="th_details" colspan="5">Details</th>
6061           </tr>
6062           <tr class="entry_cont">
6063             <td class="entry_details" colspan="5">
6064               <p>Not available if <a href="#static_android.control.maxRegionsAf">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af</a> is 0.<wbr/>
6065 Otherwise will always be present.<wbr/></p>
6066 <p>The maximum number of focus areas supported by the device is determined by the value
6067 of <a href="#static_android.control.maxRegionsAf">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af</a>.<wbr/></p>
6068 <p>The coordinate system is based on the active pixel array,<wbr/>
6069 with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
6070 (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
6071 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
6072 bottom-right pixel in the active pixel array.<wbr/></p>
6073 <p>The weight must be within <code>[0,<wbr/> 1000]</code>,<wbr/> and represents a weight
6074 for every pixel in the area.<wbr/> This means that a large metering area
6075 with the same weight as a smaller area will have more effect in
6076 the metering result.<wbr/> Metering areas can partially overlap and the
6077 camera device will add the weights in the overlap region.<wbr/></p>
6078 <p>The weights are relative to weights of other metering regions,<wbr/> so if only one region
6079 is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with 0 weight is
6080 ignored.<wbr/></p>
6081 <p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
6082 camera device.<wbr/></p>
6083 <p>If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> returned in
6084 capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
6085 region and output only the intersection rectangle as the metering region in the result
6086 metadata.<wbr/> If the region is entirely outside the crop region,<wbr/> it will be ignored and
6087 not reported in the result metadata.<wbr/></p>
6088             </td>
6089           </tr>
6090
6091           <tr class="entries_header">
6092             <th class="th_details" colspan="5">HAL Implementation Details</th>
6093           </tr>
6094           <tr class="entry_cont">
6095             <td class="entry_details" colspan="5">
6096               <p>The HAL level representation of MeteringRectangle[] is a
6097 int[5 * area_<wbr/>count].<wbr/>
6098 Every five elements represent a metering region of
6099 (xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
6100 The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
6101 exclusive on xmax and ymax.<wbr/></p>
6102             </td>
6103           </tr>
6104
6105           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6106            <!-- end of entry -->
6107
6108
6109           <tr class="entry" id="dynamic_android.control.afTrigger">
6110             <td class="entry_name
6111              " rowspan="3">
6112               android.<wbr/>control.<wbr/>af<wbr/>Trigger
6113             </td>
6114             <td class="entry_type">
6115                 <span class="entry_type_name entry_type_name_enum">byte</span>
6116
6117               <span class="entry_type_visibility"> [public]</span>
6118
6119
6120               <span class="entry_type_hwlevel">[legacy] </span>
6121
6122
6123
6124                 <ul class="entry_type_enum">
6125                   <li>
6126                     <span class="entry_type_enum_name">IDLE</span>
6127                     <span class="entry_type_enum_notes"><p>The trigger is idle.<wbr/></p></span>
6128                   </li>
6129                   <li>
6130                     <span class="entry_type_enum_name">START</span>
6131                     <span class="entry_type_enum_notes"><p>Autofocus will trigger now.<wbr/></p></span>
6132                   </li>
6133                   <li>
6134                     <span class="entry_type_enum_name">CANCEL</span>
6135                     <span class="entry_type_enum_notes"><p>Autofocus will return to its initial
6136 state,<wbr/> and cancel any currently active trigger.<wbr/></p></span>
6137                   </li>
6138                 </ul>
6139
6140             </td> <!-- entry_type -->
6141
6142             <td class="entry_description">
6143               <p>Whether the camera device will trigger autofocus for this request.<wbr/></p>
6144             </td>
6145
6146             <td class="entry_units">
6147             </td>
6148
6149             <td class="entry_range">
6150             </td>
6151
6152             <td class="entry_tags">
6153               <ul class="entry_tags">
6154                   <li><a href="#tag_BC">BC</a></li>
6155               </ul>
6156             </td>
6157
6158           </tr>
6159           <tr class="entries_header">
6160             <th class="th_details" colspan="5">Details</th>
6161           </tr>
6162           <tr class="entry_cont">
6163             <td class="entry_details" colspan="5">
6164               <p>This entry is normally set to IDLE,<wbr/> or is not
6165 included at all in the request settings.<wbr/></p>
6166 <p>When included and set to START,<wbr/> the camera device will trigger the
6167 autofocus algorithm.<wbr/> If autofocus is disabled,<wbr/> this trigger has no effect.<wbr/></p>
6168 <p>When set to CANCEL,<wbr/> the camera device will cancel any active trigger,<wbr/>
6169 and return to its initial AF state.<wbr/></p>
6170 <p>Generally,<wbr/> applications should set this entry to START or CANCEL for only a
6171 single capture,<wbr/> and then return it to IDLE (or not set at all).<wbr/> Specifying
6172 START for multiple captures in a row means restarting the AF operation over
6173 and over again.<wbr/></p>
6174 <p>See <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a> for what the trigger means for each AF mode.<wbr/></p>
6175             </td>
6176           </tr>
6177
6178
6179           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6180            <!-- end of entry -->
6181
6182
6183           <tr class="entry" id="dynamic_android.control.afState">
6184             <td class="entry_name
6185              " rowspan="3">
6186               android.<wbr/>control.<wbr/>af<wbr/>State
6187             </td>
6188             <td class="entry_type">
6189                 <span class="entry_type_name entry_type_name_enum">byte</span>
6190
6191               <span class="entry_type_visibility"> [public]</span>
6192
6193
6194               <span class="entry_type_hwlevel">[legacy] </span>
6195
6196
6197
6198                 <ul class="entry_type_enum">
6199                   <li>
6200                     <span class="entry_type_enum_name">INACTIVE</span>
6201                     <span class="entry_type_enum_notes"><p>AF is off or has not yet tried to scan/<wbr/>been asked
6202 to scan.<wbr/></p>
6203 <p>When a camera device is opened,<wbr/> it starts in this
6204 state.<wbr/> This is a transient state,<wbr/> the camera device may
6205 skip reporting this state in capture
6206 result.<wbr/></p></span>
6207                   </li>
6208                   <li>
6209                     <span class="entry_type_enum_name">PASSIVE_SCAN</span>
6210                     <span class="entry_type_enum_notes"><p>AF is currently performing an AF scan initiated the
6211 camera device in a continuous autofocus mode.<wbr/></p>
6212 <p>Only used by CONTINUOUS_<wbr/>* AF modes.<wbr/> This is a transient
6213 state,<wbr/> the camera device may skip reporting this state in
6214 capture result.<wbr/></p></span>
6215                   </li>
6216                   <li>
6217                     <span class="entry_type_enum_name">PASSIVE_FOCUSED</span>
6218                     <span class="entry_type_enum_notes"><p>AF currently believes it is in focus,<wbr/> but may
6219 restart scanning at any time.<wbr/></p>
6220 <p>Only used by CONTINUOUS_<wbr/>* AF modes.<wbr/> This is a transient
6221 state,<wbr/> the camera device may skip reporting this state in
6222 capture result.<wbr/></p></span>
6223                   </li>
6224                   <li>
6225                     <span class="entry_type_enum_name">ACTIVE_SCAN</span>
6226                     <span class="entry_type_enum_notes"><p>AF is performing an AF scan because it was
6227 triggered by AF trigger.<wbr/></p>
6228 <p>Only used by AUTO or MACRO AF modes.<wbr/> This is a transient
6229 state,<wbr/> the camera device may skip reporting this state in
6230 capture result.<wbr/></p></span>
6231                   </li>
6232                   <li>
6233                     <span class="entry_type_enum_name">FOCUSED_LOCKED</span>
6234                     <span class="entry_type_enum_notes"><p>AF believes it is focused correctly and has locked
6235 focus.<wbr/></p>
6236 <p>This state is reached only after an explicit START AF trigger has been
6237 sent (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>),<wbr/> when good focus has been obtained.<wbr/></p>
6238 <p>The lens will remain stationary until the AF mode (<a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>) is changed or
6239 a new AF trigger is sent to the camera device (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>).<wbr/></p></span>
6240                   </li>
6241                   <li>
6242                     <span class="entry_type_enum_name">NOT_FOCUSED_LOCKED</span>
6243                     <span class="entry_type_enum_notes"><p>AF has failed to focus successfully and has locked
6244 focus.<wbr/></p>
6245 <p>This state is reached only after an explicit START AF trigger has been
6246 sent (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>),<wbr/> when good focus cannot be obtained.<wbr/></p>
6247 <p>The lens will remain stationary until the AF mode (<a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>) is changed or
6248 a new AF trigger is sent to the camera device (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>).<wbr/></p></span>
6249                   </li>
6250                   <li>
6251                     <span class="entry_type_enum_name">PASSIVE_UNFOCUSED</span>
6252                     <span class="entry_type_enum_notes"><p>AF finished a passive scan without finding focus,<wbr/>
6253 and may restart scanning at any time.<wbr/></p>
6254 <p>Only used by CONTINUOUS_<wbr/>* AF modes.<wbr/> This is a transient state,<wbr/> the camera
6255 device may skip reporting this state in capture result.<wbr/></p>
6256 <p>LEGACY camera devices do not support this state.<wbr/> When a passive
6257 scan has finished,<wbr/> it will always go to PASSIVE_<wbr/>FOCUSED.<wbr/></p></span>
6258                   </li>
6259                 </ul>
6260
6261             </td> <!-- entry_type -->
6262
6263             <td class="entry_description">
6264               <p>Current state of auto-focus (AF) algorithm.<wbr/></p>
6265             </td>
6266
6267             <td class="entry_units">
6268             </td>
6269
6270             <td class="entry_range">
6271             </td>
6272
6273             <td class="entry_tags">
6274             </td>
6275
6276           </tr>
6277           <tr class="entries_header">
6278             <th class="th_details" colspan="5">Details</th>
6279           </tr>
6280           <tr class="entry_cont">
6281             <td class="entry_details" colspan="5">
6282               <p>Switching between or enabling AF modes (<a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>) always
6283 resets the AF state to INACTIVE.<wbr/> Similarly,<wbr/> switching between <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a>,<wbr/>
6284 or <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a> if <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == USE_<wbr/>SCENE_<wbr/>MODE</code> resets all
6285 the algorithm states to INACTIVE.<wbr/></p>
6286 <p>The camera device can do several state transitions between two results,<wbr/> if it is
6287 allowed by the state transition table.<wbr/> For example: INACTIVE may never actually be
6288 seen in a result.<wbr/></p>
6289 <p>The state in the result is the state for this image (in sync with this image): if
6290 AF state becomes FOCUSED,<wbr/> then the image data associated with this result should
6291 be sharp.<wbr/></p>
6292 <p>Below are state transition tables for different AF modes.<wbr/></p>
6293 <p>When <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> is AF_<wbr/>MODE_<wbr/>OFF or AF_<wbr/>MODE_<wbr/>EDOF:</p>
6294 <table>
6295 <thead>
6296 <tr>
6297 <th align="center">State</th>
6298 <th align="center">Transition Cause</th>
6299 <th align="center">New State</th>
6300 <th align="center">Notes</th>
6301 </tr>
6302 </thead>
6303 <tbody>
6304 <tr>
6305 <td align="center">INACTIVE</td>
6306 <td align="center"></td>
6307 <td align="center">INACTIVE</td>
6308 <td align="center">Never changes</td>
6309 </tr>
6310 </tbody>
6311 </table>
6312 <p>When <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> is AF_<wbr/>MODE_<wbr/>AUTO or AF_<wbr/>MODE_<wbr/>MACRO:</p>
6313 <table>
6314 <thead>
6315 <tr>
6316 <th align="center">State</th>
6317 <th align="center">Transition Cause</th>
6318 <th align="center">New State</th>
6319 <th align="center">Notes</th>
6320 </tr>
6321 </thead>
6322 <tbody>
6323 <tr>
6324 <td align="center">INACTIVE</td>
6325 <td align="center">AF_<wbr/>TRIGGER</td>
6326 <td align="center">ACTIVE_<wbr/>SCAN</td>
6327 <td align="center">Start AF sweep,<wbr/> Lens now moving</td>
6328 </tr>
6329 <tr>
6330 <td align="center">ACTIVE_<wbr/>SCAN</td>
6331 <td align="center">AF sweep done</td>
6332 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6333 <td align="center">Focused,<wbr/> Lens now locked</td>
6334 </tr>
6335 <tr>
6336 <td align="center">ACTIVE_<wbr/>SCAN</td>
6337 <td align="center">AF sweep done</td>
6338 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6339 <td align="center">Not focused,<wbr/> Lens now locked</td>
6340 </tr>
6341 <tr>
6342 <td align="center">ACTIVE_<wbr/>SCAN</td>
6343 <td align="center">AF_<wbr/>CANCEL</td>
6344 <td align="center">INACTIVE</td>
6345 <td align="center">Cancel/<wbr/>reset AF,<wbr/> Lens now locked</td>
6346 </tr>
6347 <tr>
6348 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6349 <td align="center">AF_<wbr/>CANCEL</td>
6350 <td align="center">INACTIVE</td>
6351 <td align="center">Cancel/<wbr/>reset AF</td>
6352 </tr>
6353 <tr>
6354 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6355 <td align="center">AF_<wbr/>TRIGGER</td>
6356 <td align="center">ACTIVE_<wbr/>SCAN</td>
6357 <td align="center">Start new sweep,<wbr/> Lens now moving</td>
6358 </tr>
6359 <tr>
6360 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6361 <td align="center">AF_<wbr/>CANCEL</td>
6362 <td align="center">INACTIVE</td>
6363 <td align="center">Cancel/<wbr/>reset AF</td>
6364 </tr>
6365 <tr>
6366 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6367 <td align="center">AF_<wbr/>TRIGGER</td>
6368 <td align="center">ACTIVE_<wbr/>SCAN</td>
6369 <td align="center">Start new sweep,<wbr/> Lens now moving</td>
6370 </tr>
6371 <tr>
6372 <td align="center">Any state</td>
6373 <td align="center">Mode change</td>
6374 <td align="center">INACTIVE</td>
6375 <td align="center"></td>
6376 </tr>
6377 </tbody>
6378 </table>
6379 <p>For the above table,<wbr/> the camera device may skip reporting any state changes that happen
6380 without application intervention (i.<wbr/>e.<wbr/> mode switch,<wbr/> trigger,<wbr/> locking).<wbr/> Any state that
6381 can be skipped in that manner is called a transient state.<wbr/></p>
6382 <p>For example,<wbr/> for these AF modes (AF_<wbr/>MODE_<wbr/>AUTO and AF_<wbr/>MODE_<wbr/>MACRO),<wbr/> in addition to the
6383 state transitions listed in above table,<wbr/> it is also legal for the camera device to skip
6384 one or more transient states between two results.<wbr/> See below table for examples:</p>
6385 <table>
6386 <thead>
6387 <tr>
6388 <th align="center">State</th>
6389 <th align="center">Transition Cause</th>
6390 <th align="center">New State</th>
6391 <th align="center">Notes</th>
6392 </tr>
6393 </thead>
6394 <tbody>
6395 <tr>
6396 <td align="center">INACTIVE</td>
6397 <td align="center">AF_<wbr/>TRIGGER</td>
6398 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6399 <td align="center">Focus is already good or good after a scan,<wbr/> lens is now locked.<wbr/></td>
6400 </tr>
6401 <tr>
6402 <td align="center">INACTIVE</td>
6403 <td align="center">AF_<wbr/>TRIGGER</td>
6404 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6405 <td align="center">Focus failed after a scan,<wbr/> lens is now locked.<wbr/></td>
6406 </tr>
6407 <tr>
6408 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6409 <td align="center">AF_<wbr/>TRIGGER</td>
6410 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6411 <td align="center">Focus is already good or good after a scan,<wbr/> lens is now locked.<wbr/></td>
6412 </tr>
6413 <tr>
6414 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6415 <td align="center">AF_<wbr/>TRIGGER</td>
6416 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6417 <td align="center">Focus is good after a scan,<wbr/> lens is not locked.<wbr/></td>
6418 </tr>
6419 </tbody>
6420 </table>
6421 <p>When <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> is AF_<wbr/>MODE_<wbr/>CONTINUOUS_<wbr/>VIDEO:</p>
6422 <table>
6423 <thead>
6424 <tr>
6425 <th align="center">State</th>
6426 <th align="center">Transition Cause</th>
6427 <th align="center">New State</th>
6428 <th align="center">Notes</th>
6429 </tr>
6430 </thead>
6431 <tbody>
6432 <tr>
6433 <td align="center">INACTIVE</td>
6434 <td align="center">Camera device initiates new scan</td>
6435 <td align="center">PASSIVE_<wbr/>SCAN</td>
6436 <td align="center">Start AF scan,<wbr/> Lens now moving</td>
6437 </tr>
6438 <tr>
6439 <td align="center">INACTIVE</td>
6440 <td align="center">AF_<wbr/>TRIGGER</td>
6441 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6442 <td align="center">AF state query,<wbr/> Lens now locked</td>
6443 </tr>
6444 <tr>
6445 <td align="center">PASSIVE_<wbr/>SCAN</td>
6446 <td align="center">Camera device completes current scan</td>
6447 <td align="center">PASSIVE_<wbr/>FOCUSED</td>
6448 <td align="center">End AF scan,<wbr/> Lens now locked</td>
6449 </tr>
6450 <tr>
6451 <td align="center">PASSIVE_<wbr/>SCAN</td>
6452 <td align="center">Camera device fails current scan</td>
6453 <td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
6454 <td align="center">End AF scan,<wbr/> Lens now locked</td>
6455 </tr>
6456 <tr>
6457 <td align="center">PASSIVE_<wbr/>SCAN</td>
6458 <td align="center">AF_<wbr/>TRIGGER</td>
6459 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6460 <td align="center">Immediate transition,<wbr/> if focus is good.<wbr/> Lens now locked</td>
6461 </tr>
6462 <tr>
6463 <td align="center">PASSIVE_<wbr/>SCAN</td>
6464 <td align="center">AF_<wbr/>TRIGGER</td>
6465 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6466 <td align="center">Immediate transition,<wbr/> if focus is bad.<wbr/> Lens now locked</td>
6467 </tr>
6468 <tr>
6469 <td align="center">PASSIVE_<wbr/>SCAN</td>
6470 <td align="center">AF_<wbr/>CANCEL</td>
6471 <td align="center">INACTIVE</td>
6472 <td align="center">Reset lens position,<wbr/> Lens now locked</td>
6473 </tr>
6474 <tr>
6475 <td align="center">PASSIVE_<wbr/>FOCUSED</td>
6476 <td align="center">Camera device initiates new scan</td>
6477 <td align="center">PASSIVE_<wbr/>SCAN</td>
6478 <td align="center">Start AF scan,<wbr/> Lens now moving</td>
6479 </tr>
6480 <tr>
6481 <td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
6482 <td align="center">Camera device initiates new scan</td>
6483 <td align="center">PASSIVE_<wbr/>SCAN</td>
6484 <td align="center">Start AF scan,<wbr/> Lens now moving</td>
6485 </tr>
6486 <tr>
6487 <td align="center">PASSIVE_<wbr/>FOCUSED</td>
6488 <td align="center">AF_<wbr/>TRIGGER</td>
6489 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6490 <td align="center">Immediate transition,<wbr/> lens now locked</td>
6491 </tr>
6492 <tr>
6493 <td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
6494 <td align="center">AF_<wbr/>TRIGGER</td>
6495 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6496 <td align="center">Immediate transition,<wbr/> lens now locked</td>
6497 </tr>
6498 <tr>
6499 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6500 <td align="center">AF_<wbr/>TRIGGER</td>
6501 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6502 <td align="center">No effect</td>
6503 </tr>
6504 <tr>
6505 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6506 <td align="center">AF_<wbr/>CANCEL</td>
6507 <td align="center">INACTIVE</td>
6508 <td align="center">Restart AF scan</td>
6509 </tr>
6510 <tr>
6511 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6512 <td align="center">AF_<wbr/>TRIGGER</td>
6513 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6514 <td align="center">No effect</td>
6515 </tr>
6516 <tr>
6517 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6518 <td align="center">AF_<wbr/>CANCEL</td>
6519 <td align="center">INACTIVE</td>
6520 <td align="center">Restart AF scan</td>
6521 </tr>
6522 </tbody>
6523 </table>
6524 <p>When <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> is AF_<wbr/>MODE_<wbr/>CONTINUOUS_<wbr/>PICTURE:</p>
6525 <table>
6526 <thead>
6527 <tr>
6528 <th align="center">State</th>
6529 <th align="center">Transition Cause</th>
6530 <th align="center">New State</th>
6531 <th align="center">Notes</th>
6532 </tr>
6533 </thead>
6534 <tbody>
6535 <tr>
6536 <td align="center">INACTIVE</td>
6537 <td align="center">Camera device initiates new scan</td>
6538 <td align="center">PASSIVE_<wbr/>SCAN</td>
6539 <td align="center">Start AF scan,<wbr/> Lens now moving</td>
6540 </tr>
6541 <tr>
6542 <td align="center">INACTIVE</td>
6543 <td align="center">AF_<wbr/>TRIGGER</td>
6544 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6545 <td align="center">AF state query,<wbr/> Lens now locked</td>
6546 </tr>
6547 <tr>
6548 <td align="center">PASSIVE_<wbr/>SCAN</td>
6549 <td align="center">Camera device completes current scan</td>
6550 <td align="center">PASSIVE_<wbr/>FOCUSED</td>
6551 <td align="center">End AF scan,<wbr/> Lens now locked</td>
6552 </tr>
6553 <tr>
6554 <td align="center">PASSIVE_<wbr/>SCAN</td>
6555 <td align="center">Camera device fails current scan</td>
6556 <td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
6557 <td align="center">End AF scan,<wbr/> Lens now locked</td>
6558 </tr>
6559 <tr>
6560 <td align="center">PASSIVE_<wbr/>SCAN</td>
6561 <td align="center">AF_<wbr/>TRIGGER</td>
6562 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6563 <td align="center">Eventual transition once the focus is good.<wbr/> Lens now locked</td>
6564 </tr>
6565 <tr>
6566 <td align="center">PASSIVE_<wbr/>SCAN</td>
6567 <td align="center">AF_<wbr/>TRIGGER</td>
6568 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6569 <td align="center">Eventual transition if cannot find focus.<wbr/> Lens now locked</td>
6570 </tr>
6571 <tr>
6572 <td align="center">PASSIVE_<wbr/>SCAN</td>
6573 <td align="center">AF_<wbr/>CANCEL</td>
6574 <td align="center">INACTIVE</td>
6575 <td align="center">Reset lens position,<wbr/> Lens now locked</td>
6576 </tr>
6577 <tr>
6578 <td align="center">PASSIVE_<wbr/>FOCUSED</td>
6579 <td align="center">Camera device initiates new scan</td>
6580 <td align="center">PASSIVE_<wbr/>SCAN</td>
6581 <td align="center">Start AF scan,<wbr/> Lens now moving</td>
6582 </tr>
6583 <tr>
6584 <td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
6585 <td align="center">Camera device initiates new scan</td>
6586 <td align="center">PASSIVE_<wbr/>SCAN</td>
6587 <td align="center">Start AF scan,<wbr/> Lens now moving</td>
6588 </tr>
6589 <tr>
6590 <td align="center">PASSIVE_<wbr/>FOCUSED</td>
6591 <td align="center">AF_<wbr/>TRIGGER</td>
6592 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6593 <td align="center">Immediate trans.<wbr/> Lens now locked</td>
6594 </tr>
6595 <tr>
6596 <td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
6597 <td align="center">AF_<wbr/>TRIGGER</td>
6598 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6599 <td align="center">Immediate trans.<wbr/> Lens now locked</td>
6600 </tr>
6601 <tr>
6602 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6603 <td align="center">AF_<wbr/>TRIGGER</td>
6604 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6605 <td align="center">No effect</td>
6606 </tr>
6607 <tr>
6608 <td align="center">FOCUSED_<wbr/>LOCKED</td>
6609 <td align="center">AF_<wbr/>CANCEL</td>
6610 <td align="center">INACTIVE</td>
6611 <td align="center">Restart AF scan</td>
6612 </tr>
6613 <tr>
6614 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6615 <td align="center">AF_<wbr/>TRIGGER</td>
6616 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6617 <td align="center">No effect</td>
6618 </tr>
6619 <tr>
6620 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
6621 <td align="center">AF_<wbr/>CANCEL</td>
6622 <td align="center">INACTIVE</td>
6623 <td align="center">Restart AF scan</td>
6624 </tr>
6625 </tbody>
6626 </table>
6627 <p>When switch between AF_<wbr/>MODE_<wbr/>CONTINUOUS_<wbr/>* (CAF modes) and AF_<wbr/>MODE_<wbr/>AUTO/<wbr/>AF_<wbr/>MODE_<wbr/>MACRO
6628 (AUTO modes),<wbr/> the initial INACTIVE or PASSIVE_<wbr/>SCAN states may be skipped by the
6629 camera device.<wbr/> When a trigger is included in a mode switch request,<wbr/> the trigger
6630 will be evaluated in the context of the new mode in the request.<wbr/>
6631 See below table for examples:</p>
6632 <table>
6633 <thead>
6634 <tr>
6635 <th align="center">State</th>
6636 <th align="center">Transition Cause</th>
6637 <th align="center">New State</th>
6638 <th align="center">Notes</th>
6639 </tr>
6640 </thead>
6641 <tbody>
6642 <tr>
6643 <td align="center">any state</td>
6644 <td align="center">CAF--&gt;AUTO mode switch</td>
6645 <td align="center">INACTIVE</td>
6646 <td align="center">Mode switch without trigger,<wbr/> initial state must be INACTIVE</td>
6647 </tr>
6648 <tr>
6649 <td align="center">any state</td>
6650 <td align="center">CAF--&gt;AUTO mode switch with AF_<wbr/>TRIGGER</td>
6651 <td align="center">trigger-reachable states from INACTIVE</td>
6652 <td align="center">Mode switch with trigger,<wbr/> INACTIVE is skipped</td>
6653 </tr>
6654 <tr>
6655 <td align="center">any state</td>
6656 <td align="center">AUTO--&gt;CAF mode switch</td>
6657 <td align="center">passively reachable states from INACTIVE</td>
6658 <td align="center">Mode switch without trigger,<wbr/> passive transient state is skipped</td>
6659 </tr>
6660 </tbody>
6661 </table>
6662             </td>
6663           </tr>
6664
6665
6666           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6667            <!-- end of entry -->
6668
6669
6670           <tr class="entry" id="dynamic_android.control.afTriggerId">
6671             <td class="entry_name
6672                 entry_name_deprecated
6673              " rowspan="3">
6674               android.<wbr/>control.<wbr/>af<wbr/>Trigger<wbr/>Id
6675             </td>
6676             <td class="entry_type">
6677                 <span class="entry_type_name">int32</span>
6678
6679               <span class="entry_type_visibility"> [system]</span>
6680
6681
6682
6683               <span class="entry_type_deprecated">[deprecated] </span>
6684
6685
6686
6687             </td> <!-- entry_type -->
6688
6689             <td class="entry_description">
6690               <p>The ID sent with the latest
6691 CAMERA2_<wbr/>TRIGGER_<wbr/>AUTOFOCUS call</p>
6692             </td>
6693
6694             <td class="entry_units">
6695             </td>
6696
6697             <td class="entry_range">
6698               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
6699             </td>
6700
6701             <td class="entry_tags">
6702             </td>
6703
6704           </tr>
6705           <tr class="entries_header">
6706             <th class="th_details" colspan="5">Details</th>
6707           </tr>
6708           <tr class="entry_cont">
6709             <td class="entry_details" colspan="5">
6710               <p>Must be 0 if no CAMERA2_<wbr/>TRIGGER_<wbr/>AUTOFOCUS trigger
6711 received yet by HAL.<wbr/> Always updated even if AF algorithm
6712 ignores the trigger</p>
6713             </td>
6714           </tr>
6715
6716
6717           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6718            <!-- end of entry -->
6719
6720
6721           <tr class="entry" id="dynamic_android.control.awbLock">
6722             <td class="entry_name
6723              " rowspan="3">
6724               android.<wbr/>control.<wbr/>awb<wbr/>Lock
6725             </td>
6726             <td class="entry_type">
6727                 <span class="entry_type_name entry_type_name_enum">byte</span>
6728
6729               <span class="entry_type_visibility"> [public as boolean]</span>
6730
6731
6732               <span class="entry_type_hwlevel">[legacy] </span>
6733
6734
6735
6736                 <ul class="entry_type_enum">
6737                   <li>
6738                     <span class="entry_type_enum_name">OFF</span>
6739                     <span class="entry_type_enum_notes"><p>Auto-white balance lock is disabled; the AWB
6740 algorithm is free to update its parameters if in AUTO
6741 mode.<wbr/></p></span>
6742                   </li>
6743                   <li>
6744                     <span class="entry_type_enum_name">ON</span>
6745                     <span class="entry_type_enum_notes"><p>Auto-white balance lock is enabled; the AWB
6746 algorithm will not update its parameters while the lock
6747 is active.<wbr/></p></span>
6748                   </li>
6749                 </ul>
6750
6751             </td> <!-- entry_type -->
6752
6753             <td class="entry_description">
6754               <p>Whether auto-white balance (AWB) is currently locked to its
6755 latest calculated values.<wbr/></p>
6756             </td>
6757
6758             <td class="entry_units">
6759             </td>
6760
6761             <td class="entry_range">
6762             </td>
6763
6764             <td class="entry_tags">
6765               <ul class="entry_tags">
6766                   <li><a href="#tag_BC">BC</a></li>
6767               </ul>
6768             </td>
6769
6770           </tr>
6771           <tr class="entries_header">
6772             <th class="th_details" colspan="5">Details</th>
6773           </tr>
6774           <tr class="entry_cont">
6775             <td class="entry_details" colspan="5">
6776               <p>When set to <code>true</code> (ON),<wbr/> the AWB algorithm is locked to its latest parameters,<wbr/>
6777 and will not change color balance settings until the lock is set to <code>false</code> (OFF).<wbr/></p>
6778 <p>Since the camera device has a pipeline of in-flight requests,<wbr/> the settings that
6779 get locked do not necessarily correspond to the settings that were present in the
6780 latest capture result received from the camera device,<wbr/> since additional captures
6781 and AWB updates may have occurred even before the result was sent out.<wbr/> If an
6782 application is switching between automatic and manual control and wishes to eliminate
6783 any flicker during the switch,<wbr/> the following procedure is recommended:</p>
6784 <ol>
6785 <li>Starting in auto-AWB mode:</li>
6786 <li>Lock AWB</li>
6787 <li>Wait for the first result to be output that has the AWB locked</li>
6788 <li>Copy AWB settings from that result into a request,<wbr/> set the request to manual AWB</li>
6789 <li>Submit the capture request,<wbr/> proceed to run manual AWB as desired.<wbr/></li>
6790 </ol>
6791 <p>Note that AWB lock is only meaningful when
6792 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> is in the AUTO mode; in other modes,<wbr/>
6793 AWB is already fixed to a specific setting.<wbr/></p>
6794 <p>Some LEGACY devices may not support ON; the value is then overridden to OFF.<wbr/></p>
6795             </td>
6796           </tr>
6797
6798
6799           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6800            <!-- end of entry -->
6801
6802
6803           <tr class="entry" id="dynamic_android.control.awbMode">
6804             <td class="entry_name
6805              " rowspan="3">
6806               android.<wbr/>control.<wbr/>awb<wbr/>Mode
6807             </td>
6808             <td class="entry_type">
6809                 <span class="entry_type_name entry_type_name_enum">byte</span>
6810
6811               <span class="entry_type_visibility"> [public]</span>
6812
6813
6814               <span class="entry_type_hwlevel">[legacy] </span>
6815
6816
6817
6818                 <ul class="entry_type_enum">
6819                   <li>
6820                     <span class="entry_type_enum_name">OFF</span>
6821                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled.<wbr/></p>
6822 <p>The application-selected color transform matrix
6823 (<a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>) and gains
6824 (<a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a>) are used by the camera
6825 device for manual white balance control.<wbr/></p></span>
6826                   </li>
6827                   <li>
6828                     <span class="entry_type_enum_name">AUTO</span>
6829                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is active.<wbr/></p>
6830 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
6831 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
6832 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
6833 values used by the camera device for the transform and gains
6834 will be available in the capture result for this request.<wbr/></p></span>
6835                   </li>
6836                   <li>
6837                     <span class="entry_type_enum_name">INCANDESCENT</span>
6838                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
6839 the camera device uses incandescent light as the assumed scene
6840 illumination for white balance.<wbr/></p>
6841 <p>While the exact white balance transforms are up to the
6842 camera device,<wbr/> they will approximately match the CIE
6843 standard illuminant A.<wbr/></p>
6844 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
6845 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
6846 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
6847 values used by the camera device for the transform and gains
6848 will be available in the capture result for this request.<wbr/></p></span>
6849                   </li>
6850                   <li>
6851                     <span class="entry_type_enum_name">FLUORESCENT</span>
6852                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
6853 the camera device uses fluorescent light as the assumed scene
6854 illumination for white balance.<wbr/></p>
6855 <p>While the exact white balance transforms are up to the
6856 camera device,<wbr/> they will approximately match the CIE
6857 standard illuminant F2.<wbr/></p>
6858 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
6859 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
6860 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
6861 values used by the camera device for the transform and gains
6862 will be available in the capture result for this request.<wbr/></p></span>
6863                   </li>
6864                   <li>
6865                     <span class="entry_type_enum_name">WARM_FLUORESCENT</span>
6866                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
6867 the camera device uses warm fluorescent light as the assumed scene
6868 illumination for white balance.<wbr/></p>
6869 <p>While the exact white balance transforms are up to the
6870 camera device,<wbr/> they will approximately match the CIE
6871 standard illuminant F4.<wbr/></p>
6872 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
6873 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
6874 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
6875 values used by the camera device for the transform and gains
6876 will be available in the capture result for this request.<wbr/></p></span>
6877                   </li>
6878                   <li>
6879                     <span class="entry_type_enum_name">DAYLIGHT</span>
6880                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
6881 the camera device uses daylight light as the assumed scene
6882 illumination for white balance.<wbr/></p>
6883 <p>While the exact white balance transforms are up to the
6884 camera device,<wbr/> they will approximately match the CIE
6885 standard illuminant D65.<wbr/></p>
6886 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
6887 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
6888 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
6889 values used by the camera device for the transform and gains
6890 will be available in the capture result for this request.<wbr/></p></span>
6891                   </li>
6892                   <li>
6893                     <span class="entry_type_enum_name">CLOUDY_DAYLIGHT</span>
6894                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
6895 the camera device uses cloudy daylight light as the assumed scene
6896 illumination for white balance.<wbr/></p>
6897 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
6898 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
6899 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
6900 values used by the camera device for the transform and gains
6901 will be available in the capture result for this request.<wbr/></p></span>
6902                   </li>
6903                   <li>
6904                     <span class="entry_type_enum_name">TWILIGHT</span>
6905                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
6906 the camera device uses twilight light as the assumed scene
6907 illumination for white balance.<wbr/></p>
6908 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
6909 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
6910 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
6911 values used by the camera device for the transform and gains
6912 will be available in the capture result for this request.<wbr/></p></span>
6913                   </li>
6914                   <li>
6915                     <span class="entry_type_enum_name">SHADE</span>
6916                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
6917 the camera device uses shade light as the assumed scene
6918 illumination for white balance.<wbr/></p>
6919 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
6920 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
6921 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
6922 values used by the camera device for the transform and gains
6923 will be available in the capture result for this request.<wbr/></p></span>
6924                   </li>
6925                 </ul>
6926
6927             </td> <!-- entry_type -->
6928
6929             <td class="entry_description">
6930               <p>Whether auto-white balance (AWB) is currently setting the color
6931 transform fields,<wbr/> and what its illumination target
6932 is.<wbr/></p>
6933             </td>
6934
6935             <td class="entry_units">
6936             </td>
6937
6938             <td class="entry_range">
6939               <p><a href="#static_android.control.awbAvailableModes">android.<wbr/>control.<wbr/>awb<wbr/>Available<wbr/>Modes</a></p>
6940             </td>
6941
6942             <td class="entry_tags">
6943               <ul class="entry_tags">
6944                   <li><a href="#tag_BC">BC</a></li>
6945               </ul>
6946             </td>
6947
6948           </tr>
6949           <tr class="entries_header">
6950             <th class="th_details" colspan="5">Details</th>
6951           </tr>
6952           <tr class="entry_cont">
6953             <td class="entry_details" colspan="5">
6954               <p>This control is only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is AUTO.<wbr/></p>
6955 <p>When set to the ON mode,<wbr/> the camera device's auto-white balance
6956 routine is enabled,<wbr/> overriding the application's selected
6957 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>,<wbr/> <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
6958 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a>.<wbr/></p>
6959 <p>When set to the OFF mode,<wbr/> the camera device's auto-white balance
6960 routine is disabled.<wbr/> The application manually controls the white
6961 balance by <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>,<wbr/> <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a>
6962 and <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a>.<wbr/></p>
6963 <p>When set to any other modes,<wbr/> the camera device's auto-white
6964 balance routine is disabled.<wbr/> The camera device uses each
6965 particular illumination target for white balance
6966 adjustment.<wbr/> The application's values for
6967 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>,<wbr/>
6968 <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
6969 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> are ignored.<wbr/></p>
6970             </td>
6971           </tr>
6972
6973
6974           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6975            <!-- end of entry -->
6976
6977
6978           <tr class="entry" id="dynamic_android.control.awbRegions">
6979             <td class="entry_name
6980              " rowspan="5">
6981               android.<wbr/>control.<wbr/>awb<wbr/>Regions
6982             </td>
6983             <td class="entry_type">
6984                 <span class="entry_type_name">int32</span>
6985                 <span class="entry_type_container">x</span>
6986
6987                 <span class="entry_type_array">
6988                   5 x area_count
6989                 </span>
6990               <span class="entry_type_visibility"> [public as meteringRectangle]</span>
6991
6992
6993
6994
6995
6996
6997             </td> <!-- entry_type -->
6998
6999             <td class="entry_description">
7000               <p>List of metering areas to use for auto-white-balance illuminant
7001 estimation.<wbr/></p>
7002             </td>
7003
7004             <td class="entry_units">
7005               Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
7006             </td>
7007
7008             <td class="entry_range">
7009               <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
7010 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
7011             </td>
7012
7013             <td class="entry_tags">
7014               <ul class="entry_tags">
7015                   <li><a href="#tag_BC">BC</a></li>
7016               </ul>
7017             </td>
7018
7019           </tr>
7020           <tr class="entries_header">
7021             <th class="th_details" colspan="5">Details</th>
7022           </tr>
7023           <tr class="entry_cont">
7024             <td class="entry_details" colspan="5">
7025               <p>Not available if <a href="#static_android.control.maxRegionsAwb">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb</a> is 0.<wbr/>
7026 Otherwise will always be present.<wbr/></p>
7027 <p>The maximum number of regions supported by the device is determined by the value
7028 of <a href="#static_android.control.maxRegionsAwb">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb</a>.<wbr/></p>
7029 <p>The coordinate system is based on the active pixel array,<wbr/>
7030 with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
7031 (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
7032 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
7033 bottom-right pixel in the active pixel array.<wbr/></p>
7034 <p>The weight must range from 0 to 1000,<wbr/> and represents a weight
7035 for every pixel in the area.<wbr/> This means that a large metering area
7036 with the same weight as a smaller area will have more effect in
7037 the metering result.<wbr/> Metering areas can partially overlap and the
7038 camera device will add the weights in the overlap region.<wbr/></p>
7039 <p>The weights are relative to weights of other white balance metering regions,<wbr/> so if
7040 only one region is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with
7041 0 weight is ignored.<wbr/></p>
7042 <p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
7043 camera device.<wbr/></p>
7044 <p>If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> returned in
7045 capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
7046 region and output only the intersection rectangle as the metering region in the result
7047 metadata.<wbr/>  If the region is entirely outside the crop region,<wbr/> it will be ignored and
7048 not reported in the result metadata.<wbr/></p>
7049             </td>
7050           </tr>
7051
7052           <tr class="entries_header">
7053             <th class="th_details" colspan="5">HAL Implementation Details</th>
7054           </tr>
7055           <tr class="entry_cont">
7056             <td class="entry_details" colspan="5">
7057               <p>The HAL level representation of MeteringRectangle[] is a
7058 int[5 * area_<wbr/>count].<wbr/>
7059 Every five elements represent a metering region of
7060 (xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
7061 The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
7062 exclusive on xmax and ymax.<wbr/></p>
7063             </td>
7064           </tr>
7065
7066           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7067            <!-- end of entry -->
7068
7069
7070           <tr class="entry" id="dynamic_android.control.captureIntent">
7071             <td class="entry_name
7072              " rowspan="3">
7073               android.<wbr/>control.<wbr/>capture<wbr/>Intent
7074             </td>
7075             <td class="entry_type">
7076                 <span class="entry_type_name entry_type_name_enum">byte</span>
7077
7078               <span class="entry_type_visibility"> [public]</span>
7079
7080
7081               <span class="entry_type_hwlevel">[legacy] </span>
7082
7083
7084
7085                 <ul class="entry_type_enum">
7086                   <li>
7087                     <span class="entry_type_enum_name">CUSTOM</span>
7088                     <span class="entry_type_enum_notes"><p>The goal of this request doesn't fall into the other
7089 categories.<wbr/> The camera device will default to preview-like
7090 behavior.<wbr/></p></span>
7091                   </li>
7092                   <li>
7093                     <span class="entry_type_enum_name">PREVIEW</span>
7094                     <span class="entry_type_enum_notes"><p>This request is for a preview-like use case.<wbr/></p>
7095 <p>The precapture trigger may be used to start off a metering
7096 w/<wbr/>flash sequence.<wbr/></p></span>
7097                   </li>
7098                   <li>
7099                     <span class="entry_type_enum_name">STILL_CAPTURE</span>
7100                     <span class="entry_type_enum_notes"><p>This request is for a still capture-type
7101 use case.<wbr/></p>
7102 <p>If the flash unit is under automatic control,<wbr/> it may fire as needed.<wbr/></p></span>
7103                   </li>
7104                   <li>
7105                     <span class="entry_type_enum_name">VIDEO_RECORD</span>
7106                     <span class="entry_type_enum_notes"><p>This request is for a video recording
7107 use case.<wbr/></p></span>
7108                   </li>
7109                   <li>
7110                     <span class="entry_type_enum_name">VIDEO_SNAPSHOT</span>
7111                     <span class="entry_type_enum_notes"><p>This request is for a video snapshot (still
7112 image while recording video) use case.<wbr/></p>
7113 <p>The camera device should take the highest-quality image
7114 possible (given the other settings) without disrupting the
7115 frame rate of video recording.<wbr/>  </p></span>
7116                   </li>
7117                   <li>
7118                     <span class="entry_type_enum_name">ZERO_SHUTTER_LAG</span>
7119                     <span class="entry_type_enum_notes"><p>This request is for a ZSL usecase; the
7120 application will stream full-resolution images and
7121 reprocess one or several later for a final
7122 capture.<wbr/></p></span>
7123                   </li>
7124                   <li>
7125                     <span class="entry_type_enum_name">MANUAL</span>
7126                     <span class="entry_type_enum_notes"><p>This request is for manual capture use case where
7127 the applications want to directly control the capture parameters.<wbr/></p>
7128 <p>For example,<wbr/> the application may wish to manually control
7129 <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/> <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> etc.<wbr/></p></span>
7130                   </li>
7131                 </ul>
7132
7133             </td> <!-- entry_type -->
7134
7135             <td class="entry_description">
7136               <p>Information to the camera device 3A (auto-exposure,<wbr/>
7137 auto-focus,<wbr/> auto-white balance) routines about the purpose
7138 of this capture,<wbr/> to help the camera device to decide optimal 3A
7139 strategy.<wbr/></p>
7140             </td>
7141
7142             <td class="entry_units">
7143             </td>
7144
7145             <td class="entry_range">
7146             </td>
7147
7148             <td class="entry_tags">
7149               <ul class="entry_tags">
7150                   <li><a href="#tag_BC">BC</a></li>
7151               </ul>
7152             </td>
7153
7154           </tr>
7155           <tr class="entries_header">
7156             <th class="th_details" colspan="5">Details</th>
7157           </tr>
7158           <tr class="entry_cont">
7159             <td class="entry_details" colspan="5">
7160               <p>This control (except for MANUAL) is only effective if
7161 <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> != OFF</code> and any 3A routine is active.<wbr/></p>
7162 <p>ZERO_<wbr/>SHUTTER_<wbr/>LAG will be supported if <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
7163 contains ZSL.<wbr/> MANUAL will be supported if <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
7164 contains MANUAL_<wbr/>SENSOR.<wbr/> Other intent values are always supported.<wbr/></p>
7165             </td>
7166           </tr>
7167
7168
7169           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7170            <!-- end of entry -->
7171
7172
7173           <tr class="entry" id="dynamic_android.control.awbState">
7174             <td class="entry_name
7175              " rowspan="3">
7176               android.<wbr/>control.<wbr/>awb<wbr/>State
7177             </td>
7178             <td class="entry_type">
7179                 <span class="entry_type_name entry_type_name_enum">byte</span>
7180
7181               <span class="entry_type_visibility"> [public]</span>
7182
7183
7184               <span class="entry_type_hwlevel">[limited] </span>
7185
7186
7187
7188                 <ul class="entry_type_enum">
7189                   <li>
7190                     <span class="entry_type_enum_name">INACTIVE</span>
7191                     <span class="entry_type_enum_notes"><p>AWB is not in auto mode,<wbr/> or has not yet started metering.<wbr/></p>
7192 <p>When a camera device is opened,<wbr/> it starts in this
7193 state.<wbr/> This is a transient state,<wbr/> the camera device may
7194 skip reporting this state in capture
7195 result.<wbr/></p></span>
7196                   </li>
7197                   <li>
7198                     <span class="entry_type_enum_name">SEARCHING</span>
7199                     <span class="entry_type_enum_notes"><p>AWB doesn't yet have a good set of control
7200 values for the current scene.<wbr/></p>
7201 <p>This is a transient state,<wbr/> the camera device
7202 may skip reporting this state in capture result.<wbr/></p></span>
7203                   </li>
7204                   <li>
7205                     <span class="entry_type_enum_name">CONVERGED</span>
7206                     <span class="entry_type_enum_notes"><p>AWB has a good set of control values for the
7207 current scene.<wbr/></p></span>
7208                   </li>
7209                   <li>
7210                     <span class="entry_type_enum_name">LOCKED</span>
7211                     <span class="entry_type_enum_notes"><p>AWB has been locked.<wbr/></p></span>
7212                   </li>
7213                 </ul>
7214
7215             </td> <!-- entry_type -->
7216
7217             <td class="entry_description">
7218               <p>Current state of auto-white balance (AWB) algorithm.<wbr/></p>
7219             </td>
7220
7221             <td class="entry_units">
7222             </td>
7223
7224             <td class="entry_range">
7225             </td>
7226
7227             <td class="entry_tags">
7228             </td>
7229
7230           </tr>
7231           <tr class="entries_header">
7232             <th class="th_details" colspan="5">Details</th>
7233           </tr>
7234           <tr class="entry_cont">
7235             <td class="entry_details" colspan="5">
7236               <p>Switching between or enabling AWB modes (<a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>) always
7237 resets the AWB state to INACTIVE.<wbr/> Similarly,<wbr/> switching between <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a>,<wbr/>
7238 or <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a> if <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == USE_<wbr/>SCENE_<wbr/>MODE</code> resets all
7239 the algorithm states to INACTIVE.<wbr/></p>
7240 <p>The camera device can do several state transitions between two results,<wbr/> if it is
7241 allowed by the state transition table.<wbr/> So INACTIVE may never actually be seen in
7242 a result.<wbr/></p>
7243 <p>The state in the result is the state for this image (in sync with this image): if
7244 AWB state becomes CONVERGED,<wbr/> then the image data associated with this result should
7245 be good to use.<wbr/></p>
7246 <p>Below are state transition tables for different AWB modes.<wbr/></p>
7247 <p>When <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != AWB_<wbr/>MODE_<wbr/>AUTO</code>:</p>
7248 <table>
7249 <thead>
7250 <tr>
7251 <th align="center">State</th>
7252 <th align="center">Transition Cause</th>
7253 <th align="center">New State</th>
7254 <th align="center">Notes</th>
7255 </tr>
7256 </thead>
7257 <tbody>
7258 <tr>
7259 <td align="center">INACTIVE</td>
7260 <td align="center"></td>
7261 <td align="center">INACTIVE</td>
7262 <td align="center">Camera device auto white balance algorithm is disabled</td>
7263 </tr>
7264 </tbody>
7265 </table>
7266 <p>When <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> is AWB_<wbr/>MODE_<wbr/>AUTO:</p>
7267 <table>
7268 <thead>
7269 <tr>
7270 <th align="center">State</th>
7271 <th align="center">Transition Cause</th>
7272 <th align="center">New State</th>
7273 <th align="center">Notes</th>
7274 </tr>
7275 </thead>
7276 <tbody>
7277 <tr>
7278 <td align="center">INACTIVE</td>
7279 <td align="center">Camera device initiates AWB scan</td>
7280 <td align="center">SEARCHING</td>
7281 <td align="center">Values changing</td>
7282 </tr>
7283 <tr>
7284 <td align="center">INACTIVE</td>
7285 <td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is ON</td>
7286 <td align="center">LOCKED</td>
7287 <td align="center">Values locked</td>
7288 </tr>
7289 <tr>
7290 <td align="center">SEARCHING</td>
7291 <td align="center">Camera device finishes AWB scan</td>
7292 <td align="center">CONVERGED</td>
7293 <td align="center">Good values,<wbr/> not changing</td>
7294 </tr>
7295 <tr>
7296 <td align="center">SEARCHING</td>
7297 <td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is ON</td>
7298 <td align="center">LOCKED</td>
7299 <td align="center">Values locked</td>
7300 </tr>
7301 <tr>
7302 <td align="center">CONVERGED</td>
7303 <td align="center">Camera device initiates AWB scan</td>
7304 <td align="center">SEARCHING</td>
7305 <td align="center">Values changing</td>
7306 </tr>
7307 <tr>
7308 <td align="center">CONVERGED</td>
7309 <td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is ON</td>
7310 <td align="center">LOCKED</td>
7311 <td align="center">Values locked</td>
7312 </tr>
7313 <tr>
7314 <td align="center">LOCKED</td>
7315 <td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is OFF</td>
7316 <td align="center">SEARCHING</td>
7317 <td align="center">Values not good after unlock</td>
7318 </tr>
7319 </tbody>
7320 </table>
7321 <p>For the above table,<wbr/> the camera device may skip reporting any state changes that happen
7322 without application intervention (i.<wbr/>e.<wbr/> mode switch,<wbr/> trigger,<wbr/> locking).<wbr/> Any state that
7323 can be skipped in that manner is called a transient state.<wbr/></p>
7324 <p>For example,<wbr/> for this AWB mode (AWB_<wbr/>MODE_<wbr/>AUTO),<wbr/> in addition to the state transitions
7325 listed in above table,<wbr/> it is also legal for the camera device to skip one or more
7326 transient states between two results.<wbr/> See below table for examples:</p>
7327 <table>
7328 <thead>
7329 <tr>
7330 <th align="center">State</th>
7331 <th align="center">Transition Cause</th>
7332 <th align="center">New State</th>
7333 <th align="center">Notes</th>
7334 </tr>
7335 </thead>
7336 <tbody>
7337 <tr>
7338 <td align="center">INACTIVE</td>
7339 <td align="center">Camera device finished AWB scan</td>
7340 <td align="center">CONVERGED</td>
7341 <td align="center">Values are already good,<wbr/> transient states are skipped by camera device.<wbr/></td>
7342 </tr>
7343 <tr>
7344 <td align="center">LOCKED</td>
7345 <td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is OFF</td>
7346 <td align="center">CONVERGED</td>
7347 <td align="center">Values good after unlock,<wbr/> transient states are skipped by camera device.<wbr/></td>
7348 </tr>
7349 </tbody>
7350 </table>
7351             </td>
7352           </tr>
7353
7354
7355           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7356            <!-- end of entry -->
7357
7358
7359           <tr class="entry" id="dynamic_android.control.effectMode">
7360             <td class="entry_name
7361              " rowspan="3">
7362               android.<wbr/>control.<wbr/>effect<wbr/>Mode
7363             </td>
7364             <td class="entry_type">
7365                 <span class="entry_type_name entry_type_name_enum">byte</span>
7366
7367               <span class="entry_type_visibility"> [public]</span>
7368
7369
7370               <span class="entry_type_hwlevel">[legacy] </span>
7371
7372
7373
7374                 <ul class="entry_type_enum">
7375                   <li>
7376                     <span class="entry_type_enum_name">OFF</span>
7377                     <span class="entry_type_enum_notes"><p>No color effect will be applied.<wbr/></p></span>
7378                   </li>
7379                   <li>
7380                     <span class="entry_type_enum_name">MONO</span>
7381                     <span class="entry_type_enum_optional">[optional]</span>
7382                     <span class="entry_type_enum_notes"><p>A "monocolor" effect where the image is mapped into
7383 a single color.<wbr/></p>
7384 <p>This will typically be grayscale.<wbr/></p></span>
7385                   </li>
7386                   <li>
7387                     <span class="entry_type_enum_name">NEGATIVE</span>
7388                     <span class="entry_type_enum_optional">[optional]</span>
7389                     <span class="entry_type_enum_notes"><p>A "photo-negative" effect where the image's colors
7390 are inverted.<wbr/></p></span>
7391                   </li>
7392                   <li>
7393                     <span class="entry_type_enum_name">SOLARIZE</span>
7394                     <span class="entry_type_enum_optional">[optional]</span>
7395                     <span class="entry_type_enum_notes"><p>A "solarisation" effect (Sabattier effect) where the
7396 image is wholly or partially reversed in
7397 tone.<wbr/></p></span>
7398                   </li>
7399                   <li>
7400                     <span class="entry_type_enum_name">SEPIA</span>
7401                     <span class="entry_type_enum_optional">[optional]</span>
7402                     <span class="entry_type_enum_notes"><p>A "sepia" effect where the image is mapped into warm
7403 gray,<wbr/> red,<wbr/> and brown tones.<wbr/></p></span>
7404                   </li>
7405                   <li>
7406                     <span class="entry_type_enum_name">POSTERIZE</span>
7407                     <span class="entry_type_enum_optional">[optional]</span>
7408                     <span class="entry_type_enum_notes"><p>A "posterization" effect where the image uses
7409 discrete regions of tone rather than a continuous
7410 gradient of tones.<wbr/></p></span>
7411                   </li>
7412                   <li>
7413                     <span class="entry_type_enum_name">WHITEBOARD</span>
7414                     <span class="entry_type_enum_optional">[optional]</span>
7415                     <span class="entry_type_enum_notes"><p>A "whiteboard" effect where the image is typically displayed
7416 as regions of white,<wbr/> with black or grey details.<wbr/></p></span>
7417                   </li>
7418                   <li>
7419                     <span class="entry_type_enum_name">BLACKBOARD</span>
7420                     <span class="entry_type_enum_optional">[optional]</span>
7421                     <span class="entry_type_enum_notes"><p>A "blackboard" effect where the image is typically displayed
7422 as regions of black,<wbr/> with white or grey details.<wbr/></p></span>
7423                   </li>
7424                   <li>
7425                     <span class="entry_type_enum_name">AQUA</span>
7426                     <span class="entry_type_enum_optional">[optional]</span>
7427                     <span class="entry_type_enum_notes"><p>An "aqua" effect where a blue hue is added to the image.<wbr/></p></span>
7428                   </li>
7429                 </ul>
7430
7431             </td> <!-- entry_type -->
7432
7433             <td class="entry_description">
7434               <p>A special color effect to apply.<wbr/></p>
7435             </td>
7436
7437             <td class="entry_units">
7438             </td>
7439
7440             <td class="entry_range">
7441               <p><a href="#static_android.control.availableEffects">android.<wbr/>control.<wbr/>available<wbr/>Effects</a></p>
7442             </td>
7443
7444             <td class="entry_tags">
7445               <ul class="entry_tags">
7446                   <li><a href="#tag_BC">BC</a></li>
7447               </ul>
7448             </td>
7449
7450           </tr>
7451           <tr class="entries_header">
7452             <th class="th_details" colspan="5">Details</th>
7453           </tr>
7454           <tr class="entry_cont">
7455             <td class="entry_details" colspan="5">
7456               <p>When this mode is set,<wbr/> a color effect will be applied
7457 to images produced by the camera device.<wbr/> The interpretation
7458 and implementation of these color effects is left to the
7459 implementor of the camera device,<wbr/> and should not be
7460 depended on to be consistent (or present) across all
7461 devices.<wbr/></p>
7462             </td>
7463           </tr>
7464
7465
7466           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7467            <!-- end of entry -->
7468
7469
7470           <tr class="entry" id="dynamic_android.control.mode">
7471             <td class="entry_name
7472              " rowspan="3">
7473               android.<wbr/>control.<wbr/>mode
7474             </td>
7475             <td class="entry_type">
7476                 <span class="entry_type_name entry_type_name_enum">byte</span>
7477
7478               <span class="entry_type_visibility"> [public]</span>
7479
7480
7481               <span class="entry_type_hwlevel">[legacy] </span>
7482
7483
7484
7485                 <ul class="entry_type_enum">
7486                   <li>
7487                     <span class="entry_type_enum_name">OFF</span>
7488                     <span class="entry_type_enum_notes"><p>Full application control of pipeline.<wbr/></p>
7489 <p>All control by the device's metering and focusing (3A)
7490 routines is disabled,<wbr/> and no other settings in
7491 android.<wbr/>control.<wbr/>* have any effect,<wbr/> except that
7492 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> may be used by the camera
7493 device to select post-processing values for processing
7494 blocks that do not allow for manual control,<wbr/> or are not
7495 exposed by the camera API.<wbr/></p>
7496 <p>However,<wbr/> the camera device's 3A routines may continue to
7497 collect statistics and update their internal state so that
7498 when control is switched to AUTO mode,<wbr/> good control values
7499 can be immediately applied.<wbr/></p></span>
7500                   </li>
7501                   <li>
7502                     <span class="entry_type_enum_name">AUTO</span>
7503                     <span class="entry_type_enum_notes"><p>Use settings for each individual 3A routine.<wbr/></p>
7504 <p>Manual control of capture parameters is disabled.<wbr/> All
7505 controls in android.<wbr/>control.<wbr/>* besides sceneMode take
7506 effect.<wbr/></p></span>
7507                   </li>
7508                   <li>
7509                     <span class="entry_type_enum_name">USE_SCENE_MODE</span>
7510                     <span class="entry_type_enum_notes"><p>Use a specific scene mode.<wbr/></p>
7511 <p>Enabling this disables control.<wbr/>aeMode,<wbr/> control.<wbr/>awbMode and
7512 control.<wbr/>afMode controls; the camera device will ignore
7513 those settings while USE_<wbr/>SCENE_<wbr/>MODE is active (except for
7514 FACE_<wbr/>PRIORITY scene mode).<wbr/> Other control entries are still
7515 active.<wbr/>  This setting can only be used if scene mode is
7516 supported (i.<wbr/>e.<wbr/> <a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a>
7517 contain some modes other than DISABLED).<wbr/></p></span>
7518                   </li>
7519                   <li>
7520                     <span class="entry_type_enum_name">OFF_KEEP_STATE</span>
7521                     <span class="entry_type_enum_notes"><p>Same as OFF mode,<wbr/> except that this capture will not be
7522 used by camera device background auto-exposure,<wbr/> auto-white balance and
7523 auto-focus algorithms (3A) to update their statistics.<wbr/></p>
7524 <p>Specifically,<wbr/> the 3A routines are locked to the last
7525 values set from a request with AUTO,<wbr/> OFF,<wbr/> or
7526 USE_<wbr/>SCENE_<wbr/>MODE,<wbr/> and any statistics or state updates
7527 collected from manual captures with OFF_<wbr/>KEEP_<wbr/>STATE will be
7528 discarded by the camera device.<wbr/></p></span>
7529                   </li>
7530                 </ul>
7531
7532             </td> <!-- entry_type -->
7533
7534             <td class="entry_description">
7535               <p>Overall mode of 3A (auto-exposure,<wbr/> auto-white-balance,<wbr/> auto-focus) control
7536 routines.<wbr/></p>
7537             </td>
7538
7539             <td class="entry_units">
7540             </td>
7541
7542             <td class="entry_range">
7543             </td>
7544
7545             <td class="entry_tags">
7546               <ul class="entry_tags">
7547                   <li><a href="#tag_BC">BC</a></li>
7548               </ul>
7549             </td>
7550
7551           </tr>
7552           <tr class="entries_header">
7553             <th class="th_details" colspan="5">Details</th>
7554           </tr>
7555           <tr class="entry_cont">
7556             <td class="entry_details" colspan="5">
7557               <p>This is a top-level 3A control switch.<wbr/> When set to OFF,<wbr/> all 3A control
7558 by the camera device is disabled.<wbr/> The application must set the fields for
7559 capture parameters itself.<wbr/></p>
7560 <p>When set to AUTO,<wbr/> the individual algorithm controls in
7561 android.<wbr/>control.<wbr/>* are in effect,<wbr/> such as <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>.<wbr/></p>
7562 <p>When set to USE_<wbr/>SCENE_<wbr/>MODE,<wbr/> the individual controls in
7563 android.<wbr/>control.<wbr/>* are mostly disabled,<wbr/> and the camera device implements
7564 one of the scene mode settings (such as ACTION,<wbr/> SUNSET,<wbr/> or PARTY)
7565 as it wishes.<wbr/> The camera device scene mode 3A settings are provided by
7566 <a href="#static_android.control.sceneModeOverrides">android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides</a>.<wbr/></p>
7567 <p>When set to OFF_<wbr/>KEEP_<wbr/>STATE,<wbr/> it is similar to OFF mode,<wbr/> the only difference
7568 is that this frame will not be used by camera device background 3A statistics
7569 update,<wbr/> as if this frame is never captured.<wbr/> This mode can be used in the scenario
7570 where the application doesn't want a 3A manual control capture to affect
7571 the subsequent auto 3A capture results.<wbr/></p>
7572 <p>LEGACY mode devices will only support AUTO and USE_<wbr/>SCENE_<wbr/>MODE modes.<wbr/>
7573 LIMITED mode devices will only support OFF and OFF_<wbr/>KEEP_<wbr/>STATE if they
7574 support the MANUAL_<wbr/>SENSOR and MANUAL_<wbr/>POST_<wbr/>PROCSESING capabilities.<wbr/>
7575 FULL mode devices will always support OFF and OFF_<wbr/>KEEP_<wbr/>STATE.<wbr/></p>
7576             </td>
7577           </tr>
7578
7579
7580           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7581            <!-- end of entry -->
7582
7583
7584           <tr class="entry" id="dynamic_android.control.sceneMode">
7585             <td class="entry_name
7586              " rowspan="5">
7587               android.<wbr/>control.<wbr/>scene<wbr/>Mode
7588             </td>
7589             <td class="entry_type">
7590                 <span class="entry_type_name entry_type_name_enum">byte</span>
7591
7592               <span class="entry_type_visibility"> [public]</span>
7593
7594
7595               <span class="entry_type_hwlevel">[legacy] </span>
7596
7597
7598
7599                 <ul class="entry_type_enum">
7600                   <li>
7601                     <span class="entry_type_enum_name">DISABLED</span>
7602                     <span class="entry_type_enum_value">0</span>
7603                     <span class="entry_type_enum_notes"><p>Indicates that no scene modes are set for a given capture request.<wbr/></p></span>
7604                   </li>
7605                   <li>
7606                     <span class="entry_type_enum_name">FACE_PRIORITY</span>
7607                     <span class="entry_type_enum_notes"><p>If face detection support exists,<wbr/> use face
7608 detection data for auto-focus,<wbr/> auto-white balance,<wbr/> and
7609 auto-exposure routines.<wbr/></p>
7610 <p>If face detection statistics are disabled
7611 (i.<wbr/>e.<wbr/> <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> is set to OFF),<wbr/>
7612 this should still operate correctly (but will not return
7613 face detection statistics to the framework).<wbr/></p>
7614 <p>Unlike the other scene modes,<wbr/> <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
7615 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>
7616 remain active when FACE_<wbr/>PRIORITY is set.<wbr/></p></span>
7617                   </li>
7618                   <li>
7619                     <span class="entry_type_enum_name">ACTION</span>
7620                     <span class="entry_type_enum_optional">[optional]</span>
7621                     <span class="entry_type_enum_notes"><p>Optimized for photos of quickly moving objects.<wbr/></p>
7622 <p>Similar to SPORTS.<wbr/></p></span>
7623                   </li>
7624                   <li>
7625                     <span class="entry_type_enum_name">PORTRAIT</span>
7626                     <span class="entry_type_enum_optional">[optional]</span>
7627                     <span class="entry_type_enum_notes"><p>Optimized for still photos of people.<wbr/></p></span>
7628                   </li>
7629                   <li>
7630                     <span class="entry_type_enum_name">LANDSCAPE</span>
7631                     <span class="entry_type_enum_optional">[optional]</span>
7632                     <span class="entry_type_enum_notes"><p>Optimized for photos of distant macroscopic objects.<wbr/></p></span>
7633                   </li>
7634                   <li>
7635                     <span class="entry_type_enum_name">NIGHT</span>
7636                     <span class="entry_type_enum_optional">[optional]</span>
7637                     <span class="entry_type_enum_notes"><p>Optimized for low-light settings.<wbr/></p></span>
7638                   </li>
7639                   <li>
7640                     <span class="entry_type_enum_name">NIGHT_PORTRAIT</span>
7641                     <span class="entry_type_enum_optional">[optional]</span>
7642                     <span class="entry_type_enum_notes"><p>Optimized for still photos of people in low-light
7643 settings.<wbr/></p></span>
7644                   </li>
7645                   <li>
7646                     <span class="entry_type_enum_name">THEATRE</span>
7647                     <span class="entry_type_enum_optional">[optional]</span>
7648                     <span class="entry_type_enum_notes"><p>Optimized for dim,<wbr/> indoor settings where flash must
7649 remain off.<wbr/></p></span>
7650                   </li>
7651                   <li>
7652                     <span class="entry_type_enum_name">BEACH</span>
7653                     <span class="entry_type_enum_optional">[optional]</span>
7654                     <span class="entry_type_enum_notes"><p>Optimized for bright,<wbr/> outdoor beach settings.<wbr/></p></span>
7655                   </li>
7656                   <li>
7657                     <span class="entry_type_enum_name">SNOW</span>
7658                     <span class="entry_type_enum_optional">[optional]</span>
7659                     <span class="entry_type_enum_notes"><p>Optimized for bright,<wbr/> outdoor settings containing snow.<wbr/></p></span>
7660                   </li>
7661                   <li>
7662                     <span class="entry_type_enum_name">SUNSET</span>
7663                     <span class="entry_type_enum_optional">[optional]</span>
7664                     <span class="entry_type_enum_notes"><p>Optimized for scenes of the setting sun.<wbr/></p></span>
7665                   </li>
7666                   <li>
7667                     <span class="entry_type_enum_name">STEADYPHOTO</span>
7668                     <span class="entry_type_enum_optional">[optional]</span>
7669                     <span class="entry_type_enum_notes"><p>Optimized to avoid blurry photos due to small amounts of
7670 device motion (for example: due to hand shake).<wbr/></p></span>
7671                   </li>
7672                   <li>
7673                     <span class="entry_type_enum_name">FIREWORKS</span>
7674                     <span class="entry_type_enum_optional">[optional]</span>
7675                     <span class="entry_type_enum_notes"><p>Optimized for nighttime photos of fireworks.<wbr/></p></span>
7676                   </li>
7677                   <li>
7678                     <span class="entry_type_enum_name">SPORTS</span>
7679                     <span class="entry_type_enum_optional">[optional]</span>
7680                     <span class="entry_type_enum_notes"><p>Optimized for photos of quickly moving people.<wbr/></p>
7681 <p>Similar to ACTION.<wbr/></p></span>
7682                   </li>
7683                   <li>
7684                     <span class="entry_type_enum_name">PARTY</span>
7685                     <span class="entry_type_enum_optional">[optional]</span>
7686                     <span class="entry_type_enum_notes"><p>Optimized for dim,<wbr/> indoor settings with multiple moving
7687 people.<wbr/></p></span>
7688                   </li>
7689                   <li>
7690                     <span class="entry_type_enum_name">CANDLELIGHT</span>
7691                     <span class="entry_type_enum_optional">[optional]</span>
7692                     <span class="entry_type_enum_notes"><p>Optimized for dim settings where the main light source
7693 is a flame.<wbr/></p></span>
7694                   </li>
7695                   <li>
7696                     <span class="entry_type_enum_name">BARCODE</span>
7697                     <span class="entry_type_enum_optional">[optional]</span>
7698                     <span class="entry_type_enum_notes"><p>Optimized for accurately capturing a photo of barcode
7699 for use by camera applications that wish to read the
7700 barcode value.<wbr/></p></span>
7701                   </li>
7702                   <li>
7703                     <span class="entry_type_enum_name">HIGH_SPEED_VIDEO</span>
7704                     <span class="entry_type_enum_optional">[optional]</span>
7705                     <span class="entry_type_enum_notes"><p>Optimized for high speed video recording (frame rate &gt;=60fps) use case.<wbr/></p>
7706 <p>The supported high speed video sizes and fps ranges are specified in
7707 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/> To get desired
7708 output frame rates,<wbr/> the application is only allowed to select video size
7709 and fps range combinations listed in this static metadata.<wbr/> The fps range
7710 can be control via <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a>.<wbr/></p>
7711 <p>In this mode,<wbr/> the camera device will override aeMode,<wbr/> awbMode,<wbr/> and afMode to
7712 ON,<wbr/> ON,<wbr/> and CONTINUOUS_<wbr/>VIDEO,<wbr/> respectively.<wbr/> All post-processing block mode
7713 controls will be overridden to be FAST.<wbr/> Therefore,<wbr/> no manual control of capture
7714 and post-processing parameters is possible.<wbr/> All other controls operate the
7715 same as when <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == AUTO.<wbr/> This means that all other
7716 android.<wbr/>control.<wbr/>* fields continue to work,<wbr/> such as</p>
7717 <ul>
7718 <li><a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a></li>
7719 <li><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a></li>
7720 <li><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a></li>
7721 <li><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a></li>
7722 <li><a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a></li>
7723 <li><a href="#controls_android.control.aeRegions">android.<wbr/>control.<wbr/>ae<wbr/>Regions</a></li>
7724 <li><a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a></li>
7725 <li><a href="#controls_android.control.awbRegions">android.<wbr/>control.<wbr/>awb<wbr/>Regions</a></li>
7726 <li><a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a></li>
7727 <li><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a></li>
7728 </ul>
7729 <p>Outside of android.<wbr/>control.<wbr/>*,<wbr/> the following controls will work:</p>
7730 <ul>
7731 <li><a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> (automatic flash for still capture will not work since aeMode is ON)</li>
7732 <li><a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a> (if it is supported)</li>
7733 <li><a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a></li>
7734 <li><a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a></li>
7735 </ul>
7736 <p>For high speed recording use case,<wbr/> the actual maximum supported frame rate may
7737 be lower than what camera can output,<wbr/> depending on the destination Surfaces for
7738 the image data.<wbr/> For example,<wbr/> if the destination surface is from video encoder,<wbr/>
7739 the application need check if the video encoder is capable of supporting the
7740 high frame rate for a given video size,<wbr/> or it will end up with lower recording
7741 frame rate.<wbr/> If the destination surface is from preview window,<wbr/> the preview frame
7742 rate will be bounded by the screen refresh rate.<wbr/></p>
7743 <p>The camera device will only support up to 2 output high speed streams
7744 (processed non-stalling format defined in <a href="#static_android.request.maxNumOutputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams</a>)
7745 in this mode.<wbr/> This control will be effective only if all of below conditions are true:</p>
7746 <ul>
7747 <li>The application created no more than maxNumHighSpeedStreams processed non-stalling
7748 format output streams,<wbr/> where maxNumHighSpeedStreams is calculated as
7749 min(2,<wbr/> <a href="#static_android.request.maxNumOutputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams</a>[Processed (but not-stalling)]).<wbr/></li>
7750 <li>The stream sizes are selected from the sizes reported by
7751 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/></li>
7752 <li>No processed non-stalling or raw streams are configured.<wbr/></li>
7753 </ul>
7754 <p>When above conditions are NOT satistied,<wbr/> the controls of this mode and
7755 <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a> will be ignored by the camera device,<wbr/>
7756 the camera device will fall back to <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> <code>==</code> AUTO,<wbr/>
7757 and the returned capture result metadata will give the fps range choosen
7758 by the camera device.<wbr/></p>
7759 <p>Switching into or out of this mode may trigger some camera ISP/<wbr/>sensor
7760 reconfigurations,<wbr/> which may introduce extra latency.<wbr/> It is recommended that
7761 the application avoids unnecessary scene mode switch as much as possible.<wbr/></p></span>
7762                   </li>
7763                   <li>
7764                     <span class="entry_type_enum_name">HDR</span>
7765                     <span class="entry_type_enum_optional">[optional]</span>
7766                     <span class="entry_type_enum_optional">[hidden]</span>
7767                     <span class="entry_type_enum_notes"><p>Turn on custom high dynamic range (HDR) mode.<wbr/></p>
7768 <p>This is intended for LEGACY mode devices only;
7769 HAL3+ camera devices should not implement this mode.<wbr/></p></span>
7770                   </li>
7771                 </ul>
7772
7773             </td> <!-- entry_type -->
7774
7775             <td class="entry_description">
7776               <p>Control for which scene mode is currently active.<wbr/></p>
7777             </td>
7778
7779             <td class="entry_units">
7780             </td>
7781
7782             <td class="entry_range">
7783               <p><a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a></p>
7784             </td>
7785
7786             <td class="entry_tags">
7787               <ul class="entry_tags">
7788                   <li><a href="#tag_BC">BC</a></li>
7789               </ul>
7790             </td>
7791
7792           </tr>
7793           <tr class="entries_header">
7794             <th class="th_details" colspan="5">Details</th>
7795           </tr>
7796           <tr class="entry_cont">
7797             <td class="entry_details" colspan="5">
7798               <p>Scene modes are custom camera modes optimized for a certain set of conditions and
7799 capture settings.<wbr/></p>
7800 <p>This is the mode that that is active when
7801 <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == USE_<wbr/>SCENE_<wbr/>MODE</code>.<wbr/> Aside from FACE_<wbr/>PRIORITY,<wbr/>
7802 these modes will disable <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
7803 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> while in use.<wbr/></p>
7804 <p>The interpretation and implementation of these scene modes is left
7805 to the implementor of the camera device.<wbr/> Their behavior will not be
7806 consistent across all devices,<wbr/> and any given device may only implement
7807 a subset of these modes.<wbr/></p>
7808             </td>
7809           </tr>
7810
7811           <tr class="entries_header">
7812             <th class="th_details" colspan="5">HAL Implementation Details</th>
7813           </tr>
7814           <tr class="entry_cont">
7815             <td class="entry_details" colspan="5">
7816               <p>HAL implementations that include scene modes are expected to provide
7817 the per-scene settings to use for <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
7818 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> in
7819 <a href="#static_android.control.sceneModeOverrides">android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides</a>.<wbr/></p>
7820 <p>For HIGH_<wbr/>SPEED_<wbr/>VIDEO mode,<wbr/> if it is included in <a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a>,<wbr/>
7821 the HAL must list supported video size and fps range in
7822 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/> For a given size,<wbr/> e.<wbr/>g.<wbr/>
7823 1280x720,<wbr/> if the HAL has two different sensor configurations for normal streaming
7824 mode and high speed streaming,<wbr/> when this scene mode is set/<wbr/>reset in a sequence of capture
7825 requests,<wbr/> the HAL may have to switch between different sensor modes.<wbr/></p>
7826             </td>
7827           </tr>
7828
7829           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7830            <!-- end of entry -->
7831
7832
7833           <tr class="entry" id="dynamic_android.control.videoStabilizationMode">
7834             <td class="entry_name
7835              " rowspan="3">
7836               android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode
7837             </td>
7838             <td class="entry_type">
7839                 <span class="entry_type_name entry_type_name_enum">byte</span>
7840
7841               <span class="entry_type_visibility"> [public]</span>
7842
7843
7844               <span class="entry_type_hwlevel">[legacy] </span>
7845
7846
7847
7848                 <ul class="entry_type_enum">
7849                   <li>
7850                     <span class="entry_type_enum_name">OFF</span>
7851                     <span class="entry_type_enum_notes"><p>Video stabilization is disabled.<wbr/></p></span>
7852                   </li>
7853                   <li>
7854                     <span class="entry_type_enum_name">ON</span>
7855                     <span class="entry_type_enum_notes"><p>Video stabilization is enabled.<wbr/></p></span>
7856                   </li>
7857                 </ul>
7858
7859             </td> <!-- entry_type -->
7860
7861             <td class="entry_description">
7862               <p>Whether video stabilization is
7863 active.<wbr/></p>
7864             </td>
7865
7866             <td class="entry_units">
7867             </td>
7868
7869             <td class="entry_range">
7870             </td>
7871
7872             <td class="entry_tags">
7873               <ul class="entry_tags">
7874                   <li><a href="#tag_BC">BC</a></li>
7875               </ul>
7876             </td>
7877
7878           </tr>
7879           <tr class="entries_header">
7880             <th class="th_details" colspan="5">Details</th>
7881           </tr>
7882           <tr class="entry_cont">
7883             <td class="entry_details" colspan="5">
7884               <p>Video stabilization automatically translates and scales images from
7885 the camera in order to stabilize motion between consecutive frames.<wbr/></p>
7886 <p>If enabled,<wbr/> video stabilization can modify the
7887 <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> to keep the video stream stabilized.<wbr/></p>
7888 <p>Switching between different video stabilization modes may take several
7889 frames to initialize,<wbr/> the camera device will report the current mode
7890 in capture result metadata.<wbr/> For example,<wbr/> When "ON" mode is requested,<wbr/>
7891 the video stabilization modes in the first several capture results may
7892 still be "OFF",<wbr/> and it will become "ON" when the initialization is
7893 done.<wbr/></p>
7894 <p>If a camera device supports both this mode and OIS
7895 (<a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> turning both modes on may
7896 produce undesirable interaction,<wbr/> so it is recommended not to enable
7897 both at the same time.<wbr/></p>
7898             </td>
7899           </tr>
7900
7901
7902           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7903            <!-- end of entry -->
7904
7905
7906
7907       <!-- end of kind -->
7908       </tbody>
7909
7910   <!-- end of section -->
7911   <tr><td colspan="6" id="section_demosaic" class="section">demosaic</td></tr>
7912
7913
7914       <tr><td colspan="6" class="kind">controls</td></tr>
7915
7916       <thead class="entries_header">
7917         <tr>
7918           <th class="th_name">Property Name</th>
7919           <th class="th_type">Type</th>
7920           <th class="th_description">Description</th>
7921           <th class="th_units">Units</th>
7922           <th class="th_range">Range</th>
7923           <th class="th_tags">Tags</th>
7924         </tr>
7925       </thead>
7926
7927       <tbody>
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938           <tr class="entry" id="controls_android.demosaic.mode">
7939             <td class="entry_name
7940              " rowspan="1">
7941               android.<wbr/>demosaic.<wbr/>mode
7942             </td>
7943             <td class="entry_type">
7944                 <span class="entry_type_name entry_type_name_enum">byte</span>
7945
7946               <span class="entry_type_visibility"> [system]</span>
7947
7948
7949
7950
7951
7952                 <ul class="entry_type_enum">
7953                   <li>
7954                     <span class="entry_type_enum_name">FAST</span>
7955                     <span class="entry_type_enum_notes"><p>Minimal or no slowdown of frame rate compared to
7956 Bayer RAW output.<wbr/></p></span>
7957                   </li>
7958                   <li>
7959                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
7960                     <span class="entry_type_enum_notes"><p>Improved processing quality but the frame rate is slowed down
7961 relative to raw output.<wbr/></p></span>
7962                   </li>
7963                 </ul>
7964
7965             </td> <!-- entry_type -->
7966
7967             <td class="entry_description">
7968               <p>Controls the quality of the demosaicing
7969 processing.<wbr/></p>
7970             </td>
7971
7972             <td class="entry_units">
7973             </td>
7974
7975             <td class="entry_range">
7976             </td>
7977
7978             <td class="entry_tags">
7979               <ul class="entry_tags">
7980                   <li><a href="#tag_FUTURE">FUTURE</a></li>
7981               </ul>
7982             </td>
7983
7984           </tr>
7985
7986
7987           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7988            <!-- end of entry -->
7989
7990
7991
7992       <!-- end of kind -->
7993       </tbody>
7994
7995   <!-- end of section -->
7996   <tr><td colspan="6" id="section_edge" class="section">edge</td></tr>
7997
7998
7999       <tr><td colspan="6" class="kind">controls</td></tr>
8000
8001       <thead class="entries_header">
8002         <tr>
8003           <th class="th_name">Property Name</th>
8004           <th class="th_type">Type</th>
8005           <th class="th_description">Description</th>
8006           <th class="th_units">Units</th>
8007           <th class="th_range">Range</th>
8008           <th class="th_tags">Tags</th>
8009         </tr>
8010       </thead>
8011
8012       <tbody>
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023           <tr class="entry" id="controls_android.edge.mode">
8024             <td class="entry_name
8025              " rowspan="3">
8026               android.<wbr/>edge.<wbr/>mode
8027             </td>
8028             <td class="entry_type">
8029                 <span class="entry_type_name entry_type_name_enum">byte</span>
8030
8031               <span class="entry_type_visibility"> [public]</span>
8032
8033
8034               <span class="entry_type_hwlevel">[full] </span>
8035
8036
8037
8038                 <ul class="entry_type_enum">
8039                   <li>
8040                     <span class="entry_type_enum_name">OFF</span>
8041                     <span class="entry_type_enum_notes"><p>No edge enhancement is applied.<wbr/></p></span>
8042                   </li>
8043                   <li>
8044                     <span class="entry_type_enum_name">FAST</span>
8045                     <span class="entry_type_enum_notes"><p>Apply edge enhancement at a quality level that does not slow down frame rate relative to sensor
8046 output</p></span>
8047                   </li>
8048                   <li>
8049                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
8050                     <span class="entry_type_enum_notes"><p>Apply high-quality edge enhancement,<wbr/> at a cost of reducing output frame rate.<wbr/></p></span>
8051                   </li>
8052                 </ul>
8053
8054             </td> <!-- entry_type -->
8055
8056             <td class="entry_description">
8057               <p>Operation mode for edge
8058 enhancement.<wbr/></p>
8059             </td>
8060
8061             <td class="entry_units">
8062             </td>
8063
8064             <td class="entry_range">
8065               <p><a href="#static_android.edge.availableEdgeModes">android.<wbr/>edge.<wbr/>available<wbr/>Edge<wbr/>Modes</a></p>
8066             </td>
8067
8068             <td class="entry_tags">
8069               <ul class="entry_tags">
8070                   <li><a href="#tag_V1">V1</a></li>
8071               </ul>
8072             </td>
8073
8074           </tr>
8075           <tr class="entries_header">
8076             <th class="th_details" colspan="5">Details</th>
8077           </tr>
8078           <tr class="entry_cont">
8079             <td class="entry_details" colspan="5">
8080               <p>Edge enhancement improves sharpness and details in the captured image.<wbr/> OFF means
8081 no enhancement will be applied by the camera device.<wbr/></p>
8082 <p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean camera device determined enhancement
8083 will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the
8084 camera device will use the highest-quality enhancement algorithms,<wbr/>
8085 even if it slows down capture rate.<wbr/> FAST means the camera device will
8086 not slow down capture rate when applying edge enhancement.<wbr/></p>
8087             </td>
8088           </tr>
8089
8090
8091           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8092            <!-- end of entry -->
8093
8094
8095           <tr class="entry" id="controls_android.edge.strength">
8096             <td class="entry_name
8097              " rowspan="1">
8098               android.<wbr/>edge.<wbr/>strength
8099             </td>
8100             <td class="entry_type">
8101                 <span class="entry_type_name">byte</span>
8102
8103               <span class="entry_type_visibility"> [system]</span>
8104
8105
8106
8107
8108
8109
8110             </td> <!-- entry_type -->
8111
8112             <td class="entry_description">
8113               <p>Control the amount of edge enhancement
8114 applied to the images</p>
8115             </td>
8116
8117             <td class="entry_units">
8118               1-10; 10 is maximum sharpening
8119             </td>
8120
8121             <td class="entry_range">
8122             </td>
8123
8124             <td class="entry_tags">
8125               <ul class="entry_tags">
8126                   <li><a href="#tag_FUTURE">FUTURE</a></li>
8127               </ul>
8128             </td>
8129
8130           </tr>
8131
8132
8133           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8134            <!-- end of entry -->
8135
8136
8137
8138       <!-- end of kind -->
8139       </tbody>
8140       <tr><td colspan="6" class="kind">static</td></tr>
8141
8142       <thead class="entries_header">
8143         <tr>
8144           <th class="th_name">Property Name</th>
8145           <th class="th_type">Type</th>
8146           <th class="th_description">Description</th>
8147           <th class="th_units">Units</th>
8148           <th class="th_range">Range</th>
8149           <th class="th_tags">Tags</th>
8150         </tr>
8151       </thead>
8152
8153       <tbody>
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164           <tr class="entry" id="static_android.edge.availableEdgeModes">
8165             <td class="entry_name
8166              " rowspan="3">
8167               android.<wbr/>edge.<wbr/>available<wbr/>Edge<wbr/>Modes
8168             </td>
8169             <td class="entry_type">
8170                 <span class="entry_type_name">byte</span>
8171                 <span class="entry_type_container">x</span>
8172
8173                 <span class="entry_type_array">
8174                   n
8175                 </span>
8176               <span class="entry_type_visibility"> [public as enumList]</span>
8177
8178
8179               <span class="entry_type_hwlevel">[full] </span>
8180
8181
8182                 <div class="entry_type_notes">list of enums</div>
8183
8184
8185             </td> <!-- entry_type -->
8186
8187             <td class="entry_description">
8188               <p>List of edge enhancement modes for <a href="#controls_android.edge.mode">android.<wbr/>edge.<wbr/>mode</a> that are supported by this camera
8189 device.<wbr/></p>
8190             </td>
8191
8192             <td class="entry_units">
8193             </td>
8194
8195             <td class="entry_range">
8196               <p>Any value listed in <a href="#controls_android.edge.mode">android.<wbr/>edge.<wbr/>mode</a></p>
8197             </td>
8198
8199             <td class="entry_tags">
8200               <ul class="entry_tags">
8201                   <li><a href="#tag_V1">V1</a></li>
8202               </ul>
8203             </td>
8204
8205           </tr>
8206           <tr class="entries_header">
8207             <th class="th_details" colspan="5">Details</th>
8208           </tr>
8209           <tr class="entry_cont">
8210             <td class="entry_details" colspan="5">
8211               <p>Full-capability camera devices must always support OFF; all devices will list FAST.<wbr/></p>
8212             </td>
8213           </tr>
8214
8215
8216           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8217            <!-- end of entry -->
8218
8219
8220
8221       <!-- end of kind -->
8222       </tbody>
8223       <tr><td colspan="6" class="kind">dynamic</td></tr>
8224
8225       <thead class="entries_header">
8226         <tr>
8227           <th class="th_name">Property Name</th>
8228           <th class="th_type">Type</th>
8229           <th class="th_description">Description</th>
8230           <th class="th_units">Units</th>
8231           <th class="th_range">Range</th>
8232           <th class="th_tags">Tags</th>
8233         </tr>
8234       </thead>
8235
8236       <tbody>
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247           <tr class="entry" id="dynamic_android.edge.mode">
8248             <td class="entry_name
8249              " rowspan="3">
8250               android.<wbr/>edge.<wbr/>mode
8251             </td>
8252             <td class="entry_type">
8253                 <span class="entry_type_name entry_type_name_enum">byte</span>
8254
8255               <span class="entry_type_visibility"> [public]</span>
8256
8257
8258               <span class="entry_type_hwlevel">[full] </span>
8259
8260
8261
8262                 <ul class="entry_type_enum">
8263                   <li>
8264                     <span class="entry_type_enum_name">OFF</span>
8265                     <span class="entry_type_enum_notes"><p>No edge enhancement is applied.<wbr/></p></span>
8266                   </li>
8267                   <li>
8268                     <span class="entry_type_enum_name">FAST</span>
8269                     <span class="entry_type_enum_notes"><p>Apply edge enhancement at a quality level that does not slow down frame rate relative to sensor
8270 output</p></span>
8271                   </li>
8272                   <li>
8273                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
8274                     <span class="entry_type_enum_notes"><p>Apply high-quality edge enhancement,<wbr/> at a cost of reducing output frame rate.<wbr/></p></span>
8275                   </li>
8276                 </ul>
8277
8278             </td> <!-- entry_type -->
8279
8280             <td class="entry_description">
8281               <p>Operation mode for edge
8282 enhancement.<wbr/></p>
8283             </td>
8284
8285             <td class="entry_units">
8286             </td>
8287
8288             <td class="entry_range">
8289               <p><a href="#static_android.edge.availableEdgeModes">android.<wbr/>edge.<wbr/>available<wbr/>Edge<wbr/>Modes</a></p>
8290             </td>
8291
8292             <td class="entry_tags">
8293               <ul class="entry_tags">
8294                   <li><a href="#tag_V1">V1</a></li>
8295               </ul>
8296             </td>
8297
8298           </tr>
8299           <tr class="entries_header">
8300             <th class="th_details" colspan="5">Details</th>
8301           </tr>
8302           <tr class="entry_cont">
8303             <td class="entry_details" colspan="5">
8304               <p>Edge enhancement improves sharpness and details in the captured image.<wbr/> OFF means
8305 no enhancement will be applied by the camera device.<wbr/></p>
8306 <p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean camera device determined enhancement
8307 will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the
8308 camera device will use the highest-quality enhancement algorithms,<wbr/>
8309 even if it slows down capture rate.<wbr/> FAST means the camera device will
8310 not slow down capture rate when applying edge enhancement.<wbr/></p>
8311             </td>
8312           </tr>
8313
8314
8315           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8316            <!-- end of entry -->
8317
8318
8319
8320       <!-- end of kind -->
8321       </tbody>
8322
8323   <!-- end of section -->
8324   <tr><td colspan="6" id="section_flash" class="section">flash</td></tr>
8325
8326
8327       <tr><td colspan="6" class="kind">controls</td></tr>
8328
8329       <thead class="entries_header">
8330         <tr>
8331           <th class="th_name">Property Name</th>
8332           <th class="th_type">Type</th>
8333           <th class="th_description">Description</th>
8334           <th class="th_units">Units</th>
8335           <th class="th_range">Range</th>
8336           <th class="th_tags">Tags</th>
8337         </tr>
8338       </thead>
8339
8340       <tbody>
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351           <tr class="entry" id="controls_android.flash.firingPower">
8352             <td class="entry_name
8353              " rowspan="3">
8354               android.<wbr/>flash.<wbr/>firing<wbr/>Power
8355             </td>
8356             <td class="entry_type">
8357                 <span class="entry_type_name">byte</span>
8358
8359               <span class="entry_type_visibility"> [system]</span>
8360
8361
8362
8363
8364
8365
8366             </td> <!-- entry_type -->
8367
8368             <td class="entry_description">
8369               <p>Power for flash firing/<wbr/>torch</p>
8370             </td>
8371
8372             <td class="entry_units">
8373               10 is max power; 0 is no flash.<wbr/> Linear
8374             </td>
8375
8376             <td class="entry_range">
8377               <p>0 - 10</p>
8378             </td>
8379
8380             <td class="entry_tags">
8381               <ul class="entry_tags">
8382                   <li><a href="#tag_FUTURE">FUTURE</a></li>
8383               </ul>
8384             </td>
8385
8386           </tr>
8387           <tr class="entries_header">
8388             <th class="th_details" colspan="5">Details</th>
8389           </tr>
8390           <tr class="entry_cont">
8391             <td class="entry_details" colspan="5">
8392               <p>Power for snapshot may use a different scale than
8393 for torch mode.<wbr/> Only one entry for torch mode will be
8394 used</p>
8395             </td>
8396           </tr>
8397
8398
8399           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8400            <!-- end of entry -->
8401
8402
8403           <tr class="entry" id="controls_android.flash.firingTime">
8404             <td class="entry_name
8405              " rowspan="3">
8406               android.<wbr/>flash.<wbr/>firing<wbr/>Time
8407             </td>
8408             <td class="entry_type">
8409                 <span class="entry_type_name">int64</span>
8410
8411               <span class="entry_type_visibility"> [system]</span>
8412
8413
8414
8415
8416
8417
8418             </td> <!-- entry_type -->
8419
8420             <td class="entry_description">
8421               <p>Firing time of flash relative to start of
8422 exposure</p>
8423             </td>
8424
8425             <td class="entry_units">
8426               nanoseconds
8427             </td>
8428
8429             <td class="entry_range">
8430               <p>0-(exposure time-flash duration)</p>
8431             </td>
8432
8433             <td class="entry_tags">
8434               <ul class="entry_tags">
8435                   <li><a href="#tag_FUTURE">FUTURE</a></li>
8436               </ul>
8437             </td>
8438
8439           </tr>
8440           <tr class="entries_header">
8441             <th class="th_details" colspan="5">Details</th>
8442           </tr>
8443           <tr class="entry_cont">
8444             <td class="entry_details" colspan="5">
8445               <p>Clamped to (0,<wbr/> exposure time - flash
8446 duration).<wbr/></p>
8447             </td>
8448           </tr>
8449
8450
8451           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8452            <!-- end of entry -->
8453
8454
8455           <tr class="entry" id="controls_android.flash.mode">
8456             <td class="entry_name
8457              " rowspan="3">
8458               android.<wbr/>flash.<wbr/>mode
8459             </td>
8460             <td class="entry_type">
8461                 <span class="entry_type_name entry_type_name_enum">byte</span>
8462
8463               <span class="entry_type_visibility"> [public]</span>
8464
8465
8466               <span class="entry_type_hwlevel">[legacy] </span>
8467
8468
8469
8470                 <ul class="entry_type_enum">
8471                   <li>
8472                     <span class="entry_type_enum_name">OFF</span>
8473                     <span class="entry_type_enum_notes"><p>Do not fire the flash for this capture.<wbr/></p></span>
8474                   </li>
8475                   <li>
8476                     <span class="entry_type_enum_name">SINGLE</span>
8477                     <span class="entry_type_enum_notes"><p>If the flash is available and charged,<wbr/> fire flash
8478 for this capture.<wbr/></p></span>
8479                   </li>
8480                   <li>
8481                     <span class="entry_type_enum_name">TORCH</span>
8482                     <span class="entry_type_enum_notes"><p>Transition flash to continuously on.<wbr/></p></span>
8483                   </li>
8484                 </ul>
8485
8486             </td> <!-- entry_type -->
8487
8488             <td class="entry_description">
8489               <p>The desired mode for for the camera device's flash control.<wbr/></p>
8490             </td>
8491
8492             <td class="entry_units">
8493             </td>
8494
8495             <td class="entry_range">
8496             </td>
8497
8498             <td class="entry_tags">
8499               <ul class="entry_tags">
8500                   <li><a href="#tag_BC">BC</a></li>
8501               </ul>
8502             </td>
8503
8504           </tr>
8505           <tr class="entries_header">
8506             <th class="th_details" colspan="5">Details</th>
8507           </tr>
8508           <tr class="entry_cont">
8509             <td class="entry_details" colspan="5">
8510               <p>This control is only effective when flash unit is available
8511 (<code><a href="#static_android.flash.info.available">android.<wbr/>flash.<wbr/>info.<wbr/>available</a> == true</code>).<wbr/></p>
8512 <p>When this control is used,<wbr/> the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> must be set to ON or OFF.<wbr/>
8513 Otherwise,<wbr/> the camera device auto-exposure related flash control (ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/>
8514 ON_<wbr/>ALWAYS_<wbr/>FLASH,<wbr/> or ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE) will override this control.<wbr/></p>
8515 <p>When set to OFF,<wbr/> the camera device will not fire flash for this capture.<wbr/></p>
8516 <p>When set to SINGLE,<wbr/> the camera device will fire flash regardless of the camera
8517 device's auto-exposure routine's result.<wbr/> When used in still capture case,<wbr/> this
8518 control should be used along with auto-exposure (AE) precapture metering sequence
8519 (<a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>),<wbr/> otherwise,<wbr/> the image may be incorrectly exposed.<wbr/></p>
8520 <p>When set to TORCH,<wbr/> the flash will be on continuously.<wbr/> This mode can be used
8521 for use cases such as preview,<wbr/> auto-focus assist,<wbr/> still capture,<wbr/> or video recording.<wbr/></p>
8522 <p>The flash status will be reported by <a href="#dynamic_android.flash.state">android.<wbr/>flash.<wbr/>state</a> in the capture result metadata.<wbr/></p>
8523             </td>
8524           </tr>
8525
8526
8527           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8528            <!-- end of entry -->
8529
8530
8531
8532       <!-- end of kind -->
8533       </tbody>
8534       <tr><td colspan="6" class="kind">static</td></tr>
8535
8536       <thead class="entries_header">
8537         <tr>
8538           <th class="th_name">Property Name</th>
8539           <th class="th_type">Type</th>
8540           <th class="th_description">Description</th>
8541           <th class="th_units">Units</th>
8542           <th class="th_range">Range</th>
8543           <th class="th_tags">Tags</th>
8544         </tr>
8545       </thead>
8546
8547       <tbody>
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560           <tr class="entry" id="static_android.flash.info.available">
8561             <td class="entry_name
8562              " rowspan="3">
8563               android.<wbr/>flash.<wbr/>info.<wbr/>available
8564             </td>
8565             <td class="entry_type">
8566                 <span class="entry_type_name entry_type_name_enum">byte</span>
8567
8568               <span class="entry_type_visibility"> [public as boolean]</span>
8569
8570
8571               <span class="entry_type_hwlevel">[legacy] </span>
8572
8573
8574
8575                 <ul class="entry_type_enum">
8576                   <li>
8577                     <span class="entry_type_enum_name">FALSE</span>
8578                   </li>
8579                   <li>
8580                     <span class="entry_type_enum_name">TRUE</span>
8581                   </li>
8582                 </ul>
8583
8584             </td> <!-- entry_type -->
8585
8586             <td class="entry_description">
8587               <p>Whether this camera device has a
8588 flash unit.<wbr/></p>
8589             </td>
8590
8591             <td class="entry_units">
8592             </td>
8593
8594             <td class="entry_range">
8595             </td>
8596
8597             <td class="entry_tags">
8598               <ul class="entry_tags">
8599                   <li><a href="#tag_BC">BC</a></li>
8600               </ul>
8601             </td>
8602
8603           </tr>
8604           <tr class="entries_header">
8605             <th class="th_details" colspan="5">Details</th>
8606           </tr>
8607           <tr class="entry_cont">
8608             <td class="entry_details" colspan="5">
8609               <p>Will be <code>false</code> if no flash is available.<wbr/></p>
8610 <p>If there is no flash unit,<wbr/> none of the flash controls do
8611 anything.<wbr/></p>
8612             </td>
8613           </tr>
8614
8615
8616           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8617            <!-- end of entry -->
8618
8619
8620           <tr class="entry" id="static_android.flash.info.chargeDuration">
8621             <td class="entry_name
8622              " rowspan="3">
8623               android.<wbr/>flash.<wbr/>info.<wbr/>charge<wbr/>Duration
8624             </td>
8625             <td class="entry_type">
8626                 <span class="entry_type_name">int64</span>
8627
8628               <span class="entry_type_visibility"> [system]</span>
8629
8630
8631
8632
8633
8634
8635             </td> <!-- entry_type -->
8636
8637             <td class="entry_description">
8638               <p>Time taken before flash can fire
8639 again</p>
8640             </td>
8641
8642             <td class="entry_units">
8643               nanoseconds
8644             </td>
8645
8646             <td class="entry_range">
8647               <p>0-1e9</p>
8648             </td>
8649
8650             <td class="entry_tags">
8651               <ul class="entry_tags">
8652                   <li><a href="#tag_FUTURE">FUTURE</a></li>
8653               </ul>
8654             </td>
8655
8656           </tr>
8657           <tr class="entries_header">
8658             <th class="th_details" colspan="5">Details</th>
8659           </tr>
8660           <tr class="entry_cont">
8661             <td class="entry_details" colspan="5">
8662               <p>1 second too long/<wbr/>too short for recharge? Should
8663 this be power-dependent?</p>
8664             </td>
8665           </tr>
8666
8667
8668           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8669            <!-- end of entry -->
8670
8671
8672
8673
8674
8675           <tr class="entry" id="static_android.flash.colorTemperature">
8676             <td class="entry_name
8677              " rowspan="1">
8678               android.<wbr/>flash.<wbr/>color<wbr/>Temperature
8679             </td>
8680             <td class="entry_type">
8681                 <span class="entry_type_name">byte</span>
8682
8683               <span class="entry_type_visibility"> [system]</span>
8684
8685
8686
8687
8688
8689
8690             </td> <!-- entry_type -->
8691
8692             <td class="entry_description">
8693               <p>The x,<wbr/>y whitepoint of the
8694 flash</p>
8695             </td>
8696
8697             <td class="entry_units">
8698               pair of floats
8699             </td>
8700
8701             <td class="entry_range">
8702               <p>0-1 for both</p>
8703             </td>
8704
8705             <td class="entry_tags">
8706               <ul class="entry_tags">
8707                   <li><a href="#tag_FUTURE">FUTURE</a></li>
8708               </ul>
8709             </td>
8710
8711           </tr>
8712
8713
8714           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8715            <!-- end of entry -->
8716
8717
8718           <tr class="entry" id="static_android.flash.maxEnergy">
8719             <td class="entry_name
8720              " rowspan="1">
8721               android.<wbr/>flash.<wbr/>max<wbr/>Energy
8722             </td>
8723             <td class="entry_type">
8724                 <span class="entry_type_name">byte</span>
8725
8726               <span class="entry_type_visibility"> [system]</span>
8727
8728
8729
8730
8731
8732
8733             </td> <!-- entry_type -->
8734
8735             <td class="entry_description">
8736               <p>Max energy output of the flash for a full
8737 power single flash</p>
8738             </td>
8739
8740             <td class="entry_units">
8741               lumen-seconds
8742             </td>
8743
8744             <td class="entry_range">
8745               <p>&gt;= 0</p>
8746             </td>
8747
8748             <td class="entry_tags">
8749               <ul class="entry_tags">
8750                   <li><a href="#tag_FUTURE">FUTURE</a></li>
8751               </ul>
8752             </td>
8753
8754           </tr>
8755
8756
8757           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8758            <!-- end of entry -->
8759
8760
8761
8762       <!-- end of kind -->
8763       </tbody>
8764       <tr><td colspan="6" class="kind">dynamic</td></tr>
8765
8766       <thead class="entries_header">
8767         <tr>
8768           <th class="th_name">Property Name</th>
8769           <th class="th_type">Type</th>
8770           <th class="th_description">Description</th>
8771           <th class="th_units">Units</th>
8772           <th class="th_range">Range</th>
8773           <th class="th_tags">Tags</th>
8774         </tr>
8775       </thead>
8776
8777       <tbody>
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788           <tr class="entry" id="dynamic_android.flash.firingPower">
8789             <td class="entry_name
8790              " rowspan="3">
8791               android.<wbr/>flash.<wbr/>firing<wbr/>Power
8792             </td>
8793             <td class="entry_type">
8794                 <span class="entry_type_name">byte</span>
8795
8796               <span class="entry_type_visibility"> [system]</span>
8797
8798
8799
8800
8801
8802
8803             </td> <!-- entry_type -->
8804
8805             <td class="entry_description">
8806               <p>Power for flash firing/<wbr/>torch</p>
8807             </td>
8808
8809             <td class="entry_units">
8810               10 is max power; 0 is no flash.<wbr/> Linear
8811             </td>
8812
8813             <td class="entry_range">
8814               <p>0 - 10</p>
8815             </td>
8816
8817             <td class="entry_tags">
8818               <ul class="entry_tags">
8819                   <li><a href="#tag_FUTURE">FUTURE</a></li>
8820               </ul>
8821             </td>
8822
8823           </tr>
8824           <tr class="entries_header">
8825             <th class="th_details" colspan="5">Details</th>
8826           </tr>
8827           <tr class="entry_cont">
8828             <td class="entry_details" colspan="5">
8829               <p>Power for snapshot may use a different scale than
8830 for torch mode.<wbr/> Only one entry for torch mode will be
8831 used</p>
8832             </td>
8833           </tr>
8834
8835
8836           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8837            <!-- end of entry -->
8838
8839
8840           <tr class="entry" id="dynamic_android.flash.firingTime">
8841             <td class="entry_name
8842              " rowspan="3">
8843               android.<wbr/>flash.<wbr/>firing<wbr/>Time
8844             </td>
8845             <td class="entry_type">
8846                 <span class="entry_type_name">int64</span>
8847
8848               <span class="entry_type_visibility"> [system]</span>
8849
8850
8851
8852
8853
8854
8855             </td> <!-- entry_type -->
8856
8857             <td class="entry_description">
8858               <p>Firing time of flash relative to start of
8859 exposure</p>
8860             </td>
8861
8862             <td class="entry_units">
8863               nanoseconds
8864             </td>
8865
8866             <td class="entry_range">
8867               <p>0-(exposure time-flash duration)</p>
8868             </td>
8869
8870             <td class="entry_tags">
8871               <ul class="entry_tags">
8872                   <li><a href="#tag_FUTURE">FUTURE</a></li>
8873               </ul>
8874             </td>
8875
8876           </tr>
8877           <tr class="entries_header">
8878             <th class="th_details" colspan="5">Details</th>
8879           </tr>
8880           <tr class="entry_cont">
8881             <td class="entry_details" colspan="5">
8882               <p>Clamped to (0,<wbr/> exposure time - flash
8883 duration).<wbr/></p>
8884             </td>
8885           </tr>
8886
8887
8888           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8889            <!-- end of entry -->
8890
8891
8892           <tr class="entry" id="dynamic_android.flash.mode">
8893             <td class="entry_name
8894              " rowspan="3">
8895               android.<wbr/>flash.<wbr/>mode
8896             </td>
8897             <td class="entry_type">
8898                 <span class="entry_type_name entry_type_name_enum">byte</span>
8899
8900               <span class="entry_type_visibility"> [public]</span>
8901
8902
8903               <span class="entry_type_hwlevel">[legacy] </span>
8904
8905
8906
8907                 <ul class="entry_type_enum">
8908                   <li>
8909                     <span class="entry_type_enum_name">OFF</span>
8910                     <span class="entry_type_enum_notes"><p>Do not fire the flash for this capture.<wbr/></p></span>
8911                   </li>
8912                   <li>
8913                     <span class="entry_type_enum_name">SINGLE</span>
8914                     <span class="entry_type_enum_notes"><p>If the flash is available and charged,<wbr/> fire flash
8915 for this capture.<wbr/></p></span>
8916                   </li>
8917                   <li>
8918                     <span class="entry_type_enum_name">TORCH</span>
8919                     <span class="entry_type_enum_notes"><p>Transition flash to continuously on.<wbr/></p></span>
8920                   </li>
8921                 </ul>
8922
8923             </td> <!-- entry_type -->
8924
8925             <td class="entry_description">
8926               <p>The desired mode for for the camera device's flash control.<wbr/></p>
8927             </td>
8928
8929             <td class="entry_units">
8930             </td>
8931
8932             <td class="entry_range">
8933             </td>
8934
8935             <td class="entry_tags">
8936               <ul class="entry_tags">
8937                   <li><a href="#tag_BC">BC</a></li>
8938               </ul>
8939             </td>
8940
8941           </tr>
8942           <tr class="entries_header">
8943             <th class="th_details" colspan="5">Details</th>
8944           </tr>
8945           <tr class="entry_cont">
8946             <td class="entry_details" colspan="5">
8947               <p>This control is only effective when flash unit is available
8948 (<code><a href="#static_android.flash.info.available">android.<wbr/>flash.<wbr/>info.<wbr/>available</a> == true</code>).<wbr/></p>
8949 <p>When this control is used,<wbr/> the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> must be set to ON or OFF.<wbr/>
8950 Otherwise,<wbr/> the camera device auto-exposure related flash control (ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/>
8951 ON_<wbr/>ALWAYS_<wbr/>FLASH,<wbr/> or ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE) will override this control.<wbr/></p>
8952 <p>When set to OFF,<wbr/> the camera device will not fire flash for this capture.<wbr/></p>
8953 <p>When set to SINGLE,<wbr/> the camera device will fire flash regardless of the camera
8954 device's auto-exposure routine's result.<wbr/> When used in still capture case,<wbr/> this
8955 control should be used along with auto-exposure (AE) precapture metering sequence
8956 (<a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>),<wbr/> otherwise,<wbr/> the image may be incorrectly exposed.<wbr/></p>
8957 <p>When set to TORCH,<wbr/> the flash will be on continuously.<wbr/> This mode can be used
8958 for use cases such as preview,<wbr/> auto-focus assist,<wbr/> still capture,<wbr/> or video recording.<wbr/></p>
8959 <p>The flash status will be reported by <a href="#dynamic_android.flash.state">android.<wbr/>flash.<wbr/>state</a> in the capture result metadata.<wbr/></p>
8960             </td>
8961           </tr>
8962
8963
8964           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8965            <!-- end of entry -->
8966
8967
8968           <tr class="entry" id="dynamic_android.flash.state">
8969             <td class="entry_name
8970              " rowspan="3">
8971               android.<wbr/>flash.<wbr/>state
8972             </td>
8973             <td class="entry_type">
8974                 <span class="entry_type_name entry_type_name_enum">byte</span>
8975
8976               <span class="entry_type_visibility"> [public]</span>
8977
8978
8979               <span class="entry_type_hwlevel">[limited] </span>
8980
8981
8982
8983                 <ul class="entry_type_enum">
8984                   <li>
8985                     <span class="entry_type_enum_name">UNAVAILABLE</span>
8986                     <span class="entry_type_enum_notes"><p>No flash on camera.<wbr/></p></span>
8987                   </li>
8988                   <li>
8989                     <span class="entry_type_enum_name">CHARGING</span>
8990                     <span class="entry_type_enum_notes"><p>Flash is charging and cannot be fired.<wbr/></p></span>
8991                   </li>
8992                   <li>
8993                     <span class="entry_type_enum_name">READY</span>
8994                     <span class="entry_type_enum_notes"><p>Flash is ready to fire.<wbr/></p></span>
8995                   </li>
8996                   <li>
8997                     <span class="entry_type_enum_name">FIRED</span>
8998                     <span class="entry_type_enum_notes"><p>Flash fired for this capture.<wbr/></p></span>
8999                   </li>
9000                   <li>
9001                     <span class="entry_type_enum_name">PARTIAL</span>
9002                     <span class="entry_type_enum_notes"><p>Flash partially illuminated this frame.<wbr/></p>
9003 <p>This is usually due to the next or previous frame having
9004 the flash fire,<wbr/> and the flash spilling into this capture
9005 due to hardware limitations.<wbr/></p></span>
9006                   </li>
9007                 </ul>
9008
9009             </td> <!-- entry_type -->
9010
9011             <td class="entry_description">
9012               <p>Current state of the flash
9013 unit.<wbr/></p>
9014             </td>
9015
9016             <td class="entry_units">
9017             </td>
9018
9019             <td class="entry_range">
9020             </td>
9021
9022             <td class="entry_tags">
9023             </td>
9024
9025           </tr>
9026           <tr class="entries_header">
9027             <th class="th_details" colspan="5">Details</th>
9028           </tr>
9029           <tr class="entry_cont">
9030             <td class="entry_details" colspan="5">
9031               <p>When the camera device doesn't have flash unit
9032 (i.<wbr/>e.<wbr/> <code><a href="#static_android.flash.info.available">android.<wbr/>flash.<wbr/>info.<wbr/>available</a> == false</code>),<wbr/> this state will always be UNAVAILABLE.<wbr/>
9033 Other states indicate the current flash status.<wbr/></p>
9034 <p>In certain conditions,<wbr/> this will be available on LEGACY devices:</p>
9035 <ul>
9036 <li>Flash-less cameras always return UNAVAILABLE.<wbr/></li>
9037 <li>Using <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>==</code> ON_<wbr/>ALWAYS_<wbr/>FLASH
9038    will always return FIRED.<wbr/></li>
9039 <li>Using <a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> <code>==</code> TORCH
9040    will always return FIRED.<wbr/></li>
9041 </ul>
9042 <p>In all other conditions the state will not be available on
9043 LEGACY devices (i.<wbr/>e.<wbr/> it will be <code>null</code>).<wbr/></p>
9044             </td>
9045           </tr>
9046
9047
9048           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9049            <!-- end of entry -->
9050
9051
9052
9053       <!-- end of kind -->
9054       </tbody>
9055
9056   <!-- end of section -->
9057   <tr><td colspan="6" id="section_hotPixel" class="section">hotPixel</td></tr>
9058
9059
9060       <tr><td colspan="6" class="kind">controls</td></tr>
9061
9062       <thead class="entries_header">
9063         <tr>
9064           <th class="th_name">Property Name</th>
9065           <th class="th_type">Type</th>
9066           <th class="th_description">Description</th>
9067           <th class="th_units">Units</th>
9068           <th class="th_range">Range</th>
9069           <th class="th_tags">Tags</th>
9070         </tr>
9071       </thead>
9072
9073       <tbody>
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084           <tr class="entry" id="controls_android.hotPixel.mode">
9085             <td class="entry_name
9086              " rowspan="3">
9087               android.<wbr/>hot<wbr/>Pixel.<wbr/>mode
9088             </td>
9089             <td class="entry_type">
9090                 <span class="entry_type_name entry_type_name_enum">byte</span>
9091
9092               <span class="entry_type_visibility"> [public]</span>
9093
9094
9095
9096
9097
9098                 <ul class="entry_type_enum">
9099                   <li>
9100                     <span class="entry_type_enum_name">OFF</span>
9101                     <span class="entry_type_enum_notes"><p>No hot pixel correction is applied.<wbr/></p>
9102 <p>The frame rate must not be reduced relative to sensor raw output
9103 for this option.<wbr/></p>
9104 <p>The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/></p></span>
9105                   </li>
9106                   <li>
9107                     <span class="entry_type_enum_name">FAST</span>
9108                     <span class="entry_type_enum_notes"><p>Hot pixel correction is applied,<wbr/> without reducing frame
9109 rate relative to sensor raw output.<wbr/></p>
9110 <p>The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/></p></span>
9111                   </li>
9112                   <li>
9113                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
9114                     <span class="entry_type_enum_notes"><p>High-quality hot pixel correction is applied,<wbr/> at a cost
9115 of reducing frame rate relative to sensor raw output.<wbr/></p>
9116 <p>The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/></p></span>
9117                   </li>
9118                 </ul>
9119
9120             </td> <!-- entry_type -->
9121
9122             <td class="entry_description">
9123               <p>Operational mode for hot pixel correction.<wbr/></p>
9124             </td>
9125
9126             <td class="entry_units">
9127             </td>
9128
9129             <td class="entry_range">
9130               <p><a href="#static_android.hotPixel.availableHotPixelModes">android.<wbr/>hot<wbr/>Pixel.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Modes</a></p>
9131             </td>
9132
9133             <td class="entry_tags">
9134               <ul class="entry_tags">
9135                   <li><a href="#tag_V1">V1</a></li>
9136                   <li><a href="#tag_RAW">RAW</a></li>
9137               </ul>
9138             </td>
9139
9140           </tr>
9141           <tr class="entries_header">
9142             <th class="th_details" colspan="5">Details</th>
9143           </tr>
9144           <tr class="entry_cont">
9145             <td class="entry_details" colspan="5">
9146               <p>Hotpixel correction interpolates out,<wbr/> or otherwise removes,<wbr/> pixels
9147 that do not accurately measure the incoming light (i.<wbr/>e.<wbr/> pixels that
9148 are stuck at an arbitrary value or are oversensitive).<wbr/></p>
9149             </td>
9150           </tr>
9151
9152
9153           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9154            <!-- end of entry -->
9155
9156
9157
9158       <!-- end of kind -->
9159       </tbody>
9160       <tr><td colspan="6" class="kind">static</td></tr>
9161
9162       <thead class="entries_header">
9163         <tr>
9164           <th class="th_name">Property Name</th>
9165           <th class="th_type">Type</th>
9166           <th class="th_description">Description</th>
9167           <th class="th_units">Units</th>
9168           <th class="th_range">Range</th>
9169           <th class="th_tags">Tags</th>
9170         </tr>
9171       </thead>
9172
9173       <tbody>
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184           <tr class="entry" id="static_android.hotPixel.availableHotPixelModes">
9185             <td class="entry_name
9186              " rowspan="5">
9187               android.<wbr/>hot<wbr/>Pixel.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Modes
9188             </td>
9189             <td class="entry_type">
9190                 <span class="entry_type_name">byte</span>
9191                 <span class="entry_type_container">x</span>
9192
9193                 <span class="entry_type_array">
9194                   n
9195                 </span>
9196               <span class="entry_type_visibility"> [public as enumList]</span>
9197
9198
9199
9200
9201                 <div class="entry_type_notes">list of enums</div>
9202
9203
9204             </td> <!-- entry_type -->
9205
9206             <td class="entry_description">
9207               <p>List of hot pixel correction modes for <a href="#controls_android.hotPixel.mode">android.<wbr/>hot<wbr/>Pixel.<wbr/>mode</a> that are supported by this
9208 camera device.<wbr/></p>
9209             </td>
9210
9211             <td class="entry_units">
9212             </td>
9213
9214             <td class="entry_range">
9215               <p>Any value listed in <a href="#controls_android.hotPixel.mode">android.<wbr/>hot<wbr/>Pixel.<wbr/>mode</a></p>
9216             </td>
9217
9218             <td class="entry_tags">
9219               <ul class="entry_tags">
9220                   <li><a href="#tag_V1">V1</a></li>
9221                   <li><a href="#tag_RAW">RAW</a></li>
9222               </ul>
9223             </td>
9224
9225           </tr>
9226           <tr class="entries_header">
9227             <th class="th_details" colspan="5">Details</th>
9228           </tr>
9229           <tr class="entry_cont">
9230             <td class="entry_details" colspan="5">
9231               <p>FULL mode camera devices will always support FAST.<wbr/></p>
9232             </td>
9233           </tr>
9234
9235           <tr class="entries_header">
9236             <th class="th_details" colspan="5">HAL Implementation Details</th>
9237           </tr>
9238           <tr class="entry_cont">
9239             <td class="entry_details" colspan="5">
9240               <p>To avoid performance issues,<wbr/> there will be significantly fewer hot
9241 pixels than actual pixels on the camera sensor.<wbr/></p>
9242             </td>
9243           </tr>
9244
9245           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9246            <!-- end of entry -->
9247
9248
9249
9250       <!-- end of kind -->
9251       </tbody>
9252       <tr><td colspan="6" class="kind">dynamic</td></tr>
9253
9254       <thead class="entries_header">
9255         <tr>
9256           <th class="th_name">Property Name</th>
9257           <th class="th_type">Type</th>
9258           <th class="th_description">Description</th>
9259           <th class="th_units">Units</th>
9260           <th class="th_range">Range</th>
9261           <th class="th_tags">Tags</th>
9262         </tr>
9263       </thead>
9264
9265       <tbody>
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276           <tr class="entry" id="dynamic_android.hotPixel.mode">
9277             <td class="entry_name
9278              " rowspan="3">
9279               android.<wbr/>hot<wbr/>Pixel.<wbr/>mode
9280             </td>
9281             <td class="entry_type">
9282                 <span class="entry_type_name entry_type_name_enum">byte</span>
9283
9284               <span class="entry_type_visibility"> [public]</span>
9285
9286
9287
9288
9289
9290                 <ul class="entry_type_enum">
9291                   <li>
9292                     <span class="entry_type_enum_name">OFF</span>
9293                     <span class="entry_type_enum_notes"><p>No hot pixel correction is applied.<wbr/></p>
9294 <p>The frame rate must not be reduced relative to sensor raw output
9295 for this option.<wbr/></p>
9296 <p>The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/></p></span>
9297                   </li>
9298                   <li>
9299                     <span class="entry_type_enum_name">FAST</span>
9300                     <span class="entry_type_enum_notes"><p>Hot pixel correction is applied,<wbr/> without reducing frame
9301 rate relative to sensor raw output.<wbr/></p>
9302 <p>The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/></p></span>
9303                   </li>
9304                   <li>
9305                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
9306                     <span class="entry_type_enum_notes"><p>High-quality hot pixel correction is applied,<wbr/> at a cost
9307 of reducing frame rate relative to sensor raw output.<wbr/></p>
9308 <p>The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/></p></span>
9309                   </li>
9310                 </ul>
9311
9312             </td> <!-- entry_type -->
9313
9314             <td class="entry_description">
9315               <p>Operational mode for hot pixel correction.<wbr/></p>
9316             </td>
9317
9318             <td class="entry_units">
9319             </td>
9320
9321             <td class="entry_range">
9322               <p><a href="#static_android.hotPixel.availableHotPixelModes">android.<wbr/>hot<wbr/>Pixel.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Modes</a></p>
9323             </td>
9324
9325             <td class="entry_tags">
9326               <ul class="entry_tags">
9327                   <li><a href="#tag_V1">V1</a></li>
9328                   <li><a href="#tag_RAW">RAW</a></li>
9329               </ul>
9330             </td>
9331
9332           </tr>
9333           <tr class="entries_header">
9334             <th class="th_details" colspan="5">Details</th>
9335           </tr>
9336           <tr class="entry_cont">
9337             <td class="entry_details" colspan="5">
9338               <p>Hotpixel correction interpolates out,<wbr/> or otherwise removes,<wbr/> pixels
9339 that do not accurately measure the incoming light (i.<wbr/>e.<wbr/> pixels that
9340 are stuck at an arbitrary value or are oversensitive).<wbr/></p>
9341             </td>
9342           </tr>
9343
9344
9345           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9346            <!-- end of entry -->
9347
9348
9349
9350       <!-- end of kind -->
9351       </tbody>
9352
9353   <!-- end of section -->
9354   <tr><td colspan="6" id="section_jpeg" class="section">jpeg</td></tr>
9355
9356
9357       <tr><td colspan="6" class="kind">controls</td></tr>
9358
9359       <thead class="entries_header">
9360         <tr>
9361           <th class="th_name">Property Name</th>
9362           <th class="th_type">Type</th>
9363           <th class="th_description">Description</th>
9364           <th class="th_units">Units</th>
9365           <th class="th_range">Range</th>
9366           <th class="th_tags">Tags</th>
9367         </tr>
9368       </thead>
9369
9370       <tbody>
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381           <tr class="entry" id="controls_android.jpeg.gpsLocation">
9382             <td class="entry_name
9383              " rowspan="3">
9384               android.<wbr/>jpeg.<wbr/>gps<wbr/>Location
9385             </td>
9386             <td class="entry_type">
9387                 <span class="entry_type_name">byte</span>
9388
9389               <span class="entry_type_visibility"> [public as location]</span>
9390
9391               <span class="entry_type_synthetic">[synthetic] </span>
9392
9393               <span class="entry_type_hwlevel">[legacy] </span>
9394
9395
9396
9397
9398             </td> <!-- entry_type -->
9399
9400             <td class="entry_description">
9401               <p>A location object to use when generating image GPS metadata.<wbr/></p>
9402             </td>
9403
9404             <td class="entry_units">
9405             </td>
9406
9407             <td class="entry_range">
9408             </td>
9409
9410             <td class="entry_tags">
9411             </td>
9412
9413           </tr>
9414           <tr class="entries_header">
9415             <th class="th_details" colspan="5">Details</th>
9416           </tr>
9417           <tr class="entry_cont">
9418             <td class="entry_details" colspan="5">
9419               <p>Setting a location object in a request will include the GPS coordinates of the location
9420 into any JPEG images captured based on the request.<wbr/> These coordinates can then be
9421 viewed by anyone who receives the JPEG image.<wbr/></p>
9422             </td>
9423           </tr>
9424
9425
9426           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9427            <!-- end of entry -->
9428
9429
9430           <tr class="entry" id="controls_android.jpeg.gpsCoordinates">
9431             <td class="entry_name
9432              " rowspan="1">
9433               android.<wbr/>jpeg.<wbr/>gps<wbr/>Coordinates
9434             </td>
9435             <td class="entry_type">
9436                 <span class="entry_type_name">double</span>
9437                 <span class="entry_type_container">x</span>
9438
9439                 <span class="entry_type_array">
9440                   3
9441                 </span>
9442               <span class="entry_type_visibility"> [hidden]</span>
9443
9444
9445               <span class="entry_type_hwlevel">[legacy] </span>
9446
9447
9448                 <div class="entry_type_notes">latitude,<wbr/> longitude,<wbr/> altitude.<wbr/> First two in degrees,<wbr/> the third in meters</div>
9449
9450
9451             </td> <!-- entry_type -->
9452
9453             <td class="entry_description">
9454               <p>GPS coordinates to include in output JPEG
9455 EXIF.<wbr/></p>
9456             </td>
9457
9458             <td class="entry_units">
9459             </td>
9460
9461             <td class="entry_range">
9462               <p>(-180 - 180],<wbr/> [-90,<wbr/>90],<wbr/> [-inf,<wbr/> inf]</p>
9463             </td>
9464
9465             <td class="entry_tags">
9466               <ul class="entry_tags">
9467                   <li><a href="#tag_BC">BC</a></li>
9468               </ul>
9469             </td>
9470
9471           </tr>
9472
9473
9474           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9475            <!-- end of entry -->
9476
9477
9478           <tr class="entry" id="controls_android.jpeg.gpsProcessingMethod">
9479             <td class="entry_name
9480              " rowspan="1">
9481               android.<wbr/>jpeg.<wbr/>gps<wbr/>Processing<wbr/>Method
9482             </td>
9483             <td class="entry_type">
9484                 <span class="entry_type_name">byte</span>
9485
9486               <span class="entry_type_visibility"> [hidden as string]</span>
9487
9488
9489               <span class="entry_type_hwlevel">[legacy] </span>
9490
9491
9492
9493
9494             </td> <!-- entry_type -->
9495
9496             <td class="entry_description">
9497               <p>32 characters describing GPS algorithm to
9498 include in EXIF.<wbr/></p>
9499             </td>
9500
9501             <td class="entry_units">
9502               UTF-8 null-terminated string
9503             </td>
9504
9505             <td class="entry_range">
9506             </td>
9507
9508             <td class="entry_tags">
9509               <ul class="entry_tags">
9510                   <li><a href="#tag_BC">BC</a></li>
9511               </ul>
9512             </td>
9513
9514           </tr>
9515
9516
9517           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9518            <!-- end of entry -->
9519
9520
9521           <tr class="entry" id="controls_android.jpeg.gpsTimestamp">
9522             <td class="entry_name
9523              " rowspan="1">
9524               android.<wbr/>jpeg.<wbr/>gps<wbr/>Timestamp
9525             </td>
9526             <td class="entry_type">
9527                 <span class="entry_type_name">int64</span>
9528
9529               <span class="entry_type_visibility"> [hidden]</span>
9530
9531
9532               <span class="entry_type_hwlevel">[legacy] </span>
9533
9534
9535
9536
9537             </td> <!-- entry_type -->
9538
9539             <td class="entry_description">
9540               <p>Time GPS fix was made to include in
9541 EXIF.<wbr/></p>
9542             </td>
9543
9544             <td class="entry_units">
9545               UTC in seconds since January 1,<wbr/> 1970
9546             </td>
9547
9548             <td class="entry_range">
9549             </td>
9550
9551             <td class="entry_tags">
9552               <ul class="entry_tags">
9553                   <li><a href="#tag_BC">BC</a></li>
9554               </ul>
9555             </td>
9556
9557           </tr>
9558
9559
9560           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9561            <!-- end of entry -->
9562
9563
9564           <tr class="entry" id="controls_android.jpeg.orientation">
9565             <td class="entry_name
9566              " rowspan="3">
9567               android.<wbr/>jpeg.<wbr/>orientation
9568             </td>
9569             <td class="entry_type">
9570                 <span class="entry_type_name">int32</span>
9571
9572               <span class="entry_type_visibility"> [public]</span>
9573
9574
9575               <span class="entry_type_hwlevel">[legacy] </span>
9576
9577
9578
9579
9580             </td> <!-- entry_type -->
9581
9582             <td class="entry_description">
9583               <p>The orientation for a JPEG image.<wbr/></p>
9584             </td>
9585
9586             <td class="entry_units">
9587               Degrees in multiples of 90
9588             </td>
9589
9590             <td class="entry_range">
9591               <p>0,<wbr/> 90,<wbr/> 180,<wbr/> 270</p>
9592             </td>
9593
9594             <td class="entry_tags">
9595               <ul class="entry_tags">
9596                   <li><a href="#tag_BC">BC</a></li>
9597               </ul>
9598             </td>
9599
9600           </tr>
9601           <tr class="entries_header">
9602             <th class="th_details" colspan="5">Details</th>
9603           </tr>
9604           <tr class="entry_cont">
9605             <td class="entry_details" colspan="5">
9606               <p>The clockwise rotation angle in degrees,<wbr/> relative to the orientation
9607 to the camera,<wbr/> that the JPEG picture needs to be rotated by,<wbr/> to be viewed
9608 upright.<wbr/></p>
9609 <p>Camera devices may either encode this value into the JPEG EXIF header,<wbr/> or
9610 rotate the image data to match this orientation.<wbr/></p>
9611 <p>Note that this orientation is relative to the orientation of the camera sensor,<wbr/> given
9612 by <a href="#static_android.sensor.orientation">android.<wbr/>sensor.<wbr/>orientation</a>.<wbr/></p>
9613 <p>To translate from the device orientation given by the Android sensor APIs,<wbr/> the following
9614 sample code may be used:</p>
9615 <pre><code>private int getJpegOrientation(CameraCharacteristics c,<wbr/> int deviceOrientation) {
9616     if (deviceOrientation == android.<wbr/>view.<wbr/>Orientation<wbr/>Event<wbr/>Listener.<wbr/>ORIENTATION_<wbr/>UNKNOWN) return 0;
9617     int sensorOrientation = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>SENSOR_<wbr/>ORIENTATION);
9618
9619     //<wbr/> Round device orientation to a multiple of 90
9620     deviceOrientation = (deviceOrientation + 45) /<wbr/> 90 * 90;
9621
9622     //<wbr/> Reverse device orientation for front-facing cameras
9623     boolean facingFront = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>LENS_<wbr/>FACING) == Camera<wbr/>Characteristics.<wbr/>LENS_<wbr/>FACING_<wbr/>FRONT;
9624     if (facingFront) deviceOrientation = -deviceOrientation;
9625
9626     //<wbr/> Calculate desired JPEG orientation relative to camera orientation to make
9627     //<wbr/> the image upright relative to the device orientation
9628     int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360;
9629
9630     return jpegOrientation;
9631 }
9632 </code></pre>
9633             </td>
9634           </tr>
9635
9636
9637           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9638            <!-- end of entry -->
9639
9640
9641           <tr class="entry" id="controls_android.jpeg.quality">
9642             <td class="entry_name
9643              " rowspan="3">
9644               android.<wbr/>jpeg.<wbr/>quality
9645             </td>
9646             <td class="entry_type">
9647                 <span class="entry_type_name">byte</span>
9648
9649               <span class="entry_type_visibility"> [public]</span>
9650
9651
9652               <span class="entry_type_hwlevel">[legacy] </span>
9653
9654
9655
9656
9657             </td> <!-- entry_type -->
9658
9659             <td class="entry_description">
9660               <p>Compression quality of the final JPEG
9661 image.<wbr/></p>
9662             </td>
9663
9664             <td class="entry_units">
9665             </td>
9666
9667             <td class="entry_range">
9668               <p>1-100; larger is higher quality</p>
9669             </td>
9670
9671             <td class="entry_tags">
9672               <ul class="entry_tags">
9673                   <li><a href="#tag_BC">BC</a></li>
9674               </ul>
9675             </td>
9676
9677           </tr>
9678           <tr class="entries_header">
9679             <th class="th_details" colspan="5">Details</th>
9680           </tr>
9681           <tr class="entry_cont">
9682             <td class="entry_details" colspan="5">
9683               <p>85-95 is typical usage range.<wbr/></p>
9684             </td>
9685           </tr>
9686
9687
9688           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9689            <!-- end of entry -->
9690
9691
9692           <tr class="entry" id="controls_android.jpeg.thumbnailQuality">
9693             <td class="entry_name
9694              " rowspan="1">
9695               android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Quality
9696             </td>
9697             <td class="entry_type">
9698                 <span class="entry_type_name">byte</span>
9699
9700               <span class="entry_type_visibility"> [public]</span>
9701
9702
9703               <span class="entry_type_hwlevel">[legacy] </span>
9704
9705
9706
9707
9708             </td> <!-- entry_type -->
9709
9710             <td class="entry_description">
9711               <p>Compression quality of JPEG
9712 thumbnail.<wbr/></p>
9713             </td>
9714
9715             <td class="entry_units">
9716             </td>
9717
9718             <td class="entry_range">
9719               <p>1-100; larger is higher quality</p>
9720             </td>
9721
9722             <td class="entry_tags">
9723               <ul class="entry_tags">
9724                   <li><a href="#tag_BC">BC</a></li>
9725               </ul>
9726             </td>
9727
9728           </tr>
9729
9730
9731           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9732            <!-- end of entry -->
9733
9734
9735           <tr class="entry" id="controls_android.jpeg.thumbnailSize">
9736             <td class="entry_name
9737              " rowspan="5">
9738               android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Size
9739             </td>
9740             <td class="entry_type">
9741                 <span class="entry_type_name">int32</span>
9742                 <span class="entry_type_container">x</span>
9743
9744                 <span class="entry_type_array">
9745                   2
9746                 </span>
9747               <span class="entry_type_visibility"> [public as size]</span>
9748
9749
9750               <span class="entry_type_hwlevel">[legacy] </span>
9751
9752
9753
9754
9755             </td> <!-- entry_type -->
9756
9757             <td class="entry_description">
9758               <p>Resolution of embedded JPEG thumbnail.<wbr/></p>
9759             </td>
9760
9761             <td class="entry_units">
9762             </td>
9763
9764             <td class="entry_range">
9765               <p><a href="#static_android.jpeg.availableThumbnailSizes">android.<wbr/>jpeg.<wbr/>available<wbr/>Thumbnail<wbr/>Sizes</a></p>
9766             </td>
9767
9768             <td class="entry_tags">
9769               <ul class="entry_tags">
9770                   <li><a href="#tag_BC">BC</a></li>
9771               </ul>
9772             </td>
9773
9774           </tr>
9775           <tr class="entries_header">
9776             <th class="th_details" colspan="5">Details</th>
9777           </tr>
9778           <tr class="entry_cont">
9779             <td class="entry_details" colspan="5">
9780               <p>When set to (0,<wbr/> 0) value,<wbr/> the JPEG EXIF will not contain thumbnail,<wbr/>
9781 but the captured JPEG will still be a valid image.<wbr/></p>
9782 <p>For best results,<wbr/> when issuing a request for a JPEG image,<wbr/> the thumbnail size selected
9783 should have the same aspect ratio as the main JPEG output.<wbr/></p>
9784 <p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect
9785 ratio,<wbr/> the camera device creates the thumbnail by cropping it from the primary image.<wbr/>
9786 For example,<wbr/> if the primary image has 4:3 aspect ratio,<wbr/> the thumbnail image has
9787 16:9 aspect ratio,<wbr/> the primary image will be cropped vertically (letterbox) to
9788 generate the thumbnail image.<wbr/> The thumbnail image will always have a smaller Field
9789 Of View (FOV) than the primary image when aspect ratios differ.<wbr/></p>
9790             </td>
9791           </tr>
9792
9793           <tr class="entries_header">
9794             <th class="th_details" colspan="5">HAL Implementation Details</th>
9795           </tr>
9796           <tr class="entry_cont">
9797             <td class="entry_details" colspan="5">
9798               <p>The HAL must not squeeze or stretch the downscaled primary image to generate thumbnail.<wbr/>
9799 The cropping must be done on the primary jpeg image rather than the sensor active array.<wbr/>
9800 The stream cropping rule specified by "S5.<wbr/> Cropping" in camera3.<wbr/>h doesn't apply to the
9801 thumbnail image cropping.<wbr/></p>
9802             </td>
9803           </tr>
9804
9805           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9806            <!-- end of entry -->
9807
9808
9809
9810       <!-- end of kind -->
9811       </tbody>
9812       <tr><td colspan="6" class="kind">static</td></tr>
9813
9814       <thead class="entries_header">
9815         <tr>
9816           <th class="th_name">Property Name</th>
9817           <th class="th_type">Type</th>
9818           <th class="th_description">Description</th>
9819           <th class="th_units">Units</th>
9820           <th class="th_range">Range</th>
9821           <th class="th_tags">Tags</th>
9822         </tr>
9823       </thead>
9824
9825       <tbody>
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836           <tr class="entry" id="static_android.jpeg.availableThumbnailSizes">
9837             <td class="entry_name
9838              " rowspan="3">
9839               android.<wbr/>jpeg.<wbr/>available<wbr/>Thumbnail<wbr/>Sizes
9840             </td>
9841             <td class="entry_type">
9842                 <span class="entry_type_name">int32</span>
9843                 <span class="entry_type_container">x</span>
9844
9845                 <span class="entry_type_array">
9846                   2 x n
9847                 </span>
9848               <span class="entry_type_visibility"> [public as size]</span>
9849
9850
9851               <span class="entry_type_hwlevel">[legacy] </span>
9852
9853
9854
9855
9856             </td> <!-- entry_type -->
9857
9858             <td class="entry_description">
9859               <p>List of JPEG thumbnail sizes for <a href="#controls_android.jpeg.thumbnailSize">android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Size</a> supported by this
9860 camera device.<wbr/></p>
9861             </td>
9862
9863             <td class="entry_units">
9864             </td>
9865
9866             <td class="entry_range">
9867             </td>
9868
9869             <td class="entry_tags">
9870               <ul class="entry_tags">
9871                   <li><a href="#tag_BC">BC</a></li>
9872               </ul>
9873             </td>
9874
9875           </tr>
9876           <tr class="entries_header">
9877             <th class="th_details" colspan="5">Details</th>
9878           </tr>
9879           <tr class="entry_cont">
9880             <td class="entry_details" colspan="5">
9881               <p>This list will include at least one non-zero resolution,<wbr/> plus <code>(0,<wbr/>0)</code> for indicating no
9882 thumbnail should be generated.<wbr/></p>
9883 <p>Below condiditions will be satisfied for this size list:</p>
9884 <ul>
9885 <li>The sizes will be sorted by increasing pixel area (width x height).<wbr/>
9886 If several resolutions have the same area,<wbr/> they will be sorted by increasing width.<wbr/></li>
9887 <li>The aspect ratio of the largest thumbnail size will be same as the
9888 aspect ratio of largest JPEG output size in <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a>.<wbr/>
9889 The largest size is defined as the size that has the largest pixel area
9890 in a given size list.<wbr/></li>
9891 <li>Each output JPEG size in <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a> will have at least
9892 one corresponding size that has the same aspect ratio in availableThumbnailSizes,<wbr/>
9893 and vice versa.<wbr/></li>
9894 <li>All non-<code>(0,<wbr/> 0)</code> sizes will have non-zero widths and heights.<wbr/></li>
9895 </ul>
9896             </td>
9897           </tr>
9898
9899
9900           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9901            <!-- end of entry -->
9902
9903
9904           <tr class="entry" id="static_android.jpeg.maxSize">
9905             <td class="entry_name
9906              " rowspan="3">
9907               android.<wbr/>jpeg.<wbr/>max<wbr/>Size
9908             </td>
9909             <td class="entry_type">
9910                 <span class="entry_type_name">int32</span>
9911
9912               <span class="entry_type_visibility"> [system]</span>
9913
9914
9915
9916
9917
9918
9919             </td> <!-- entry_type -->
9920
9921             <td class="entry_description">
9922               <p>Maximum size in bytes for the compressed
9923 JPEG buffer</p>
9924             </td>
9925
9926             <td class="entry_units">
9927             </td>
9928
9929             <td class="entry_range">
9930               <p>Must be large enough to fit any JPEG produced by
9931 the camera</p>
9932             </td>
9933
9934             <td class="entry_tags">
9935             </td>
9936
9937           </tr>
9938           <tr class="entries_header">
9939             <th class="th_details" colspan="5">Details</th>
9940           </tr>
9941           <tr class="entry_cont">
9942             <td class="entry_details" colspan="5">
9943               <p>This is used for sizing the gralloc buffers for
9944 JPEG</p>
9945             </td>
9946           </tr>
9947
9948
9949           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9950            <!-- end of entry -->
9951
9952
9953
9954       <!-- end of kind -->
9955       </tbody>
9956       <tr><td colspan="6" class="kind">dynamic</td></tr>
9957
9958       <thead class="entries_header">
9959         <tr>
9960           <th class="th_name">Property Name</th>
9961           <th class="th_type">Type</th>
9962           <th class="th_description">Description</th>
9963           <th class="th_units">Units</th>
9964           <th class="th_range">Range</th>
9965           <th class="th_tags">Tags</th>
9966         </tr>
9967       </thead>
9968
9969       <tbody>
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980           <tr class="entry" id="dynamic_android.jpeg.gpsLocation">
9981             <td class="entry_name
9982              " rowspan="3">
9983               android.<wbr/>jpeg.<wbr/>gps<wbr/>Location
9984             </td>
9985             <td class="entry_type">
9986                 <span class="entry_type_name">byte</span>
9987
9988               <span class="entry_type_visibility"> [public as location]</span>
9989
9990               <span class="entry_type_synthetic">[synthetic] </span>
9991
9992               <span class="entry_type_hwlevel">[legacy] </span>
9993
9994
9995
9996
9997             </td> <!-- entry_type -->
9998
9999             <td class="entry_description">
10000               <p>A location object to use when generating image GPS metadata.<wbr/></p>
10001             </td>
10002
10003             <td class="entry_units">
10004             </td>
10005
10006             <td class="entry_range">
10007             </td>
10008
10009             <td class="entry_tags">
10010             </td>
10011
10012           </tr>
10013           <tr class="entries_header">
10014             <th class="th_details" colspan="5">Details</th>
10015           </tr>
10016           <tr class="entry_cont">
10017             <td class="entry_details" colspan="5">
10018               <p>Setting a location object in a request will include the GPS coordinates of the location
10019 into any JPEG images captured based on the request.<wbr/> These coordinates can then be
10020 viewed by anyone who receives the JPEG image.<wbr/></p>
10021             </td>
10022           </tr>
10023
10024
10025           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10026            <!-- end of entry -->
10027
10028
10029           <tr class="entry" id="dynamic_android.jpeg.gpsCoordinates">
10030             <td class="entry_name
10031              " rowspan="1">
10032               android.<wbr/>jpeg.<wbr/>gps<wbr/>Coordinates
10033             </td>
10034             <td class="entry_type">
10035                 <span class="entry_type_name">double</span>
10036                 <span class="entry_type_container">x</span>
10037
10038                 <span class="entry_type_array">
10039                   3
10040                 </span>
10041               <span class="entry_type_visibility"> [hidden]</span>
10042
10043
10044               <span class="entry_type_hwlevel">[legacy] </span>
10045
10046
10047                 <div class="entry_type_notes">latitude,<wbr/> longitude,<wbr/> altitude.<wbr/> First two in degrees,<wbr/> the third in meters</div>
10048
10049
10050             </td> <!-- entry_type -->
10051
10052             <td class="entry_description">
10053               <p>GPS coordinates to include in output JPEG
10054 EXIF.<wbr/></p>
10055             </td>
10056
10057             <td class="entry_units">
10058             </td>
10059
10060             <td class="entry_range">
10061               <p>(-180 - 180],<wbr/> [-90,<wbr/>90],<wbr/> [-inf,<wbr/> inf]</p>
10062             </td>
10063
10064             <td class="entry_tags">
10065               <ul class="entry_tags">
10066                   <li><a href="#tag_BC">BC</a></li>
10067               </ul>
10068             </td>
10069
10070           </tr>
10071
10072
10073           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10074            <!-- end of entry -->
10075
10076
10077           <tr class="entry" id="dynamic_android.jpeg.gpsProcessingMethod">
10078             <td class="entry_name
10079              " rowspan="1">
10080               android.<wbr/>jpeg.<wbr/>gps<wbr/>Processing<wbr/>Method
10081             </td>
10082             <td class="entry_type">
10083                 <span class="entry_type_name">byte</span>
10084
10085               <span class="entry_type_visibility"> [hidden as string]</span>
10086
10087
10088               <span class="entry_type_hwlevel">[legacy] </span>
10089
10090
10091
10092
10093             </td> <!-- entry_type -->
10094
10095             <td class="entry_description">
10096               <p>32 characters describing GPS algorithm to
10097 include in EXIF.<wbr/></p>
10098             </td>
10099
10100             <td class="entry_units">
10101               UTF-8 null-terminated string
10102             </td>
10103
10104             <td class="entry_range">
10105             </td>
10106
10107             <td class="entry_tags">
10108               <ul class="entry_tags">
10109                   <li><a href="#tag_BC">BC</a></li>
10110               </ul>
10111             </td>
10112
10113           </tr>
10114
10115
10116           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10117            <!-- end of entry -->
10118
10119
10120           <tr class="entry" id="dynamic_android.jpeg.gpsTimestamp">
10121             <td class="entry_name
10122              " rowspan="1">
10123               android.<wbr/>jpeg.<wbr/>gps<wbr/>Timestamp
10124             </td>
10125             <td class="entry_type">
10126                 <span class="entry_type_name">int64</span>
10127
10128               <span class="entry_type_visibility"> [hidden]</span>
10129
10130
10131               <span class="entry_type_hwlevel">[legacy] </span>
10132
10133
10134
10135
10136             </td> <!-- entry_type -->
10137
10138             <td class="entry_description">
10139               <p>Time GPS fix was made to include in
10140 EXIF.<wbr/></p>
10141             </td>
10142
10143             <td class="entry_units">
10144               UTC in seconds since January 1,<wbr/> 1970
10145             </td>
10146
10147             <td class="entry_range">
10148             </td>
10149
10150             <td class="entry_tags">
10151               <ul class="entry_tags">
10152                   <li><a href="#tag_BC">BC</a></li>
10153               </ul>
10154             </td>
10155
10156           </tr>
10157
10158
10159           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10160            <!-- end of entry -->
10161
10162
10163           <tr class="entry" id="dynamic_android.jpeg.orientation">
10164             <td class="entry_name
10165              " rowspan="3">
10166               android.<wbr/>jpeg.<wbr/>orientation
10167             </td>
10168             <td class="entry_type">
10169                 <span class="entry_type_name">int32</span>
10170
10171               <span class="entry_type_visibility"> [public]</span>
10172
10173
10174               <span class="entry_type_hwlevel">[legacy] </span>
10175
10176
10177
10178
10179             </td> <!-- entry_type -->
10180
10181             <td class="entry_description">
10182               <p>The orientation for a JPEG image.<wbr/></p>
10183             </td>
10184
10185             <td class="entry_units">
10186               Degrees in multiples of 90
10187             </td>
10188
10189             <td class="entry_range">
10190               <p>0,<wbr/> 90,<wbr/> 180,<wbr/> 270</p>
10191             </td>
10192
10193             <td class="entry_tags">
10194               <ul class="entry_tags">
10195                   <li><a href="#tag_BC">BC</a></li>
10196               </ul>
10197             </td>
10198
10199           </tr>
10200           <tr class="entries_header">
10201             <th class="th_details" colspan="5">Details</th>
10202           </tr>
10203           <tr class="entry_cont">
10204             <td class="entry_details" colspan="5">
10205               <p>The clockwise rotation angle in degrees,<wbr/> relative to the orientation
10206 to the camera,<wbr/> that the JPEG picture needs to be rotated by,<wbr/> to be viewed
10207 upright.<wbr/></p>
10208 <p>Camera devices may either encode this value into the JPEG EXIF header,<wbr/> or
10209 rotate the image data to match this orientation.<wbr/></p>
10210 <p>Note that this orientation is relative to the orientation of the camera sensor,<wbr/> given
10211 by <a href="#static_android.sensor.orientation">android.<wbr/>sensor.<wbr/>orientation</a>.<wbr/></p>
10212 <p>To translate from the device orientation given by the Android sensor APIs,<wbr/> the following
10213 sample code may be used:</p>
10214 <pre><code>private int getJpegOrientation(CameraCharacteristics c,<wbr/> int deviceOrientation) {
10215     if (deviceOrientation == android.<wbr/>view.<wbr/>Orientation<wbr/>Event<wbr/>Listener.<wbr/>ORIENTATION_<wbr/>UNKNOWN) return 0;
10216     int sensorOrientation = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>SENSOR_<wbr/>ORIENTATION);
10217
10218     //<wbr/> Round device orientation to a multiple of 90
10219     deviceOrientation = (deviceOrientation + 45) /<wbr/> 90 * 90;
10220
10221     //<wbr/> Reverse device orientation for front-facing cameras
10222     boolean facingFront = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>LENS_<wbr/>FACING) == Camera<wbr/>Characteristics.<wbr/>LENS_<wbr/>FACING_<wbr/>FRONT;
10223     if (facingFront) deviceOrientation = -deviceOrientation;
10224
10225     //<wbr/> Calculate desired JPEG orientation relative to camera orientation to make
10226     //<wbr/> the image upright relative to the device orientation
10227     int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360;
10228
10229     return jpegOrientation;
10230 }
10231 </code></pre>
10232             </td>
10233           </tr>
10234
10235
10236           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10237            <!-- end of entry -->
10238
10239
10240           <tr class="entry" id="dynamic_android.jpeg.quality">
10241             <td class="entry_name
10242              " rowspan="3">
10243               android.<wbr/>jpeg.<wbr/>quality
10244             </td>
10245             <td class="entry_type">
10246                 <span class="entry_type_name">byte</span>
10247
10248               <span class="entry_type_visibility"> [public]</span>
10249
10250
10251               <span class="entry_type_hwlevel">[legacy] </span>
10252
10253
10254
10255
10256             </td> <!-- entry_type -->
10257
10258             <td class="entry_description">
10259               <p>Compression quality of the final JPEG
10260 image.<wbr/></p>
10261             </td>
10262
10263             <td class="entry_units">
10264             </td>
10265
10266             <td class="entry_range">
10267               <p>1-100; larger is higher quality</p>
10268             </td>
10269
10270             <td class="entry_tags">
10271               <ul class="entry_tags">
10272                   <li><a href="#tag_BC">BC</a></li>
10273               </ul>
10274             </td>
10275
10276           </tr>
10277           <tr class="entries_header">
10278             <th class="th_details" colspan="5">Details</th>
10279           </tr>
10280           <tr class="entry_cont">
10281             <td class="entry_details" colspan="5">
10282               <p>85-95 is typical usage range.<wbr/></p>
10283             </td>
10284           </tr>
10285
10286
10287           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10288            <!-- end of entry -->
10289
10290
10291           <tr class="entry" id="dynamic_android.jpeg.size">
10292             <td class="entry_name
10293              " rowspan="3">
10294               android.<wbr/>jpeg.<wbr/>size
10295             </td>
10296             <td class="entry_type">
10297                 <span class="entry_type_name">int32</span>
10298
10299               <span class="entry_type_visibility"> [system]</span>
10300
10301
10302
10303
10304
10305
10306             </td> <!-- entry_type -->
10307
10308             <td class="entry_description">
10309               <p>The size of the compressed JPEG image,<wbr/> in
10310 bytes</p>
10311             </td>
10312
10313             <td class="entry_units">
10314             </td>
10315
10316             <td class="entry_range">
10317               <p>&gt;= 0</p>
10318             </td>
10319
10320             <td class="entry_tags">
10321               <ul class="entry_tags">
10322                   <li><a href="#tag_FUTURE">FUTURE</a></li>
10323               </ul>
10324             </td>
10325
10326           </tr>
10327           <tr class="entries_header">
10328             <th class="th_details" colspan="5">Details</th>
10329           </tr>
10330           <tr class="entry_cont">
10331             <td class="entry_details" colspan="5">
10332               <p>If no JPEG output is produced for the request,<wbr/>
10333 this must be 0.<wbr/></p>
10334 <p>Otherwise,<wbr/> this describes the real size of the compressed
10335 JPEG image placed in the output stream.<wbr/>  More specifically,<wbr/>
10336 if <a href="#static_android.jpeg.maxSize">android.<wbr/>jpeg.<wbr/>max<wbr/>Size</a> = 1000000,<wbr/> and a specific capture
10337 has <a href="#dynamic_android.jpeg.size">android.<wbr/>jpeg.<wbr/>size</a> = 500000,<wbr/> then the output buffer from
10338 the JPEG stream will be 1000000 bytes,<wbr/> of which the first
10339 500000 make up the real data.<wbr/></p>
10340             </td>
10341           </tr>
10342
10343
10344           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10345            <!-- end of entry -->
10346
10347
10348           <tr class="entry" id="dynamic_android.jpeg.thumbnailQuality">
10349             <td class="entry_name
10350              " rowspan="1">
10351               android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Quality
10352             </td>
10353             <td class="entry_type">
10354                 <span class="entry_type_name">byte</span>
10355
10356               <span class="entry_type_visibility"> [public]</span>
10357
10358
10359               <span class="entry_type_hwlevel">[legacy] </span>
10360
10361
10362
10363
10364             </td> <!-- entry_type -->
10365
10366             <td class="entry_description">
10367               <p>Compression quality of JPEG
10368 thumbnail.<wbr/></p>
10369             </td>
10370
10371             <td class="entry_units">
10372             </td>
10373
10374             <td class="entry_range">
10375               <p>1-100; larger is higher quality</p>
10376             </td>
10377
10378             <td class="entry_tags">
10379               <ul class="entry_tags">
10380                   <li><a href="#tag_BC">BC</a></li>
10381               </ul>
10382             </td>
10383
10384           </tr>
10385
10386
10387           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10388            <!-- end of entry -->
10389
10390
10391           <tr class="entry" id="dynamic_android.jpeg.thumbnailSize">
10392             <td class="entry_name
10393              " rowspan="5">
10394               android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Size
10395             </td>
10396             <td class="entry_type">
10397                 <span class="entry_type_name">int32</span>
10398                 <span class="entry_type_container">x</span>
10399
10400                 <span class="entry_type_array">
10401                   2
10402                 </span>
10403               <span class="entry_type_visibility"> [public as size]</span>
10404
10405
10406               <span class="entry_type_hwlevel">[legacy] </span>
10407
10408
10409
10410
10411             </td> <!-- entry_type -->
10412
10413             <td class="entry_description">
10414               <p>Resolution of embedded JPEG thumbnail.<wbr/></p>
10415             </td>
10416
10417             <td class="entry_units">
10418             </td>
10419
10420             <td class="entry_range">
10421               <p><a href="#static_android.jpeg.availableThumbnailSizes">android.<wbr/>jpeg.<wbr/>available<wbr/>Thumbnail<wbr/>Sizes</a></p>
10422             </td>
10423
10424             <td class="entry_tags">
10425               <ul class="entry_tags">
10426                   <li><a href="#tag_BC">BC</a></li>
10427               </ul>
10428             </td>
10429
10430           </tr>
10431           <tr class="entries_header">
10432             <th class="th_details" colspan="5">Details</th>
10433           </tr>
10434           <tr class="entry_cont">
10435             <td class="entry_details" colspan="5">
10436               <p>When set to (0,<wbr/> 0) value,<wbr/> the JPEG EXIF will not contain thumbnail,<wbr/>
10437 but the captured JPEG will still be a valid image.<wbr/></p>
10438 <p>For best results,<wbr/> when issuing a request for a JPEG image,<wbr/> the thumbnail size selected
10439 should have the same aspect ratio as the main JPEG output.<wbr/></p>
10440 <p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect
10441 ratio,<wbr/> the camera device creates the thumbnail by cropping it from the primary image.<wbr/>
10442 For example,<wbr/> if the primary image has 4:3 aspect ratio,<wbr/> the thumbnail image has
10443 16:9 aspect ratio,<wbr/> the primary image will be cropped vertically (letterbox) to
10444 generate the thumbnail image.<wbr/> The thumbnail image will always have a smaller Field
10445 Of View (FOV) than the primary image when aspect ratios differ.<wbr/></p>
10446             </td>
10447           </tr>
10448
10449           <tr class="entries_header">
10450             <th class="th_details" colspan="5">HAL Implementation Details</th>
10451           </tr>
10452           <tr class="entry_cont">
10453             <td class="entry_details" colspan="5">
10454               <p>The HAL must not squeeze or stretch the downscaled primary image to generate thumbnail.<wbr/>
10455 The cropping must be done on the primary jpeg image rather than the sensor active array.<wbr/>
10456 The stream cropping rule specified by "S5.<wbr/> Cropping" in camera3.<wbr/>h doesn't apply to the
10457 thumbnail image cropping.<wbr/></p>
10458             </td>
10459           </tr>
10460
10461           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10462            <!-- end of entry -->
10463
10464
10465
10466       <!-- end of kind -->
10467       </tbody>
10468
10469   <!-- end of section -->
10470   <tr><td colspan="6" id="section_lens" class="section">lens</td></tr>
10471
10472
10473       <tr><td colspan="6" class="kind">controls</td></tr>
10474
10475       <thead class="entries_header">
10476         <tr>
10477           <th class="th_name">Property Name</th>
10478           <th class="th_type">Type</th>
10479           <th class="th_description">Description</th>
10480           <th class="th_units">Units</th>
10481           <th class="th_range">Range</th>
10482           <th class="th_tags">Tags</th>
10483         </tr>
10484       </thead>
10485
10486       <tbody>
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497           <tr class="entry" id="controls_android.lens.aperture">
10498             <td class="entry_name
10499              " rowspan="3">
10500               android.<wbr/>lens.<wbr/>aperture
10501             </td>
10502             <td class="entry_type">
10503                 <span class="entry_type_name">float</span>
10504
10505               <span class="entry_type_visibility"> [public]</span>
10506
10507
10508               <span class="entry_type_hwlevel">[full] </span>
10509
10510
10511
10512
10513             </td> <!-- entry_type -->
10514
10515             <td class="entry_description">
10516               <p>The desired lens aperture size,<wbr/> as a ratio of lens focal length to the
10517 effective aperture diameter.<wbr/></p>
10518             </td>
10519
10520             <td class="entry_units">
10521               The f-number (f/<wbr/>N)
10522             </td>
10523
10524             <td class="entry_range">
10525               <p><a href="#static_android.lens.info.availableApertures">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Apertures</a></p>
10526             </td>
10527
10528             <td class="entry_tags">
10529               <ul class="entry_tags">
10530                   <li><a href="#tag_V1">V1</a></li>
10531               </ul>
10532             </td>
10533
10534           </tr>
10535           <tr class="entries_header">
10536             <th class="th_details" colspan="5">Details</th>
10537           </tr>
10538           <tr class="entry_cont">
10539             <td class="entry_details" colspan="5">
10540               <p>Setting this value is only supported on the camera devices that have a variable
10541 aperture lens.<wbr/></p>
10542 <p>When this is supported and <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is OFF,<wbr/>
10543 this can be set along with <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
10544 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> and <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>
10545 to achieve manual exposure control.<wbr/></p>
10546 <p>The requested aperture value may take several frames to reach the
10547 requested value; the camera device will report the current (intermediate)
10548 aperture size in capture result metadata while the aperture is changing.<wbr/>
10549 While the aperture is still changing,<wbr/> <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
10550 <p>When this is supported and <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is one of
10551 the ON modes,<wbr/> this will be overridden by the camera device
10552 auto-exposure algorithm,<wbr/> the overridden values are then provided
10553 back to the user in the corresponding result.<wbr/></p>
10554             </td>
10555           </tr>
10556
10557
10558           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10559            <!-- end of entry -->
10560
10561
10562           <tr class="entry" id="controls_android.lens.filterDensity">
10563             <td class="entry_name
10564              " rowspan="3">
10565               android.<wbr/>lens.<wbr/>filter<wbr/>Density
10566             </td>
10567             <td class="entry_type">
10568                 <span class="entry_type_name">float</span>
10569
10570               <span class="entry_type_visibility"> [public]</span>
10571
10572
10573               <span class="entry_type_hwlevel">[full] </span>
10574
10575
10576
10577
10578             </td> <!-- entry_type -->
10579
10580             <td class="entry_description">
10581               <p>The desired setting for the lens neutral density filter(s).<wbr/></p>
10582             </td>
10583
10584             <td class="entry_units">
10585               Exposure Value (EV)
10586             </td>
10587
10588             <td class="entry_range">
10589               <p><a href="#static_android.lens.info.availableFilterDensities">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Filter<wbr/>Densities</a></p>
10590             </td>
10591
10592             <td class="entry_tags">
10593               <ul class="entry_tags">
10594                   <li><a href="#tag_V1">V1</a></li>
10595               </ul>
10596             </td>
10597
10598           </tr>
10599           <tr class="entries_header">
10600             <th class="th_details" colspan="5">Details</th>
10601           </tr>
10602           <tr class="entry_cont">
10603             <td class="entry_details" colspan="5">
10604               <p>This control will not be supported on most camera devices.<wbr/></p>
10605 <p>Lens filters are typically used to lower the amount of light the
10606 sensor is exposed to (measured in steps of EV).<wbr/> As used here,<wbr/> an EV
10607 step is the standard logarithmic representation,<wbr/> which are
10608 non-negative,<wbr/> and inversely proportional to the amount of light
10609 hitting the sensor.<wbr/>  For example,<wbr/> setting this to 0 would result
10610 in no reduction of the incoming light,<wbr/> and setting this to 2 would
10611 mean that the filter is set to reduce incoming light by two stops
10612 (allowing 1/<wbr/>4 of the prior amount of light to the sensor).<wbr/></p>
10613 <p>It may take several frames before the lens filter density changes
10614 to the requested value.<wbr/> While the filter density is still changing,<wbr/>
10615 <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
10616             </td>
10617           </tr>
10618
10619
10620           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10621            <!-- end of entry -->
10622
10623
10624           <tr class="entry" id="controls_android.lens.focalLength">
10625             <td class="entry_name
10626              " rowspan="3">
10627               android.<wbr/>lens.<wbr/>focal<wbr/>Length
10628             </td>
10629             <td class="entry_type">
10630                 <span class="entry_type_name">float</span>
10631
10632               <span class="entry_type_visibility"> [public]</span>
10633
10634
10635               <span class="entry_type_hwlevel">[legacy] </span>
10636
10637
10638
10639
10640             </td> <!-- entry_type -->
10641
10642             <td class="entry_description">
10643               <p>The desired lens focal length; used for optical zoom.<wbr/></p>
10644             </td>
10645
10646             <td class="entry_units">
10647               Millimeters
10648             </td>
10649
10650             <td class="entry_range">
10651               <p><a href="#static_android.lens.info.availableFocalLengths">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Focal<wbr/>Lengths</a></p>
10652             </td>
10653
10654             <td class="entry_tags">
10655               <ul class="entry_tags">
10656                   <li><a href="#tag_V1">V1</a></li>
10657               </ul>
10658             </td>
10659
10660           </tr>
10661           <tr class="entries_header">
10662             <th class="th_details" colspan="5">Details</th>
10663           </tr>
10664           <tr class="entry_cont">
10665             <td class="entry_details" colspan="5">
10666               <p>This setting controls the physical focal length of the camera
10667 device's lens.<wbr/> Changing the focal length changes the field of
10668 view of the camera device,<wbr/> and is usually used for optical zoom.<wbr/></p>
10669 <p>Like <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> and <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a>,<wbr/> this
10670 setting won't be applied instantaneously,<wbr/> and it may take several
10671 frames before the lens can change to the requested focal length.<wbr/>
10672 While the focal length is still changing,<wbr/> <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will
10673 be set to MOVING.<wbr/></p>
10674 <p>Optical zoom will not be supported on most devices.<wbr/></p>
10675             </td>
10676           </tr>
10677
10678
10679           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10680            <!-- end of entry -->
10681
10682
10683           <tr class="entry" id="controls_android.lens.focusDistance">
10684             <td class="entry_name
10685              " rowspan="3">
10686               android.<wbr/>lens.<wbr/>focus<wbr/>Distance
10687             </td>
10688             <td class="entry_type">
10689                 <span class="entry_type_name">float</span>
10690
10691               <span class="entry_type_visibility"> [public]</span>
10692
10693
10694               <span class="entry_type_hwlevel">[full] </span>
10695
10696
10697
10698
10699             </td> <!-- entry_type -->
10700
10701             <td class="entry_description">
10702               <p>Desired distance to plane of sharpest focus,<wbr/>
10703 measured from frontmost surface of the lens.<wbr/></p>
10704             </td>
10705
10706             <td class="entry_units">
10707               See android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details
10708             </td>
10709
10710             <td class="entry_range">
10711               <p>&gt;= 0</p>
10712             </td>
10713
10714             <td class="entry_tags">
10715               <ul class="entry_tags">
10716                   <li><a href="#tag_BC">BC</a></li>
10717                   <li><a href="#tag_V1">V1</a></li>
10718               </ul>
10719             </td>
10720
10721           </tr>
10722           <tr class="entries_header">
10723             <th class="th_details" colspan="5">Details</th>
10724           </tr>
10725           <tr class="entry_cont">
10726             <td class="entry_details" colspan="5">
10727               <p>This control can be used for setting manual focus,<wbr/> on devices that support
10728 the MANUAL_<wbr/>SENSOR capability and have a variable-focus lens (see
10729 <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a>).<wbr/></p>
10730 <p>A value of <code>0.<wbr/>0f</code> means infinity focus.<wbr/> The value set will be clamped to
10731 <code>[0.<wbr/>0f,<wbr/> <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a>]</code>.<wbr/></p>
10732 <p>Like <a href="#controls_android.lens.focalLength">android.<wbr/>lens.<wbr/>focal<wbr/>Length</a>,<wbr/> this setting won't be applied
10733 instantaneously,<wbr/> and it may take several frames before the lens
10734 can move to the requested focus distance.<wbr/> While the lens is still moving,<wbr/>
10735 <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
10736 <p>LEGACY devices support at most setting this to <code>0.<wbr/>0f</code>
10737 for infinity focus.<wbr/></p>
10738             </td>
10739           </tr>
10740
10741
10742           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10743            <!-- end of entry -->
10744
10745
10746           <tr class="entry" id="controls_android.lens.opticalStabilizationMode">
10747             <td class="entry_name
10748              " rowspan="3">
10749               android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode
10750             </td>
10751             <td class="entry_type">
10752                 <span class="entry_type_name entry_type_name_enum">byte</span>
10753
10754               <span class="entry_type_visibility"> [public]</span>
10755
10756
10757               <span class="entry_type_hwlevel">[limited] </span>
10758
10759
10760
10761                 <ul class="entry_type_enum">
10762                   <li>
10763                     <span class="entry_type_enum_name">OFF</span>
10764                     <span class="entry_type_enum_notes"><p>Optical stabilization is unavailable.<wbr/></p></span>
10765                   </li>
10766                   <li>
10767                     <span class="entry_type_enum_name">ON</span>
10768                     <span class="entry_type_enum_optional">[optional]</span>
10769                     <span class="entry_type_enum_notes"><p>Optical stabilization is enabled.<wbr/></p></span>
10770                   </li>
10771                 </ul>
10772
10773             </td> <!-- entry_type -->
10774
10775             <td class="entry_description">
10776               <p>Sets whether the camera device uses optical image stabilization (OIS)
10777 when capturing images.<wbr/></p>
10778             </td>
10779
10780             <td class="entry_units">
10781             </td>
10782
10783             <td class="entry_range">
10784               <p><a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a></p>
10785             </td>
10786
10787             <td class="entry_tags">
10788               <ul class="entry_tags">
10789                   <li><a href="#tag_V1">V1</a></li>
10790               </ul>
10791             </td>
10792
10793           </tr>
10794           <tr class="entries_header">
10795             <th class="th_details" colspan="5">Details</th>
10796           </tr>
10797           <tr class="entry_cont">
10798             <td class="entry_details" colspan="5">
10799               <p>OIS is used to compensate for motion blur due to small
10800 movements of the camera during capture.<wbr/> Unlike digital image
10801 stabilization (<a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> OIS
10802 makes use of mechanical elements to stabilize the camera
10803 sensor,<wbr/> and thus allows for longer exposure times before
10804 camera shake becomes apparent.<wbr/></p>
10805 <p>Switching between different optical stabilization modes may take several
10806 frames to initialize,<wbr/> the camera device will report the current mode in
10807 capture result metadata.<wbr/> For example,<wbr/> When "ON" mode is requested,<wbr/> the
10808 optical stabilization modes in the first several capture results may still
10809 be "OFF",<wbr/> and it will become "ON" when the initialization is done.<wbr/></p>
10810 <p>If a camera device supports both OIS and digital image stabilization
10811 (<a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> turning both modes on may produce undesirable
10812 interaction,<wbr/> so it is recommended not to enable both at the same time.<wbr/></p>
10813 <p>Not all devices will support OIS; see
10814 <a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a> for
10815 available controls.<wbr/></p>
10816             </td>
10817           </tr>
10818
10819
10820           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10821            <!-- end of entry -->
10822
10823
10824
10825       <!-- end of kind -->
10826       </tbody>
10827       <tr><td colspan="6" class="kind">static</td></tr>
10828
10829       <thead class="entries_header">
10830         <tr>
10831           <th class="th_name">Property Name</th>
10832           <th class="th_type">Type</th>
10833           <th class="th_description">Description</th>
10834           <th class="th_units">Units</th>
10835           <th class="th_range">Range</th>
10836           <th class="th_tags">Tags</th>
10837         </tr>
10838       </thead>
10839
10840       <tbody>
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853           <tr class="entry" id="static_android.lens.info.availableApertures">
10854             <td class="entry_name
10855              " rowspan="3">
10856               android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Apertures
10857             </td>
10858             <td class="entry_type">
10859                 <span class="entry_type_name">float</span>
10860                 <span class="entry_type_container">x</span>
10861
10862                 <span class="entry_type_array">
10863                   n
10864                 </span>
10865               <span class="entry_type_visibility"> [public]</span>
10866
10867
10868               <span class="entry_type_hwlevel">[full] </span>
10869
10870
10871
10872
10873             </td> <!-- entry_type -->
10874
10875             <td class="entry_description">
10876               <p>List of aperture size values for <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a> that are
10877 supported by this camera device.<wbr/></p>
10878             </td>
10879
10880             <td class="entry_units">
10881               The aperture f-number
10882             </td>
10883
10884             <td class="entry_range">
10885             </td>
10886
10887             <td class="entry_tags">
10888               <ul class="entry_tags">
10889                   <li><a href="#tag_V1">V1</a></li>
10890               </ul>
10891             </td>
10892
10893           </tr>
10894           <tr class="entries_header">
10895             <th class="th_details" colspan="5">Details</th>
10896           </tr>
10897           <tr class="entry_cont">
10898             <td class="entry_details" colspan="5">
10899               <p>If the camera device doesn't support a variable lens aperture,<wbr/>
10900 this list will contain only one value,<wbr/> which is the fixed aperture size.<wbr/></p>
10901 <p>If the camera device supports a variable aperture,<wbr/> the aperture values
10902 in this list will be sorted in ascending order.<wbr/></p>
10903             </td>
10904           </tr>
10905
10906
10907           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10908            <!-- end of entry -->
10909
10910
10911           <tr class="entry" id="static_android.lens.info.availableFilterDensities">
10912             <td class="entry_name
10913              " rowspan="3">
10914               android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Filter<wbr/>Densities
10915             </td>
10916             <td class="entry_type">
10917                 <span class="entry_type_name">float</span>
10918                 <span class="entry_type_container">x</span>
10919
10920                 <span class="entry_type_array">
10921                   n
10922                 </span>
10923               <span class="entry_type_visibility"> [public]</span>
10924
10925
10926               <span class="entry_type_hwlevel">[full] </span>
10927
10928
10929
10930
10931             </td> <!-- entry_type -->
10932
10933             <td class="entry_description">
10934               <p>List of neutral density filter values for
10935 <a href="#controls_android.lens.filterDensity">android.<wbr/>lens.<wbr/>filter<wbr/>Density</a> that are supported by this camera device.<wbr/></p>
10936             </td>
10937
10938             <td class="entry_units">
10939               Exposure value (EV)
10940             </td>
10941
10942             <td class="entry_range">
10943               <p>Values are &gt;= 0</p>
10944             </td>
10945
10946             <td class="entry_tags">
10947               <ul class="entry_tags">
10948                   <li><a href="#tag_V1">V1</a></li>
10949               </ul>
10950             </td>
10951
10952           </tr>
10953           <tr class="entries_header">
10954             <th class="th_details" colspan="5">Details</th>
10955           </tr>
10956           <tr class="entry_cont">
10957             <td class="entry_details" colspan="5">
10958               <p>If a neutral density filter is not supported by this camera device,<wbr/>
10959 this list will contain only 0.<wbr/> Otherwise,<wbr/> this list will include every
10960 filter density supported by the camera device,<wbr/> in ascending order.<wbr/></p>
10961             </td>
10962           </tr>
10963
10964
10965           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10966            <!-- end of entry -->
10967
10968
10969           <tr class="entry" id="static_android.lens.info.availableFocalLengths">
10970             <td class="entry_name
10971              " rowspan="3">
10972               android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Focal<wbr/>Lengths
10973             </td>
10974             <td class="entry_type">
10975                 <span class="entry_type_name">float</span>
10976                 <span class="entry_type_container">x</span>
10977
10978                 <span class="entry_type_array">
10979                   n
10980                 </span>
10981               <span class="entry_type_visibility"> [public]</span>
10982
10983
10984               <span class="entry_type_hwlevel">[legacy] </span>
10985
10986
10987                 <div class="entry_type_notes">The list of available focal lengths</div>
10988
10989
10990             </td> <!-- entry_type -->
10991
10992             <td class="entry_description">
10993               <p>List of focal lengths for <a href="#controls_android.lens.focalLength">android.<wbr/>lens.<wbr/>focal<wbr/>Length</a> that are supported by this camera
10994 device.<wbr/></p>
10995             </td>
10996
10997             <td class="entry_units">
10998               Millimeters
10999             </td>
11000
11001             <td class="entry_range">
11002               <p>Values are &gt; 0</p>
11003             </td>
11004
11005             <td class="entry_tags">
11006               <ul class="entry_tags">
11007                   <li><a href="#tag_BC">BC</a></li>
11008                   <li><a href="#tag_V1">V1</a></li>
11009               </ul>
11010             </td>
11011
11012           </tr>
11013           <tr class="entries_header">
11014             <th class="th_details" colspan="5">Details</th>
11015           </tr>
11016           <tr class="entry_cont">
11017             <td class="entry_details" colspan="5">
11018               <p>If optical zoom is not supported,<wbr/> this list will only contain
11019 a single value corresponding to the fixed focal length of the
11020 device.<wbr/> Otherwise,<wbr/> this list will include every focal length supported
11021 by the camera device,<wbr/> in ascending order.<wbr/></p>
11022             </td>
11023           </tr>
11024
11025
11026           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11027            <!-- end of entry -->
11028
11029
11030           <tr class="entry" id="static_android.lens.info.availableOpticalStabilization">
11031             <td class="entry_name
11032              " rowspan="3">
11033               android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization
11034             </td>
11035             <td class="entry_type">
11036                 <span class="entry_type_name">byte</span>
11037                 <span class="entry_type_container">x</span>
11038
11039                 <span class="entry_type_array">
11040                   n
11041                 </span>
11042               <span class="entry_type_visibility"> [public as enumList]</span>
11043
11044
11045               <span class="entry_type_hwlevel">[limited] </span>
11046
11047
11048                 <div class="entry_type_notes">list of enums</div>
11049
11050
11051             </td> <!-- entry_type -->
11052
11053             <td class="entry_description">
11054               <p>List of optical image stabilization (OIS) modes for
11055 <a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a> that are supported by this camera device.<wbr/></p>
11056             </td>
11057
11058             <td class="entry_units">
11059             </td>
11060
11061             <td class="entry_range">
11062               <p>Any value listed in <a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a></p>
11063             </td>
11064
11065             <td class="entry_tags">
11066               <ul class="entry_tags">
11067                   <li><a href="#tag_V1">V1</a></li>
11068               </ul>
11069             </td>
11070
11071           </tr>
11072           <tr class="entries_header">
11073             <th class="th_details" colspan="5">Details</th>
11074           </tr>
11075           <tr class="entry_cont">
11076             <td class="entry_details" colspan="5">
11077               <p>If OIS is not supported by a given camera device,<wbr/> this list will
11078 contain only OFF.<wbr/></p>
11079             </td>
11080           </tr>
11081
11082
11083           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11084            <!-- end of entry -->
11085
11086
11087           <tr class="entry" id="static_android.lens.info.hyperfocalDistance">
11088             <td class="entry_name
11089              " rowspan="3">
11090               android.<wbr/>lens.<wbr/>info.<wbr/>hyperfocal<wbr/>Distance
11091             </td>
11092             <td class="entry_type">
11093                 <span class="entry_type_name">float</span>
11094
11095               <span class="entry_type_visibility"> [public]</span>
11096
11097
11098               <span class="entry_type_hwlevel">[limited] </span>
11099
11100
11101
11102
11103             </td> <!-- entry_type -->
11104
11105             <td class="entry_description">
11106               <p>Hyperfocal distance for this lens.<wbr/></p>
11107             </td>
11108
11109             <td class="entry_units">
11110               See android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details
11111             </td>
11112
11113             <td class="entry_range">
11114               <p>If lens is fixed focus,<wbr/> &gt;= 0.<wbr/> If lens has focuser unit,<wbr/> the value is
11115 within <code>(0.<wbr/>0f,<wbr/> <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a>]</code></p>
11116             </td>
11117
11118             <td class="entry_tags">
11119             </td>
11120
11121           </tr>
11122           <tr class="entries_header">
11123             <th class="th_details" colspan="5">Details</th>
11124           </tr>
11125           <tr class="entry_cont">
11126             <td class="entry_details" colspan="5">
11127               <p>If the lens is not fixed focus,<wbr/> the camera device will report this
11128 field when <a href="#static_android.lens.info.focusDistanceCalibration">android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration</a> is APPROXIMATE or CALIBRATED.<wbr/></p>
11129             </td>
11130           </tr>
11131
11132
11133           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11134            <!-- end of entry -->
11135
11136
11137           <tr class="entry" id="static_android.lens.info.minimumFocusDistance">
11138             <td class="entry_name
11139              " rowspan="5">
11140               android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance
11141             </td>
11142             <td class="entry_type">
11143                 <span class="entry_type_name">float</span>
11144
11145               <span class="entry_type_visibility"> [public]</span>
11146
11147
11148               <span class="entry_type_hwlevel">[limited] </span>
11149
11150
11151
11152
11153             </td> <!-- entry_type -->
11154
11155             <td class="entry_description">
11156               <p>Shortest distance from frontmost surface
11157 of the lens that can be brought into sharp focus.<wbr/></p>
11158             </td>
11159
11160             <td class="entry_units">
11161               See android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details
11162             </td>
11163
11164             <td class="entry_range">
11165               <p>&gt;= 0</p>
11166             </td>
11167
11168             <td class="entry_tags">
11169               <ul class="entry_tags">
11170                   <li><a href="#tag_V1">V1</a></li>
11171               </ul>
11172             </td>
11173
11174           </tr>
11175           <tr class="entries_header">
11176             <th class="th_details" colspan="5">Details</th>
11177           </tr>
11178           <tr class="entry_cont">
11179             <td class="entry_details" colspan="5">
11180               <p>If the lens is fixed-focus,<wbr/> this will be
11181 0.<wbr/></p>
11182             </td>
11183           </tr>
11184
11185           <tr class="entries_header">
11186             <th class="th_details" colspan="5">HAL Implementation Details</th>
11187           </tr>
11188           <tr class="entry_cont">
11189             <td class="entry_details" colspan="5">
11190               <p>Mandatory for FULL devices; LIMITED devices
11191 must always set this value to 0 for fixed-focus; and may omit
11192 the minimum focus distance otherwise.<wbr/></p>
11193 <p>This field is also mandatory for all devices advertising
11194 the MANUAL_<wbr/>SENSOR capability.<wbr/></p>
11195             </td>
11196           </tr>
11197
11198           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11199            <!-- end of entry -->
11200
11201
11202           <tr class="entry" id="static_android.lens.info.shadingMapSize">
11203             <td class="entry_name
11204              " rowspan="3">
11205               android.<wbr/>lens.<wbr/>info.<wbr/>shading<wbr/>Map<wbr/>Size
11206             </td>
11207             <td class="entry_type">
11208                 <span class="entry_type_name">int32</span>
11209                 <span class="entry_type_container">x</span>
11210
11211                 <span class="entry_type_array">
11212                   2
11213                 </span>
11214               <span class="entry_type_visibility"> [hidden as size]</span>
11215
11216
11217               <span class="entry_type_hwlevel">[full] </span>
11218
11219
11220                 <div class="entry_type_notes">width and height (N,<wbr/> M) of lens shading map provided by the camera device.<wbr/></div>
11221
11222
11223             </td> <!-- entry_type -->
11224
11225             <td class="entry_description">
11226               <p>Dimensions of lens shading map.<wbr/></p>
11227             </td>
11228
11229             <td class="entry_units">
11230             </td>
11231
11232             <td class="entry_range">
11233               <p>Both values &gt;= 1</p>
11234             </td>
11235
11236             <td class="entry_tags">
11237               <ul class="entry_tags">
11238                   <li><a href="#tag_V1">V1</a></li>
11239               </ul>
11240             </td>
11241
11242           </tr>
11243           <tr class="entries_header">
11244             <th class="th_details" colspan="5">Details</th>
11245           </tr>
11246           <tr class="entry_cont">
11247             <td class="entry_details" colspan="5">
11248               <p>The map should be on the order of 30-40 rows and columns,<wbr/> and
11249 must be smaller than 64x64.<wbr/></p>
11250             </td>
11251           </tr>
11252
11253
11254           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11255            <!-- end of entry -->
11256
11257
11258           <tr class="entry" id="static_android.lens.info.focusDistanceCalibration">
11259             <td class="entry_name
11260              " rowspan="5">
11261               android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration
11262             </td>
11263             <td class="entry_type">
11264                 <span class="entry_type_name entry_type_name_enum">byte</span>
11265
11266               <span class="entry_type_visibility"> [public]</span>
11267
11268
11269               <span class="entry_type_hwlevel">[limited] </span>
11270
11271
11272
11273                 <ul class="entry_type_enum">
11274                   <li>
11275                     <span class="entry_type_enum_name">UNCALIBRATED</span>
11276                     <span class="entry_type_enum_notes"><p>The lens focus distance is not accurate,<wbr/> and the units used for
11277 <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> do not correspond to any physical units.<wbr/></p>
11278 <p>Setting the lens to the same focus distance on separate occasions may
11279 result in a different real focus distance,<wbr/> depending on factors such
11280 as the orientation of the device,<wbr/> the age of the focusing mechanism,<wbr/>
11281 and the device temperature.<wbr/> The focus distance value will still be
11282 in the range of <code>[0,<wbr/> <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a>]</code>,<wbr/> where 0
11283 represents the farthest focus.<wbr/></p></span>
11284                   </li>
11285                   <li>
11286                     <span class="entry_type_enum_name">APPROXIMATE</span>
11287                     <span class="entry_type_enum_notes"><p>The lens focus distance is measured in diopters.<wbr/></p>
11288 <p>However,<wbr/> setting the lens to the same focus distance
11289 on separate occasions may result in a different real
11290 focus distance,<wbr/> depending on factors such as the
11291 orientation of the device,<wbr/> the age of the focusing
11292 mechanism,<wbr/> and the device temperature.<wbr/></p></span>
11293                   </li>
11294                   <li>
11295                     <span class="entry_type_enum_name">CALIBRATED</span>
11296                     <span class="entry_type_enum_notes"><p>The lens focus distance is measured in diopters,<wbr/> and
11297 is calibrated.<wbr/></p>
11298 <p>The lens mechanism is calibrated so that setting the
11299 same focus distance is repeatable on multiple
11300 occasions with good accuracy,<wbr/> and the focus distance
11301 corresponds to the real physical distance to the plane
11302 of best focus.<wbr/></p></span>
11303                   </li>
11304                 </ul>
11305
11306             </td> <!-- entry_type -->
11307
11308             <td class="entry_description">
11309               <p>The lens focus distance calibration quality.<wbr/></p>
11310             </td>
11311
11312             <td class="entry_units">
11313             </td>
11314
11315             <td class="entry_range">
11316             </td>
11317
11318             <td class="entry_tags">
11319               <ul class="entry_tags">
11320                   <li><a href="#tag_V1">V1</a></li>
11321               </ul>
11322             </td>
11323
11324           </tr>
11325           <tr class="entries_header">
11326             <th class="th_details" colspan="5">Details</th>
11327           </tr>
11328           <tr class="entry_cont">
11329             <td class="entry_details" colspan="5">
11330               <p>The lens focus distance calibration quality determines the reliability of
11331 focus related metadata entries,<wbr/> i.<wbr/>e.<wbr/> <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a>,<wbr/>
11332 <a href="#dynamic_android.lens.focusRange">android.<wbr/>lens.<wbr/>focus<wbr/>Range</a>,<wbr/> <a href="#static_android.lens.info.hyperfocalDistance">android.<wbr/>lens.<wbr/>info.<wbr/>hyperfocal<wbr/>Distance</a>,<wbr/> and
11333 <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a>.<wbr/></p>
11334 <p>APPROXIMATE and CALIBRATED devices report the focus metadata in
11335 units of diopters (1/<wbr/>meter),<wbr/> so <code>0.<wbr/>0f</code> represents focusing at infinity,<wbr/>
11336 and increasing positive numbers represent focusing closer and closer
11337 to the camera device.<wbr/> The focus distance control also uses diopters
11338 on these devices.<wbr/></p>
11339 <p>UNCALIBRATED devices do not use units that are directly comparable
11340 to any real physical measurement,<wbr/> but <code>0.<wbr/>0f</code> still represents farthest
11341 focus,<wbr/> and <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> represents the
11342 nearest focus the device can achieve.<wbr/></p>
11343             </td>
11344           </tr>
11345
11346           <tr class="entries_header">
11347             <th class="th_details" colspan="5">HAL Implementation Details</th>
11348           </tr>
11349           <tr class="entry_cont">
11350             <td class="entry_details" colspan="5">
11351               <p>For devices advertise APPROXIMATE quality or higher,<wbr/> diopters 0 (infinity
11352 focus) must work.<wbr/> When autofocus is disabled (<a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> == OFF)
11353 and the lens focus distance is set to 0 diopters
11354 (<a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> == 0),<wbr/> the lens will move to focus at infinity
11355 and is stably focused at infinity even if the device tilts.<wbr/> It may take the
11356 lens some time to move; during the move the lens state should be MOVING and
11357 the output diopter value should be changing toward 0.<wbr/></p>
11358             </td>
11359           </tr>
11360
11361           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11362            <!-- end of entry -->
11363
11364
11365
11366
11367
11368           <tr class="entry" id="static_android.lens.facing">
11369             <td class="entry_name
11370              " rowspan="1">
11371               android.<wbr/>lens.<wbr/>facing
11372             </td>
11373             <td class="entry_type">
11374                 <span class="entry_type_name entry_type_name_enum">byte</span>
11375
11376               <span class="entry_type_visibility"> [public]</span>
11377
11378
11379               <span class="entry_type_hwlevel">[legacy] </span>
11380
11381
11382
11383                 <ul class="entry_type_enum">
11384                   <li>
11385                     <span class="entry_type_enum_name">FRONT</span>
11386                     <span class="entry_type_enum_notes"><p>The camera device faces the same direction as the device's screen.<wbr/></p></span>
11387                   </li>
11388                   <li>
11389                     <span class="entry_type_enum_name">BACK</span>
11390                     <span class="entry_type_enum_notes"><p>The camera device faces the opposite direction as the device's screen.<wbr/></p></span>
11391                   </li>
11392                 </ul>
11393
11394             </td> <!-- entry_type -->
11395
11396             <td class="entry_description">
11397               <p>Direction the camera faces relative to
11398 device screen.<wbr/></p>
11399             </td>
11400
11401             <td class="entry_units">
11402             </td>
11403
11404             <td class="entry_range">
11405             </td>
11406
11407             <td class="entry_tags">
11408             </td>
11409
11410           </tr>
11411
11412
11413           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11414            <!-- end of entry -->
11415
11416
11417           <tr class="entry" id="static_android.lens.opticalAxisAngle">
11418             <td class="entry_name
11419              " rowspan="3">
11420               android.<wbr/>lens.<wbr/>optical<wbr/>Axis<wbr/>Angle
11421             </td>
11422             <td class="entry_type">
11423                 <span class="entry_type_name">float</span>
11424                 <span class="entry_type_container">x</span>
11425
11426                 <span class="entry_type_array">
11427                   2
11428                 </span>
11429               <span class="entry_type_visibility"> [system]</span>
11430
11431
11432
11433
11434                 <div class="entry_type_notes">degrees.<wbr/> First defines the angle of separation between the perpendicular to the screen and the camera optical axis.<wbr/> The second then defines the clockwise rotation of the optical axis from native device up.<wbr/></div>
11435
11436
11437             </td> <!-- entry_type -->
11438
11439             <td class="entry_description">
11440               <p>Relative angle of camera optical axis to the
11441 perpendicular axis from the display</p>
11442             </td>
11443
11444             <td class="entry_units">
11445             </td>
11446
11447             <td class="entry_range">
11448               <p>[0-90) for first angle,<wbr/> [0-360) for second</p>
11449             </td>
11450
11451             <td class="entry_tags">
11452               <ul class="entry_tags">
11453                   <li><a href="#tag_FUTURE">FUTURE</a></li>
11454               </ul>
11455             </td>
11456
11457           </tr>
11458           <tr class="entries_header">
11459             <th class="th_details" colspan="5">Details</th>
11460           </tr>
11461           <tr class="entry_cont">
11462             <td class="entry_details" colspan="5">
11463               <p>Examples:</p>
11464 <p>(0,<wbr/>0) means that the camera optical axis
11465 is perpendicular to the display surface;</p>
11466 <p>(45,<wbr/>0) means that the camera points 45 degrees up when
11467 device is held upright;</p>
11468 <p>(45,<wbr/>90) means the camera points 45 degrees to the right when
11469 the device is held upright.<wbr/></p>
11470 <p>Use FACING field to determine perpendicular outgoing
11471 direction</p>
11472             </td>
11473           </tr>
11474
11475
11476           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11477            <!-- end of entry -->
11478
11479
11480           <tr class="entry" id="static_android.lens.position">
11481             <td class="entry_name
11482              " rowspan="1">
11483               android.<wbr/>lens.<wbr/>position
11484             </td>
11485             <td class="entry_type">
11486                 <span class="entry_type_name">float</span>
11487                 <span class="entry_type_container">x</span>
11488
11489                 <span class="entry_type_array">
11490                   3, location in mm, in the sensor coordinate
11491             system
11492                 </span>
11493               <span class="entry_type_visibility"> [system]</span>
11494
11495
11496
11497
11498
11499
11500             </td> <!-- entry_type -->
11501
11502             <td class="entry_description">
11503               <p>Coordinates of camera optical axis on
11504 device</p>
11505             </td>
11506
11507             <td class="entry_units">
11508             </td>
11509
11510             <td class="entry_range">
11511             </td>
11512
11513             <td class="entry_tags">
11514               <ul class="entry_tags">
11515                   <li><a href="#tag_FUTURE">FUTURE</a></li>
11516               </ul>
11517             </td>
11518
11519           </tr>
11520
11521
11522           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11523            <!-- end of entry -->
11524
11525
11526
11527       <!-- end of kind -->
11528       </tbody>
11529       <tr><td colspan="6" class="kind">dynamic</td></tr>
11530
11531       <thead class="entries_header">
11532         <tr>
11533           <th class="th_name">Property Name</th>
11534           <th class="th_type">Type</th>
11535           <th class="th_description">Description</th>
11536           <th class="th_units">Units</th>
11537           <th class="th_range">Range</th>
11538           <th class="th_tags">Tags</th>
11539         </tr>
11540       </thead>
11541
11542       <tbody>
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553           <tr class="entry" id="dynamic_android.lens.aperture">
11554             <td class="entry_name
11555              " rowspan="3">
11556               android.<wbr/>lens.<wbr/>aperture
11557             </td>
11558             <td class="entry_type">
11559                 <span class="entry_type_name">float</span>
11560
11561               <span class="entry_type_visibility"> [public]</span>
11562
11563
11564               <span class="entry_type_hwlevel">[full] </span>
11565
11566
11567
11568
11569             </td> <!-- entry_type -->
11570
11571             <td class="entry_description">
11572               <p>The desired lens aperture size,<wbr/> as a ratio of lens focal length to the
11573 effective aperture diameter.<wbr/></p>
11574             </td>
11575
11576             <td class="entry_units">
11577               The f-number (f/<wbr/>N)
11578             </td>
11579
11580             <td class="entry_range">
11581               <p><a href="#static_android.lens.info.availableApertures">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Apertures</a></p>
11582             </td>
11583
11584             <td class="entry_tags">
11585               <ul class="entry_tags">
11586                   <li><a href="#tag_V1">V1</a></li>
11587               </ul>
11588             </td>
11589
11590           </tr>
11591           <tr class="entries_header">
11592             <th class="th_details" colspan="5">Details</th>
11593           </tr>
11594           <tr class="entry_cont">
11595             <td class="entry_details" colspan="5">
11596               <p>Setting this value is only supported on the camera devices that have a variable
11597 aperture lens.<wbr/></p>
11598 <p>When this is supported and <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is OFF,<wbr/>
11599 this can be set along with <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
11600 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> and <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>
11601 to achieve manual exposure control.<wbr/></p>
11602 <p>The requested aperture value may take several frames to reach the
11603 requested value; the camera device will report the current (intermediate)
11604 aperture size in capture result metadata while the aperture is changing.<wbr/>
11605 While the aperture is still changing,<wbr/> <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
11606 <p>When this is supported and <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is one of
11607 the ON modes,<wbr/> this will be overridden by the camera device
11608 auto-exposure algorithm,<wbr/> the overridden values are then provided
11609 back to the user in the corresponding result.<wbr/></p>
11610             </td>
11611           </tr>
11612
11613
11614           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11615            <!-- end of entry -->
11616
11617
11618           <tr class="entry" id="dynamic_android.lens.filterDensity">
11619             <td class="entry_name
11620              " rowspan="3">
11621               android.<wbr/>lens.<wbr/>filter<wbr/>Density
11622             </td>
11623             <td class="entry_type">
11624                 <span class="entry_type_name">float</span>
11625
11626               <span class="entry_type_visibility"> [public]</span>
11627
11628
11629               <span class="entry_type_hwlevel">[full] </span>
11630
11631
11632
11633
11634             </td> <!-- entry_type -->
11635
11636             <td class="entry_description">
11637               <p>The desired setting for the lens neutral density filter(s).<wbr/></p>
11638             </td>
11639
11640             <td class="entry_units">
11641               Exposure Value (EV)
11642             </td>
11643
11644             <td class="entry_range">
11645               <p><a href="#static_android.lens.info.availableFilterDensities">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Filter<wbr/>Densities</a></p>
11646             </td>
11647
11648             <td class="entry_tags">
11649               <ul class="entry_tags">
11650                   <li><a href="#tag_V1">V1</a></li>
11651               </ul>
11652             </td>
11653
11654           </tr>
11655           <tr class="entries_header">
11656             <th class="th_details" colspan="5">Details</th>
11657           </tr>
11658           <tr class="entry_cont">
11659             <td class="entry_details" colspan="5">
11660               <p>This control will not be supported on most camera devices.<wbr/></p>
11661 <p>Lens filters are typically used to lower the amount of light the
11662 sensor is exposed to (measured in steps of EV).<wbr/> As used here,<wbr/> an EV
11663 step is the standard logarithmic representation,<wbr/> which are
11664 non-negative,<wbr/> and inversely proportional to the amount of light
11665 hitting the sensor.<wbr/>  For example,<wbr/> setting this to 0 would result
11666 in no reduction of the incoming light,<wbr/> and setting this to 2 would
11667 mean that the filter is set to reduce incoming light by two stops
11668 (allowing 1/<wbr/>4 of the prior amount of light to the sensor).<wbr/></p>
11669 <p>It may take several frames before the lens filter density changes
11670 to the requested value.<wbr/> While the filter density is still changing,<wbr/>
11671 <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
11672             </td>
11673           </tr>
11674
11675
11676           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11677            <!-- end of entry -->
11678
11679
11680           <tr class="entry" id="dynamic_android.lens.focalLength">
11681             <td class="entry_name
11682              " rowspan="3">
11683               android.<wbr/>lens.<wbr/>focal<wbr/>Length
11684             </td>
11685             <td class="entry_type">
11686                 <span class="entry_type_name">float</span>
11687
11688               <span class="entry_type_visibility"> [public]</span>
11689
11690
11691               <span class="entry_type_hwlevel">[legacy] </span>
11692
11693
11694
11695
11696             </td> <!-- entry_type -->
11697
11698             <td class="entry_description">
11699               <p>The desired lens focal length; used for optical zoom.<wbr/></p>
11700             </td>
11701
11702             <td class="entry_units">
11703               Millimeters
11704             </td>
11705
11706             <td class="entry_range">
11707               <p><a href="#static_android.lens.info.availableFocalLengths">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Focal<wbr/>Lengths</a></p>
11708             </td>
11709
11710             <td class="entry_tags">
11711               <ul class="entry_tags">
11712                   <li><a href="#tag_BC">BC</a></li>
11713               </ul>
11714             </td>
11715
11716           </tr>
11717           <tr class="entries_header">
11718             <th class="th_details" colspan="5">Details</th>
11719           </tr>
11720           <tr class="entry_cont">
11721             <td class="entry_details" colspan="5">
11722               <p>This setting controls the physical focal length of the camera
11723 device's lens.<wbr/> Changing the focal length changes the field of
11724 view of the camera device,<wbr/> and is usually used for optical zoom.<wbr/></p>
11725 <p>Like <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> and <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a>,<wbr/> this
11726 setting won't be applied instantaneously,<wbr/> and it may take several
11727 frames before the lens can change to the requested focal length.<wbr/>
11728 While the focal length is still changing,<wbr/> <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will
11729 be set to MOVING.<wbr/></p>
11730 <p>Optical zoom will not be supported on most devices.<wbr/></p>
11731             </td>
11732           </tr>
11733
11734
11735           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11736            <!-- end of entry -->
11737
11738
11739           <tr class="entry" id="dynamic_android.lens.focusDistance">
11740             <td class="entry_name
11741              " rowspan="3">
11742               android.<wbr/>lens.<wbr/>focus<wbr/>Distance
11743             </td>
11744             <td class="entry_type">
11745                 <span class="entry_type_name">float</span>
11746
11747               <span class="entry_type_visibility"> [public]</span>
11748
11749
11750               <span class="entry_type_hwlevel">[full] </span>
11751
11752
11753
11754
11755             </td> <!-- entry_type -->
11756
11757             <td class="entry_description">
11758               <p>Desired distance to plane of sharpest focus,<wbr/>
11759 measured from frontmost surface of the lens.<wbr/></p>
11760             </td>
11761
11762             <td class="entry_units">
11763               See android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details
11764             </td>
11765
11766             <td class="entry_range">
11767               <p>&gt;= 0</p>
11768             </td>
11769
11770             <td class="entry_tags">
11771               <ul class="entry_tags">
11772                   <li><a href="#tag_BC">BC</a></li>
11773               </ul>
11774             </td>
11775
11776           </tr>
11777           <tr class="entries_header">
11778             <th class="th_details" colspan="5">Details</th>
11779           </tr>
11780           <tr class="entry_cont">
11781             <td class="entry_details" colspan="5">
11782               <p>Should be zero for fixed-focus cameras</p>
11783             </td>
11784           </tr>
11785
11786
11787           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11788            <!-- end of entry -->
11789
11790
11791           <tr class="entry" id="dynamic_android.lens.focusRange">
11792             <td class="entry_name
11793              " rowspan="3">
11794               android.<wbr/>lens.<wbr/>focus<wbr/>Range
11795             </td>
11796             <td class="entry_type">
11797                 <span class="entry_type_name">float</span>
11798                 <span class="entry_type_container">x</span>
11799
11800                 <span class="entry_type_array">
11801                   2
11802                 </span>
11803               <span class="entry_type_visibility"> [public as pairFloatFloat]</span>
11804
11805
11806               <span class="entry_type_hwlevel">[limited] </span>
11807
11808
11809                 <div class="entry_type_notes">Range of scene distances that are in focus</div>
11810
11811
11812             </td> <!-- entry_type -->
11813
11814             <td class="entry_description">
11815               <p>The range of scene distances that are in
11816 sharp focus (depth of field).<wbr/></p>
11817             </td>
11818
11819             <td class="entry_units">
11820               A pair of focus distances in diopters: (near,<wbr/>
11821           far); see android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details.<wbr/>
11822             </td>
11823
11824             <td class="entry_range">
11825               <p>&gt;=0</p>
11826             </td>
11827
11828             <td class="entry_tags">
11829               <ul class="entry_tags">
11830                   <li><a href="#tag_BC">BC</a></li>
11831               </ul>
11832             </td>
11833
11834           </tr>
11835           <tr class="entries_header">
11836             <th class="th_details" colspan="5">Details</th>
11837           </tr>
11838           <tr class="entry_cont">
11839             <td class="entry_details" colspan="5">
11840               <p>If variable focus not supported,<wbr/> can still report
11841 fixed depth of field range</p>
11842             </td>
11843           </tr>
11844
11845
11846           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11847            <!-- end of entry -->
11848
11849
11850           <tr class="entry" id="dynamic_android.lens.opticalStabilizationMode">
11851             <td class="entry_name
11852              " rowspan="3">
11853               android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode
11854             </td>
11855             <td class="entry_type">
11856                 <span class="entry_type_name entry_type_name_enum">byte</span>
11857
11858               <span class="entry_type_visibility"> [public]</span>
11859
11860
11861               <span class="entry_type_hwlevel">[limited] </span>
11862
11863
11864
11865                 <ul class="entry_type_enum">
11866                   <li>
11867                     <span class="entry_type_enum_name">OFF</span>
11868                     <span class="entry_type_enum_notes"><p>Optical stabilization is unavailable.<wbr/></p></span>
11869                   </li>
11870                   <li>
11871                     <span class="entry_type_enum_name">ON</span>
11872                     <span class="entry_type_enum_optional">[optional]</span>
11873                     <span class="entry_type_enum_notes"><p>Optical stabilization is enabled.<wbr/></p></span>
11874                   </li>
11875                 </ul>
11876
11877             </td> <!-- entry_type -->
11878
11879             <td class="entry_description">
11880               <p>Sets whether the camera device uses optical image stabilization (OIS)
11881 when capturing images.<wbr/></p>
11882             </td>
11883
11884             <td class="entry_units">
11885             </td>
11886
11887             <td class="entry_range">
11888               <p><a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a></p>
11889             </td>
11890
11891             <td class="entry_tags">
11892               <ul class="entry_tags">
11893                   <li><a href="#tag_V1">V1</a></li>
11894               </ul>
11895             </td>
11896
11897           </tr>
11898           <tr class="entries_header">
11899             <th class="th_details" colspan="5">Details</th>
11900           </tr>
11901           <tr class="entry_cont">
11902             <td class="entry_details" colspan="5">
11903               <p>OIS is used to compensate for motion blur due to small
11904 movements of the camera during capture.<wbr/> Unlike digital image
11905 stabilization (<a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> OIS
11906 makes use of mechanical elements to stabilize the camera
11907 sensor,<wbr/> and thus allows for longer exposure times before
11908 camera shake becomes apparent.<wbr/></p>
11909 <p>Switching between different optical stabilization modes may take several
11910 frames to initialize,<wbr/> the camera device will report the current mode in
11911 capture result metadata.<wbr/> For example,<wbr/> When "ON" mode is requested,<wbr/> the
11912 optical stabilization modes in the first several capture results may still
11913 be "OFF",<wbr/> and it will become "ON" when the initialization is done.<wbr/></p>
11914 <p>If a camera device supports both OIS and digital image stabilization
11915 (<a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> turning both modes on may produce undesirable
11916 interaction,<wbr/> so it is recommended not to enable both at the same time.<wbr/></p>
11917 <p>Not all devices will support OIS; see
11918 <a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a> for
11919 available controls.<wbr/></p>
11920             </td>
11921           </tr>
11922
11923
11924           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11925            <!-- end of entry -->
11926
11927
11928           <tr class="entry" id="dynamic_android.lens.state">
11929             <td class="entry_name
11930              " rowspan="3">
11931               android.<wbr/>lens.<wbr/>state
11932             </td>
11933             <td class="entry_type">
11934                 <span class="entry_type_name entry_type_name_enum">byte</span>
11935
11936               <span class="entry_type_visibility"> [public]</span>
11937
11938
11939               <span class="entry_type_hwlevel">[limited] </span>
11940
11941
11942
11943                 <ul class="entry_type_enum">
11944                   <li>
11945                     <span class="entry_type_enum_name">STATIONARY</span>
11946                     <span class="entry_type_enum_notes"><p>The lens parameters (<a href="#controls_android.lens.focalLength">android.<wbr/>lens.<wbr/>focal<wbr/>Length</a>,<wbr/> <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a>,<wbr/>
11947 <a href="#controls_android.lens.filterDensity">android.<wbr/>lens.<wbr/>filter<wbr/>Density</a> and <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a>) are not changing.<wbr/></p></span>
11948                   </li>
11949                   <li>
11950                     <span class="entry_type_enum_name">MOVING</span>
11951                     <span class="entry_type_enum_notes"><p>One or several of the lens parameters
11952 (<a href="#controls_android.lens.focalLength">android.<wbr/>lens.<wbr/>focal<wbr/>Length</a>,<wbr/> <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a>,<wbr/>
11953 <a href="#controls_android.lens.filterDensity">android.<wbr/>lens.<wbr/>filter<wbr/>Density</a> or <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a>) is
11954 currently changing.<wbr/></p></span>
11955                   </li>
11956                 </ul>
11957
11958             </td> <!-- entry_type -->
11959
11960             <td class="entry_description">
11961               <p>Current lens status.<wbr/></p>
11962             </td>
11963
11964             <td class="entry_units">
11965             </td>
11966
11967             <td class="entry_range">
11968             </td>
11969
11970             <td class="entry_tags">
11971               <ul class="entry_tags">
11972                   <li><a href="#tag_V1">V1</a></li>
11973               </ul>
11974             </td>
11975
11976           </tr>
11977           <tr class="entries_header">
11978             <th class="th_details" colspan="5">Details</th>
11979           </tr>
11980           <tr class="entry_cont">
11981             <td class="entry_details" colspan="5">
11982               <p>For lens parameters <a href="#controls_android.lens.focalLength">android.<wbr/>lens.<wbr/>focal<wbr/>Length</a>,<wbr/> <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a>,<wbr/>
11983 <a href="#controls_android.lens.filterDensity">android.<wbr/>lens.<wbr/>filter<wbr/>Density</a> and <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a>,<wbr/> when changes are requested,<wbr/>
11984 they may take several frames to reach the requested values.<wbr/> This state indicates
11985 the current status of the lens parameters.<wbr/></p>
11986 <p>When the state is STATIONARY,<wbr/> the lens parameters are not changing.<wbr/> This could be
11987 either because the parameters are all fixed,<wbr/> or because the lens has had enough
11988 time to reach the most recently-requested values.<wbr/>
11989 If all these lens parameters are not changable for a camera device,<wbr/> as listed below:</p>
11990 <ul>
11991 <li>Fixed focus (<code><a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> == 0</code>),<wbr/> which means
11992 <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> parameter will always be 0.<wbr/></li>
11993 <li>Fixed focal length (<a href="#static_android.lens.info.availableFocalLengths">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Focal<wbr/>Lengths</a> contains single value),<wbr/>
11994 which means the optical zoom is not supported.<wbr/></li>
11995 <li>No ND filter (<a href="#static_android.lens.info.availableFilterDensities">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Filter<wbr/>Densities</a> contains only 0).<wbr/></li>
11996 <li>Fixed aperture (<a href="#static_android.lens.info.availableApertures">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Apertures</a> contains single value).<wbr/></li>
11997 </ul>
11998 <p>Then this state will always be STATIONARY.<wbr/></p>
11999 <p>When the state is MOVING,<wbr/> it indicates that at least one of the lens parameters
12000 is changing.<wbr/></p>
12001             </td>
12002           </tr>
12003
12004
12005           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12006            <!-- end of entry -->
12007
12008
12009
12010       <!-- end of kind -->
12011       </tbody>
12012
12013   <!-- end of section -->
12014   <tr><td colspan="6" id="section_noiseReduction" class="section">noiseReduction</td></tr>
12015
12016
12017       <tr><td colspan="6" class="kind">controls</td></tr>
12018
12019       <thead class="entries_header">
12020         <tr>
12021           <th class="th_name">Property Name</th>
12022           <th class="th_type">Type</th>
12023           <th class="th_description">Description</th>
12024           <th class="th_units">Units</th>
12025           <th class="th_range">Range</th>
12026           <th class="th_tags">Tags</th>
12027         </tr>
12028       </thead>
12029
12030       <tbody>
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041           <tr class="entry" id="controls_android.noiseReduction.mode">
12042             <td class="entry_name
12043              " rowspan="3">
12044               android.<wbr/>noise<wbr/>Reduction.<wbr/>mode
12045             </td>
12046             <td class="entry_type">
12047                 <span class="entry_type_name entry_type_name_enum">byte</span>
12048
12049               <span class="entry_type_visibility"> [public]</span>
12050
12051
12052               <span class="entry_type_hwlevel">[full] </span>
12053
12054
12055
12056                 <ul class="entry_type_enum">
12057                   <li>
12058                     <span class="entry_type_enum_name">OFF</span>
12059                     <span class="entry_type_enum_notes"><p>No noise reduction is applied.<wbr/></p></span>
12060                   </li>
12061                   <li>
12062                     <span class="entry_type_enum_name">FAST</span>
12063                     <span class="entry_type_enum_notes"><p>Noise reduction is applied without reducing frame rate relative to sensor
12064 output.<wbr/></p></span>
12065                   </li>
12066                   <li>
12067                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
12068                     <span class="entry_type_enum_notes"><p>High-quality noise reduction is applied,<wbr/> at the cost of reducing frame rate
12069 relative to sensor output.<wbr/></p></span>
12070                   </li>
12071                 </ul>
12072
12073             </td> <!-- entry_type -->
12074
12075             <td class="entry_description">
12076               <p>Mode of operation for the noise reduction algorithm.<wbr/></p>
12077             </td>
12078
12079             <td class="entry_units">
12080             </td>
12081
12082             <td class="entry_range">
12083               <p><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes</a></p>
12084             </td>
12085
12086             <td class="entry_tags">
12087               <ul class="entry_tags">
12088                   <li><a href="#tag_V1">V1</a></li>
12089               </ul>
12090             </td>
12091
12092           </tr>
12093           <tr class="entries_header">
12094             <th class="th_details" colspan="5">Details</th>
12095           </tr>
12096           <tr class="entry_cont">
12097             <td class="entry_details" colspan="5">
12098               <p>The noise reduction algorithm attempts to improve image quality by removing
12099 excessive noise added by the capture process,<wbr/> especially in dark conditions.<wbr/>
12100 OFF means no noise reduction will be applied by the camera device.<wbr/></p>
12101 <p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean camera device determined noise filtering
12102 will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the camera device
12103 will use the highest-quality noise filtering algorithms,<wbr/>
12104 even if it slows down capture rate.<wbr/> FAST means the camera device will not
12105 slow down capture rate when applying noise filtering.<wbr/></p>
12106             </td>
12107           </tr>
12108
12109
12110           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12111            <!-- end of entry -->
12112
12113
12114           <tr class="entry" id="controls_android.noiseReduction.strength">
12115             <td class="entry_name
12116              " rowspan="1">
12117               android.<wbr/>noise<wbr/>Reduction.<wbr/>strength
12118             </td>
12119             <td class="entry_type">
12120                 <span class="entry_type_name">byte</span>
12121
12122               <span class="entry_type_visibility"> [system]</span>
12123
12124
12125
12126
12127
12128
12129             </td> <!-- entry_type -->
12130
12131             <td class="entry_description">
12132               <p>Control the amount of noise reduction
12133 applied to the images</p>
12134             </td>
12135
12136             <td class="entry_units">
12137               1-10; 10 is max noise reduction
12138             </td>
12139
12140             <td class="entry_range">
12141               <p>1 - 10</p>
12142             </td>
12143
12144             <td class="entry_tags">
12145               <ul class="entry_tags">
12146                   <li><a href="#tag_FUTURE">FUTURE</a></li>
12147               </ul>
12148             </td>
12149
12150           </tr>
12151
12152
12153           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12154            <!-- end of entry -->
12155
12156
12157
12158       <!-- end of kind -->
12159       </tbody>
12160       <tr><td colspan="6" class="kind">static</td></tr>
12161
12162       <thead class="entries_header">
12163         <tr>
12164           <th class="th_name">Property Name</th>
12165           <th class="th_type">Type</th>
12166           <th class="th_description">Description</th>
12167           <th class="th_units">Units</th>
12168           <th class="th_range">Range</th>
12169           <th class="th_tags">Tags</th>
12170         </tr>
12171       </thead>
12172
12173       <tbody>
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184           <tr class="entry" id="static_android.noiseReduction.availableNoiseReductionModes">
12185             <td class="entry_name
12186              " rowspan="3">
12187               android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes
12188             </td>
12189             <td class="entry_type">
12190                 <span class="entry_type_name">byte</span>
12191                 <span class="entry_type_container">x</span>
12192
12193                 <span class="entry_type_array">
12194                   n
12195                 </span>
12196               <span class="entry_type_visibility"> [public as enumList]</span>
12197
12198
12199               <span class="entry_type_hwlevel">[limited] </span>
12200
12201
12202                 <div class="entry_type_notes">list of enums</div>
12203
12204
12205             </td> <!-- entry_type -->
12206
12207             <td class="entry_description">
12208               <p>List of noise reduction modes for <a href="#controls_android.noiseReduction.mode">android.<wbr/>noise<wbr/>Reduction.<wbr/>mode</a> that are supported
12209 by this camera device.<wbr/></p>
12210             </td>
12211
12212             <td class="entry_units">
12213             </td>
12214
12215             <td class="entry_range">
12216               <p>Any value listed in <a href="#controls_android.noiseReduction.mode">android.<wbr/>noise<wbr/>Reduction.<wbr/>mode</a></p>
12217             </td>
12218
12219             <td class="entry_tags">
12220               <ul class="entry_tags">
12221                   <li><a href="#tag_V1">V1</a></li>
12222               </ul>
12223             </td>
12224
12225           </tr>
12226           <tr class="entries_header">
12227             <th class="th_details" colspan="5">Details</th>
12228           </tr>
12229           <tr class="entry_cont">
12230             <td class="entry_details" colspan="5">
12231               <p>Full-capability camera devices will always support OFF and FAST.<wbr/></p>
12232 <p>Legacy-capability camera devices will only support FAST mode.<wbr/></p>
12233             </td>
12234           </tr>
12235
12236
12237           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12238            <!-- end of entry -->
12239
12240
12241
12242       <!-- end of kind -->
12243       </tbody>
12244       <tr><td colspan="6" class="kind">dynamic</td></tr>
12245
12246       <thead class="entries_header">
12247         <tr>
12248           <th class="th_name">Property Name</th>
12249           <th class="th_type">Type</th>
12250           <th class="th_description">Description</th>
12251           <th class="th_units">Units</th>
12252           <th class="th_range">Range</th>
12253           <th class="th_tags">Tags</th>
12254         </tr>
12255       </thead>
12256
12257       <tbody>
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268           <tr class="entry" id="dynamic_android.noiseReduction.mode">
12269             <td class="entry_name
12270              " rowspan="3">
12271               android.<wbr/>noise<wbr/>Reduction.<wbr/>mode
12272             </td>
12273             <td class="entry_type">
12274                 <span class="entry_type_name entry_type_name_enum">byte</span>
12275
12276               <span class="entry_type_visibility"> [public]</span>
12277
12278
12279               <span class="entry_type_hwlevel">[full] </span>
12280
12281
12282
12283                 <ul class="entry_type_enum">
12284                   <li>
12285                     <span class="entry_type_enum_name">OFF</span>
12286                     <span class="entry_type_enum_notes"><p>No noise reduction is applied.<wbr/></p></span>
12287                   </li>
12288                   <li>
12289                     <span class="entry_type_enum_name">FAST</span>
12290                     <span class="entry_type_enum_notes"><p>Noise reduction is applied without reducing frame rate relative to sensor
12291 output.<wbr/></p></span>
12292                   </li>
12293                   <li>
12294                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
12295                     <span class="entry_type_enum_notes"><p>High-quality noise reduction is applied,<wbr/> at the cost of reducing frame rate
12296 relative to sensor output.<wbr/></p></span>
12297                   </li>
12298                 </ul>
12299
12300             </td> <!-- entry_type -->
12301
12302             <td class="entry_description">
12303               <p>Mode of operation for the noise reduction algorithm.<wbr/></p>
12304             </td>
12305
12306             <td class="entry_units">
12307             </td>
12308
12309             <td class="entry_range">
12310               <p><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes</a></p>
12311             </td>
12312
12313             <td class="entry_tags">
12314               <ul class="entry_tags">
12315                   <li><a href="#tag_V1">V1</a></li>
12316               </ul>
12317             </td>
12318
12319           </tr>
12320           <tr class="entries_header">
12321             <th class="th_details" colspan="5">Details</th>
12322           </tr>
12323           <tr class="entry_cont">
12324             <td class="entry_details" colspan="5">
12325               <p>The noise reduction algorithm attempts to improve image quality by removing
12326 excessive noise added by the capture process,<wbr/> especially in dark conditions.<wbr/>
12327 OFF means no noise reduction will be applied by the camera device.<wbr/></p>
12328 <p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean camera device determined noise filtering
12329 will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the camera device
12330 will use the highest-quality noise filtering algorithms,<wbr/>
12331 even if it slows down capture rate.<wbr/> FAST means the camera device will not
12332 slow down capture rate when applying noise filtering.<wbr/></p>
12333             </td>
12334           </tr>
12335
12336
12337           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12338            <!-- end of entry -->
12339
12340
12341
12342       <!-- end of kind -->
12343       </tbody>
12344
12345   <!-- end of section -->
12346   <tr><td colspan="6" id="section_quirks" class="section">quirks</td></tr>
12347
12348
12349       <tr><td colspan="6" class="kind">static</td></tr>
12350
12351       <thead class="entries_header">
12352         <tr>
12353           <th class="th_name">Property Name</th>
12354           <th class="th_type">Type</th>
12355           <th class="th_description">Description</th>
12356           <th class="th_units">Units</th>
12357           <th class="th_range">Range</th>
12358           <th class="th_tags">Tags</th>
12359         </tr>
12360       </thead>
12361
12362       <tbody>
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373           <tr class="entry" id="static_android.quirks.meteringCropRegion">
12374             <td class="entry_name
12375                 entry_name_deprecated
12376              " rowspan="3">
12377               android.<wbr/>quirks.<wbr/>metering<wbr/>Crop<wbr/>Region
12378             </td>
12379             <td class="entry_type">
12380                 <span class="entry_type_name">byte</span>
12381
12382               <span class="entry_type_visibility"> [system]</span>
12383
12384
12385
12386               <span class="entry_type_deprecated">[deprecated] </span>
12387
12388
12389
12390             </td> <!-- entry_type -->
12391
12392             <td class="entry_description">
12393               <p>If set to 1,<wbr/> the camera service does not
12394 scale 'normalized' coordinates with respect to the crop
12395 region.<wbr/> This applies to metering input (a{e,<wbr/>f,<wbr/>wb}Region
12396 and output (face rectangles).<wbr/></p>
12397             </td>
12398
12399             <td class="entry_units">
12400             </td>
12401
12402             <td class="entry_range">
12403               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
12404             </td>
12405
12406             <td class="entry_tags">
12407             </td>
12408
12409           </tr>
12410           <tr class="entries_header">
12411             <th class="th_details" colspan="5">Details</th>
12412           </tr>
12413           <tr class="entry_cont">
12414             <td class="entry_details" colspan="5">
12415               <p>Normalized coordinates refer to those in the
12416 (-1000,<wbr/>1000) range mentioned in the
12417 android.<wbr/>hardware.<wbr/>Camera API.<wbr/></p>
12418 <p>HAL implementations should instead always use and emit
12419 sensor array-relative coordinates for all region data.<wbr/> Does
12420 not need to be listed in static metadata.<wbr/> Support will be
12421 removed in future versions of camera service.<wbr/></p>
12422             </td>
12423           </tr>
12424
12425
12426           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12427            <!-- end of entry -->
12428
12429
12430           <tr class="entry" id="static_android.quirks.triggerAfWithAuto">
12431             <td class="entry_name
12432                 entry_name_deprecated
12433              " rowspan="3">
12434               android.<wbr/>quirks.<wbr/>trigger<wbr/>Af<wbr/>With<wbr/>Auto
12435             </td>
12436             <td class="entry_type">
12437                 <span class="entry_type_name">byte</span>
12438
12439               <span class="entry_type_visibility"> [system]</span>
12440
12441
12442
12443               <span class="entry_type_deprecated">[deprecated] </span>
12444
12445
12446
12447             </td> <!-- entry_type -->
12448
12449             <td class="entry_description">
12450               <p>If set to 1,<wbr/> then the camera service always
12451 switches to FOCUS_<wbr/>MODE_<wbr/>AUTO before issuing a AF
12452 trigger.<wbr/></p>
12453             </td>
12454
12455             <td class="entry_units">
12456             </td>
12457
12458             <td class="entry_range">
12459               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
12460             </td>
12461
12462             <td class="entry_tags">
12463             </td>
12464
12465           </tr>
12466           <tr class="entries_header">
12467             <th class="th_details" colspan="5">Details</th>
12468           </tr>
12469           <tr class="entry_cont">
12470             <td class="entry_details" colspan="5">
12471               <p>HAL implementations should implement AF trigger
12472 modes for AUTO,<wbr/> MACRO,<wbr/> CONTINUOUS_<wbr/>FOCUS,<wbr/> and
12473 CONTINUOUS_<wbr/>PICTURE modes instead of using this flag.<wbr/> Does
12474 not need to be listed in static metadata.<wbr/> Support will be
12475 removed in future versions of camera service</p>
12476             </td>
12477           </tr>
12478
12479
12480           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12481            <!-- end of entry -->
12482
12483
12484           <tr class="entry" id="static_android.quirks.useZslFormat">
12485             <td class="entry_name
12486                 entry_name_deprecated
12487              " rowspan="3">
12488               android.<wbr/>quirks.<wbr/>use<wbr/>Zsl<wbr/>Format
12489             </td>
12490             <td class="entry_type">
12491                 <span class="entry_type_name">byte</span>
12492
12493               <span class="entry_type_visibility"> [system]</span>
12494
12495
12496
12497               <span class="entry_type_deprecated">[deprecated] </span>
12498
12499
12500
12501             </td> <!-- entry_type -->
12502
12503             <td class="entry_description">
12504               <p>If set to 1,<wbr/> the camera service uses
12505 CAMERA2_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>ZSL instead of
12506 HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>IMPLEMENTATION_<wbr/>DEFINED for the zero
12507 shutter lag stream</p>
12508             </td>
12509
12510             <td class="entry_units">
12511             </td>
12512
12513             <td class="entry_range">
12514               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
12515             </td>
12516
12517             <td class="entry_tags">
12518             </td>
12519
12520           </tr>
12521           <tr class="entries_header">
12522             <th class="th_details" colspan="5">Details</th>
12523           </tr>
12524           <tr class="entry_cont">
12525             <td class="entry_details" colspan="5">
12526               <p>HAL implementations should use gralloc usage flags
12527 to determine that a stream will be used for
12528 zero-shutter-lag,<wbr/> instead of relying on an explicit
12529 format setting.<wbr/> Does not need to be listed in static
12530 metadata.<wbr/> Support will be removed in future versions of
12531 camera service.<wbr/></p>
12532             </td>
12533           </tr>
12534
12535
12536           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12537            <!-- end of entry -->
12538
12539
12540           <tr class="entry" id="static_android.quirks.usePartialResult">
12541             <td class="entry_name
12542                 entry_name_deprecated
12543              " rowspan="5">
12544               android.<wbr/>quirks.<wbr/>use<wbr/>Partial<wbr/>Result
12545             </td>
12546             <td class="entry_type">
12547                 <span class="entry_type_name">byte</span>
12548
12549               <span class="entry_type_visibility"> [hidden]</span>
12550
12551
12552
12553               <span class="entry_type_deprecated">[deprecated] </span>
12554
12555
12556
12557             </td> <!-- entry_type -->
12558
12559             <td class="entry_description">
12560               <p>If set to 1,<wbr/> the HAL will always split result
12561 metadata for a single capture into multiple buffers,<wbr/>
12562 returned using multiple process_<wbr/>capture_<wbr/>result calls.<wbr/></p>
12563             </td>
12564
12565             <td class="entry_units">
12566             </td>
12567
12568             <td class="entry_range">
12569               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
12570             </td>
12571
12572             <td class="entry_tags">
12573             </td>
12574
12575           </tr>
12576           <tr class="entries_header">
12577             <th class="th_details" colspan="5">Details</th>
12578           </tr>
12579           <tr class="entry_cont">
12580             <td class="entry_details" colspan="5">
12581               <p>Does not need to be listed in static
12582 metadata.<wbr/> Support for partial results will be reworked in
12583 future versions of camera service.<wbr/> This quirk will stop
12584 working at that point; DO NOT USE without careful
12585 consideration of future support.<wbr/></p>
12586             </td>
12587           </tr>
12588
12589           <tr class="entries_header">
12590             <th class="th_details" colspan="5">HAL Implementation Details</th>
12591           </tr>
12592           <tr class="entry_cont">
12593             <td class="entry_details" colspan="5">
12594               <p>Refer to <code>camera3_<wbr/>capture_<wbr/>result::partial_<wbr/>result</code>
12595 for information on how to implement partial results.<wbr/></p>
12596             </td>
12597           </tr>
12598
12599           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12600            <!-- end of entry -->
12601
12602
12603
12604       <!-- end of kind -->
12605       </tbody>
12606       <tr><td colspan="6" class="kind">dynamic</td></tr>
12607
12608       <thead class="entries_header">
12609         <tr>
12610           <th class="th_name">Property Name</th>
12611           <th class="th_type">Type</th>
12612           <th class="th_description">Description</th>
12613           <th class="th_units">Units</th>
12614           <th class="th_range">Range</th>
12615           <th class="th_tags">Tags</th>
12616         </tr>
12617       </thead>
12618
12619       <tbody>
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630           <tr class="entry" id="dynamic_android.quirks.partialResult">
12631             <td class="entry_name
12632                 entry_name_deprecated
12633              " rowspan="5">
12634               android.<wbr/>quirks.<wbr/>partial<wbr/>Result
12635             </td>
12636             <td class="entry_type">
12637                 <span class="entry_type_name entry_type_name_enum">byte</span>
12638
12639               <span class="entry_type_visibility"> [hidden as boolean]</span>
12640
12641
12642
12643               <span class="entry_type_deprecated">[deprecated] </span>
12644
12645
12646                 <ul class="entry_type_enum">
12647                   <li>
12648                     <span class="entry_type_enum_name">FINAL</span>
12649                     <span class="entry_type_enum_notes"><p>The last or only metadata result buffer
12650 for this capture.<wbr/></p></span>
12651                   </li>
12652                   <li>
12653                     <span class="entry_type_enum_name">PARTIAL</span>
12654                     <span class="entry_type_enum_notes"><p>A partial buffer of result metadata for this
12655 capture.<wbr/> More result buffers for this capture will be sent
12656 by the camera device,<wbr/> the last of which will be marked
12657 FINAL.<wbr/></p></span>
12658                   </li>
12659                 </ul>
12660
12661             </td> <!-- entry_type -->
12662
12663             <td class="entry_description">
12664               <p>Whether a result given to the framework is the
12665 final one for the capture,<wbr/> or only a partial that contains a
12666 subset of the full set of dynamic metadata
12667 values.<wbr/></p>
12668             </td>
12669
12670             <td class="entry_units">
12671             </td>
12672
12673             <td class="entry_range">
12674               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
12675               <p>Optional.<wbr/> Default value is FINAL.<wbr/></p>
12676             </td>
12677
12678             <td class="entry_tags">
12679             </td>
12680
12681           </tr>
12682           <tr class="entries_header">
12683             <th class="th_details" colspan="5">Details</th>
12684           </tr>
12685           <tr class="entry_cont">
12686             <td class="entry_details" colspan="5">
12687               <p>The entries in the result metadata buffers for a
12688 single capture may not overlap,<wbr/> except for this entry.<wbr/> The
12689 FINAL buffers must retain FIFO ordering relative to the
12690 requests that generate them,<wbr/> so the FINAL buffer for frame 3 must
12691 always be sent to the framework after the FINAL buffer for frame 2,<wbr/> and
12692 before the FINAL buffer for frame 4.<wbr/> PARTIAL buffers may be returned
12693 in any order relative to other frames,<wbr/> but all PARTIAL buffers for a given
12694 capture must arrive before the FINAL buffer for that capture.<wbr/> This entry may
12695 only be used by the camera device if quirks.<wbr/>usePartialResult is set to 1.<wbr/></p>
12696             </td>
12697           </tr>
12698
12699           <tr class="entries_header">
12700             <th class="th_details" colspan="5">HAL Implementation Details</th>
12701           </tr>
12702           <tr class="entry_cont">
12703             <td class="entry_details" colspan="5">
12704               <p>Refer to <code>camera3_<wbr/>capture_<wbr/>result::partial_<wbr/>result</code>
12705 for information on how to implement partial results.<wbr/></p>
12706             </td>
12707           </tr>
12708
12709           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12710            <!-- end of entry -->
12711
12712
12713
12714       <!-- end of kind -->
12715       </tbody>
12716
12717   <!-- end of section -->
12718   <tr><td colspan="6" id="section_request" class="section">request</td></tr>
12719
12720
12721       <tr><td colspan="6" class="kind">controls</td></tr>
12722
12723       <thead class="entries_header">
12724         <tr>
12725           <th class="th_name">Property Name</th>
12726           <th class="th_type">Type</th>
12727           <th class="th_description">Description</th>
12728           <th class="th_units">Units</th>
12729           <th class="th_range">Range</th>
12730           <th class="th_tags">Tags</th>
12731         </tr>
12732       </thead>
12733
12734       <tbody>
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745           <tr class="entry" id="controls_android.request.frameCount">
12746             <td class="entry_name
12747                 entry_name_deprecated
12748              " rowspan="1">
12749               android.<wbr/>request.<wbr/>frame<wbr/>Count
12750             </td>
12751             <td class="entry_type">
12752                 <span class="entry_type_name">int32</span>
12753
12754               <span class="entry_type_visibility"> [system]</span>
12755
12756
12757
12758               <span class="entry_type_deprecated">[deprecated] </span>
12759
12760
12761
12762             </td> <!-- entry_type -->
12763
12764             <td class="entry_description">
12765               <p>A frame counter set by the framework.<wbr/> Must
12766 be maintained unchanged in output frame.<wbr/> This value monotonically
12767 increases with every new result (that is,<wbr/> each new result has a unique
12768 frameCount value).<wbr/></p>
12769             </td>
12770
12771             <td class="entry_units">
12772               incrementing integer
12773             </td>
12774
12775             <td class="entry_range">
12776               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
12777               <p>Any int.<wbr/></p>
12778             </td>
12779
12780             <td class="entry_tags">
12781             </td>
12782
12783           </tr>
12784
12785
12786           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12787            <!-- end of entry -->
12788
12789
12790           <tr class="entry" id="controls_android.request.id">
12791             <td class="entry_name
12792              " rowspan="1">
12793               android.<wbr/>request.<wbr/>id
12794             </td>
12795             <td class="entry_type">
12796                 <span class="entry_type_name">int32</span>
12797
12798               <span class="entry_type_visibility"> [hidden]</span>
12799
12800
12801
12802
12803
12804
12805             </td> <!-- entry_type -->
12806
12807             <td class="entry_description">
12808               <p>An application-specified ID for the current
12809 request.<wbr/> Must be maintained unchanged in output
12810 frame</p>
12811             </td>
12812
12813             <td class="entry_units">
12814               arbitrary integer assigned by application
12815             </td>
12816
12817             <td class="entry_range">
12818               <p>Any int</p>
12819             </td>
12820
12821             <td class="entry_tags">
12822               <ul class="entry_tags">
12823                   <li><a href="#tag_V1">V1</a></li>
12824               </ul>
12825             </td>
12826
12827           </tr>
12828
12829
12830           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12831            <!-- end of entry -->
12832
12833
12834           <tr class="entry" id="controls_android.request.inputStreams">
12835             <td class="entry_name
12836                 entry_name_deprecated
12837              " rowspan="3">
12838               android.<wbr/>request.<wbr/>input<wbr/>Streams
12839             </td>
12840             <td class="entry_type">
12841                 <span class="entry_type_name">int32</span>
12842                 <span class="entry_type_container">x</span>
12843
12844                 <span class="entry_type_array">
12845                   n
12846                 </span>
12847               <span class="entry_type_visibility"> [system]</span>
12848
12849
12850
12851               <span class="entry_type_deprecated">[deprecated] </span>
12852
12853
12854
12855             </td> <!-- entry_type -->
12856
12857             <td class="entry_description">
12858               <p>List which camera reprocess stream is used
12859 for the source of reprocessing data.<wbr/></p>
12860             </td>
12861
12862             <td class="entry_units">
12863               List of camera reprocess stream IDs
12864             </td>
12865
12866             <td class="entry_range">
12867               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
12868               <p>Typically,<wbr/> only one entry allowed,<wbr/> must be a valid reprocess stream ID.<wbr/></p>
12869             </td>
12870
12871             <td class="entry_tags">
12872               <ul class="entry_tags">
12873                   <li><a href="#tag_HAL2">HAL2</a></li>
12874               </ul>
12875             </td>
12876
12877           </tr>
12878           <tr class="entries_header">
12879             <th class="th_details" colspan="5">Details</th>
12880           </tr>
12881           <tr class="entry_cont">
12882             <td class="entry_details" colspan="5">
12883               <p>Only meaningful when <a href="#controls_android.request.type">android.<wbr/>request.<wbr/>type</a> ==
12884 REPROCESS.<wbr/> Ignored otherwise</p>
12885             </td>
12886           </tr>
12887
12888
12889           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12890            <!-- end of entry -->
12891
12892
12893           <tr class="entry" id="controls_android.request.metadataMode">
12894             <td class="entry_name
12895              " rowspan="1">
12896               android.<wbr/>request.<wbr/>metadata<wbr/>Mode
12897             </td>
12898             <td class="entry_type">
12899                 <span class="entry_type_name entry_type_name_enum">byte</span>
12900
12901               <span class="entry_type_visibility"> [system]</span>
12902
12903
12904
12905
12906
12907                 <ul class="entry_type_enum">
12908                   <li>
12909                     <span class="entry_type_enum_name">NONE</span>
12910                     <span class="entry_type_enum_notes"><p>No metadata should be produced on output,<wbr/> except
12911 for application-bound buffer data.<wbr/> If no
12912 application-bound streams exist,<wbr/> no frame should be
12913 placed in the output frame queue.<wbr/> If such streams
12914 exist,<wbr/> a frame should be placed on the output queue
12915 with null metadata but with the necessary output buffer
12916 information.<wbr/> Timestamp information should still be
12917 included with any output stream buffers</p></span>
12918                   </li>
12919                   <li>
12920                     <span class="entry_type_enum_name">FULL</span>
12921                     <span class="entry_type_enum_notes"><p>All metadata should be produced.<wbr/> Statistics will
12922 only be produced if they are separately
12923 enabled</p></span>
12924                   </li>
12925                 </ul>
12926
12927             </td> <!-- entry_type -->
12928
12929             <td class="entry_description">
12930               <p>How much metadata to produce on
12931 output</p>
12932             </td>
12933
12934             <td class="entry_units">
12935             </td>
12936
12937             <td class="entry_range">
12938             </td>
12939
12940             <td class="entry_tags">
12941               <ul class="entry_tags">
12942                   <li><a href="#tag_FUTURE">FUTURE</a></li>
12943               </ul>
12944             </td>
12945
12946           </tr>
12947
12948
12949           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12950            <!-- end of entry -->
12951
12952
12953           <tr class="entry" id="controls_android.request.outputStreams">
12954             <td class="entry_name
12955                 entry_name_deprecated
12956              " rowspan="3">
12957               android.<wbr/>request.<wbr/>output<wbr/>Streams
12958             </td>
12959             <td class="entry_type">
12960                 <span class="entry_type_name">int32</span>
12961                 <span class="entry_type_container">x</span>
12962
12963                 <span class="entry_type_array">
12964                   n
12965                 </span>
12966               <span class="entry_type_visibility"> [system]</span>
12967
12968
12969
12970               <span class="entry_type_deprecated">[deprecated] </span>
12971
12972
12973
12974             </td> <!-- entry_type -->
12975
12976             <td class="entry_description">
12977               <p>Lists which camera output streams image data
12978 from this capture must be sent to</p>
12979             </td>
12980
12981             <td class="entry_units">
12982               List of camera stream IDs
12983             </td>
12984
12985             <td class="entry_range">
12986               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
12987               <p>List must only include streams that have been
12988 created</p>
12989             </td>
12990
12991             <td class="entry_tags">
12992               <ul class="entry_tags">
12993                   <li><a href="#tag_HAL2">HAL2</a></li>
12994               </ul>
12995             </td>
12996
12997           </tr>
12998           <tr class="entries_header">
12999             <th class="th_details" colspan="5">Details</th>
13000           </tr>
13001           <tr class="entry_cont">
13002             <td class="entry_details" colspan="5">
13003               <p>If no output streams are listed,<wbr/> then the image
13004 data should simply be discarded.<wbr/> The image data must
13005 still be captured for metadata and statistics production,<wbr/>
13006 and the lens and flash must operate as requested.<wbr/></p>
13007             </td>
13008           </tr>
13009
13010
13011           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13012            <!-- end of entry -->
13013
13014
13015           <tr class="entry" id="controls_android.request.type">
13016             <td class="entry_name
13017                 entry_name_deprecated
13018              " rowspan="1">
13019               android.<wbr/>request.<wbr/>type
13020             </td>
13021             <td class="entry_type">
13022                 <span class="entry_type_name entry_type_name_enum">byte</span>
13023
13024               <span class="entry_type_visibility"> [system]</span>
13025
13026
13027
13028               <span class="entry_type_deprecated">[deprecated] </span>
13029
13030
13031                 <ul class="entry_type_enum">
13032                   <li>
13033                     <span class="entry_type_enum_name">CAPTURE</span>
13034                     <span class="entry_type_enum_notes"><p>Capture a new image from the imaging hardware,<wbr/>
13035 and process it according to the
13036 settings</p></span>
13037                   </li>
13038                   <li>
13039                     <span class="entry_type_enum_name">REPROCESS</span>
13040                     <span class="entry_type_enum_notes"><p>Process previously captured data; the
13041 <a href="#controls_android.request.inputStreams">android.<wbr/>request.<wbr/>input<wbr/>Streams</a> parameter determines the
13042 source reprocessing stream.<wbr/> TODO: Mark dynamic metadata
13043 needed for reprocessing with [RP]</p></span>
13044                   </li>
13045                 </ul>
13046
13047             </td> <!-- entry_type -->
13048
13049             <td class="entry_description">
13050               <p>The type of the request; either CAPTURE or
13051 REPROCESS.<wbr/> For HAL3,<wbr/> this tag is redundant.<wbr/></p>
13052             </td>
13053
13054             <td class="entry_units">
13055             </td>
13056
13057             <td class="entry_range">
13058               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
13059             </td>
13060
13061             <td class="entry_tags">
13062               <ul class="entry_tags">
13063                   <li><a href="#tag_HAL2">HAL2</a></li>
13064               </ul>
13065             </td>
13066
13067           </tr>
13068
13069
13070           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13071            <!-- end of entry -->
13072
13073
13074
13075       <!-- end of kind -->
13076       </tbody>
13077       <tr><td colspan="6" class="kind">static</td></tr>
13078
13079       <thead class="entries_header">
13080         <tr>
13081           <th class="th_name">Property Name</th>
13082           <th class="th_type">Type</th>
13083           <th class="th_description">Description</th>
13084           <th class="th_units">Units</th>
13085           <th class="th_range">Range</th>
13086           <th class="th_tags">Tags</th>
13087         </tr>
13088       </thead>
13089
13090       <tbody>
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101           <tr class="entry" id="static_android.request.maxNumOutputStreams">
13102             <td class="entry_name
13103              " rowspan="3">
13104               android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams
13105             </td>
13106             <td class="entry_type">
13107                 <span class="entry_type_name">int32</span>
13108                 <span class="entry_type_container">x</span>
13109
13110                 <span class="entry_type_array">
13111                   3
13112                 </span>
13113               <span class="entry_type_visibility"> [hidden]</span>
13114
13115
13116               <span class="entry_type_hwlevel">[legacy] </span>
13117
13118
13119
13120
13121             </td> <!-- entry_type -->
13122
13123             <td class="entry_description">
13124               <p>The maximum numbers of different types of output streams
13125 that can be configured and used simultaneously by a camera device.<wbr/></p>
13126             </td>
13127
13128             <td class="entry_units">
13129             </td>
13130
13131             <td class="entry_range">
13132               <p>For processed (and stalling) format streams,<wbr/> &gt;= 1.<wbr/></p>
13133 <p>For Raw format (either stalling or non-stalling) streams,<wbr/> &gt;= 0.<wbr/></p>
13134 <p>For processed (but not stalling) format streams,<wbr/> &gt;= 3
13135 for FULL mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL</code>);
13136 &gt;= 2 for LIMITED mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == LIMITED</code>).<wbr/></p>
13137             </td>
13138
13139             <td class="entry_tags">
13140               <ul class="entry_tags">
13141                   <li><a href="#tag_BC">BC</a></li>
13142               </ul>
13143             </td>
13144
13145           </tr>
13146           <tr class="entries_header">
13147             <th class="th_details" colspan="5">Details</th>
13148           </tr>
13149           <tr class="entry_cont">
13150             <td class="entry_details" colspan="5">
13151               <p>This is a 3 element tuple that contains the max number of output simultaneous
13152 streams for raw sensor,<wbr/> processed (but not stalling),<wbr/> and processed (and stalling)
13153 formats respectively.<wbr/> For example,<wbr/> assuming that JPEG is typically a processed and
13154 stalling stream,<wbr/> if max raw sensor format output stream number is 1,<wbr/> max YUV streams
13155 number is 3,<wbr/> and max JPEG stream number is 2,<wbr/> then this tuple should be <code>(1,<wbr/> 3,<wbr/> 2)</code>.<wbr/></p>
13156 <p>This lists the upper bound of the number of output streams supported by
13157 the camera device.<wbr/> Using more streams simultaneously may require more hardware and
13158 CPU resources that will consume more power.<wbr/> The image format for an output stream can
13159 be any supported format provided by <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a>.<wbr/>
13160 The formats defined in <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a> can be catergorized
13161 into the 3 stream types as below:</p>
13162 <ul>
13163 <li>Processed (but stalling): any non-RAW format with a stallDurations &gt; 0.<wbr/>
13164 Typically JPEG format (ImageFormat#JPEG).<wbr/></li>
13165 <li>Raw formats: ImageFormat#RAW_<wbr/>SENSOR,<wbr/> ImageFormat#RAW10 and ImageFormat#RAW_<wbr/>OPAQUE.<wbr/></li>
13166 <li>Processed (but not-stalling): any non-RAW format without a stall duration.<wbr/>
13167 Typically Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888,<wbr/> ImageFormat#NV21,<wbr/> ImageFormat#YV12.<wbr/></li>
13168 </ul>
13169             </td>
13170           </tr>
13171
13172
13173           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13174            <!-- end of entry -->
13175
13176
13177           <tr class="entry" id="static_android.request.maxNumOutputRaw">
13178             <td class="entry_name
13179              " rowspan="3">
13180               android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Raw
13181             </td>
13182             <td class="entry_type">
13183                 <span class="entry_type_name">int32</span>
13184
13185               <span class="entry_type_visibility"> [public]</span>
13186
13187               <span class="entry_type_synthetic">[synthetic] </span>
13188
13189               <span class="entry_type_hwlevel">[legacy] </span>
13190
13191
13192
13193
13194             </td> <!-- entry_type -->
13195
13196             <td class="entry_description">
13197               <p>The maximum numbers of different types of output streams
13198 that can be configured and used simultaneously by a camera device
13199 for any <code>RAW</code> formats.<wbr/></p>
13200             </td>
13201
13202             <td class="entry_units">
13203             </td>
13204
13205             <td class="entry_range">
13206               <p>&gt;= 0</p>
13207             </td>
13208
13209             <td class="entry_tags">
13210             </td>
13211
13212           </tr>
13213           <tr class="entries_header">
13214             <th class="th_details" colspan="5">Details</th>
13215           </tr>
13216           <tr class="entry_cont">
13217             <td class="entry_details" colspan="5">
13218               <p>This value contains the max number of output simultaneous
13219 streams from the raw sensor.<wbr/></p>
13220 <p>This lists the upper bound of the number of output streams supported by
13221 the camera device.<wbr/> Using more streams simultaneously may require more hardware and
13222 CPU resources that will consume more power.<wbr/> The image format for this kind of an output stream can
13223 be any <code>RAW</code> and supported format provided by <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/></p>
13224 <p>In particular,<wbr/> a <code>RAW</code> format is typically one of:</p>
13225 <ul>
13226 <li>ImageFormat#RAW_<wbr/>SENSOR</li>
13227 <li>ImageFormat#RAW10</li>
13228 <li>Opaque <code>RAW</code></li>
13229 </ul>
13230 <p>LEGACY mode devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> <code>==</code> LEGACY)
13231 never support raw streams.<wbr/></p>
13232             </td>
13233           </tr>
13234
13235
13236           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13237            <!-- end of entry -->
13238
13239
13240           <tr class="entry" id="static_android.request.maxNumOutputProc">
13241             <td class="entry_name
13242              " rowspan="3">
13243               android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Proc
13244             </td>
13245             <td class="entry_type">
13246                 <span class="entry_type_name">int32</span>
13247
13248               <span class="entry_type_visibility"> [public]</span>
13249
13250               <span class="entry_type_synthetic">[synthetic] </span>
13251
13252               <span class="entry_type_hwlevel">[legacy] </span>
13253
13254
13255
13256
13257             </td> <!-- entry_type -->
13258
13259             <td class="entry_description">
13260               <p>The maximum numbers of different types of output streams
13261 that can be configured and used simultaneously by a camera device
13262 for any processed (but not-stalling) formats.<wbr/></p>
13263             </td>
13264
13265             <td class="entry_units">
13266             </td>
13267
13268             <td class="entry_range">
13269               <p>&gt;= 3
13270 for FULL mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL</code>);
13271 &gt;= 2 for LIMITED mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == LIMITED</code>).<wbr/></p>
13272             </td>
13273
13274             <td class="entry_tags">
13275             </td>
13276
13277           </tr>
13278           <tr class="entries_header">
13279             <th class="th_details" colspan="5">Details</th>
13280           </tr>
13281           <tr class="entry_cont">
13282             <td class="entry_details" colspan="5">
13283               <p>This value contains the max number of output simultaneous
13284 streams for any processed (but not-stalling) formats.<wbr/></p>
13285 <p>This lists the upper bound of the number of output streams supported by
13286 the camera device.<wbr/> Using more streams simultaneously may require more hardware and
13287 CPU resources that will consume more power.<wbr/> The image format for this kind of an output stream can
13288 be any non-<code>RAW</code> and supported format provided by <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/></p>
13289 <p>Processed (but not-stalling) is defined as any non-RAW format without a stall duration.<wbr/>
13290 Typically:</p>
13291 <ul>
13292 <li>Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</li>
13293 <li>ImageFormat#NV21</li>
13294 <li>ImageFormat#YV12</li>
13295 <li>Implementation-defined formats,<wbr/> i.<wbr/>e.<wbr/> StreamConfiguration#isOutputSupportedFor(Class)</li>
13296 </ul>
13297 <p>For full guarantees,<wbr/> query StreamConfigurationMap#getOutputStallDuration with
13298 a processed format -- it will return 0 for a non-stalling stream.<wbr/></p>
13299 <p>LEGACY devices will support at least 2 processing/<wbr/>non-stalling streams.<wbr/></p>
13300             </td>
13301           </tr>
13302
13303
13304           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13305            <!-- end of entry -->
13306
13307
13308           <tr class="entry" id="static_android.request.maxNumOutputProcStalling">
13309             <td class="entry_name
13310              " rowspan="3">
13311               android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Proc<wbr/>Stalling
13312             </td>
13313             <td class="entry_type">
13314                 <span class="entry_type_name">int32</span>
13315
13316               <span class="entry_type_visibility"> [public]</span>
13317
13318               <span class="entry_type_synthetic">[synthetic] </span>
13319
13320               <span class="entry_type_hwlevel">[legacy] </span>
13321
13322
13323
13324
13325             </td> <!-- entry_type -->
13326
13327             <td class="entry_description">
13328               <p>The maximum numbers of different types of output streams
13329 that can be configured and used simultaneously by a camera device
13330 for any processed (and stalling) formats.<wbr/></p>
13331             </td>
13332
13333             <td class="entry_units">
13334             </td>
13335
13336             <td class="entry_range">
13337               <p>&gt;= 1</p>
13338             </td>
13339
13340             <td class="entry_tags">
13341             </td>
13342
13343           </tr>
13344           <tr class="entries_header">
13345             <th class="th_details" colspan="5">Details</th>
13346           </tr>
13347           <tr class="entry_cont">
13348             <td class="entry_details" colspan="5">
13349               <p>This value contains the max number of output simultaneous
13350 streams for any processed (but not-stalling) formats.<wbr/></p>
13351 <p>This lists the upper bound of the number of output streams supported by
13352 the camera device.<wbr/> Using more streams simultaneously may require more hardware and
13353 CPU resources that will consume more power.<wbr/> The image format for this kind of an output stream can
13354 be any non-<code>RAW</code> and supported format provided by <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/></p>
13355 <p>A processed and stalling format is defined as any non-RAW format with a stallDurations &gt; 0.<wbr/>
13356 Typically only the <code>JPEG</code> format (ImageFormat#JPEG) is a stalling format.<wbr/></p>
13357 <p>For full guarantees,<wbr/> query StreamConfigurationMap#getOutputStallDuration with
13358 a processed format -- it will return a non-0 value for a stalling stream.<wbr/></p>
13359 <p>LEGACY devices will support up to 1 processing/<wbr/>stalling stream.<wbr/></p>
13360             </td>
13361           </tr>
13362
13363
13364           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13365            <!-- end of entry -->
13366
13367
13368           <tr class="entry" id="static_android.request.maxNumReprocessStreams">
13369             <td class="entry_name
13370                 entry_name_deprecated
13371              " rowspan="3">
13372               android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Reprocess<wbr/>Streams
13373             </td>
13374             <td class="entry_type">
13375                 <span class="entry_type_name">int32</span>
13376                 <span class="entry_type_container">x</span>
13377
13378                 <span class="entry_type_array">
13379                   1
13380                 </span>
13381               <span class="entry_type_visibility"> [system]</span>
13382
13383
13384
13385               <span class="entry_type_deprecated">[deprecated] </span>
13386
13387
13388
13389             </td> <!-- entry_type -->
13390
13391             <td class="entry_description">
13392               <p>How many reprocessing streams of any type
13393 can be allocated at the same time.<wbr/></p>
13394             </td>
13395
13396             <td class="entry_units">
13397             </td>
13398
13399             <td class="entry_range">
13400               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
13401               <p>&gt;= 0</p>
13402             </td>
13403
13404             <td class="entry_tags">
13405               <ul class="entry_tags">
13406                   <li><a href="#tag_HAL2">HAL2</a></li>
13407               </ul>
13408             </td>
13409
13410           </tr>
13411           <tr class="entries_header">
13412             <th class="th_details" colspan="5">Details</th>
13413           </tr>
13414           <tr class="entry_cont">
13415             <td class="entry_details" colspan="5">
13416               <p>Only used by HAL2.<wbr/>x.<wbr/></p>
13417 <p>When set to 0,<wbr/> it means no reprocess stream is supported.<wbr/></p>
13418             </td>
13419           </tr>
13420
13421
13422           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13423            <!-- end of entry -->
13424
13425
13426           <tr class="entry" id="static_android.request.maxNumInputStreams">
13427             <td class="entry_name
13428              " rowspan="3">
13429               android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Input<wbr/>Streams
13430             </td>
13431             <td class="entry_type">
13432                 <span class="entry_type_name">int32</span>
13433
13434               <span class="entry_type_visibility"> [hidden]</span>
13435
13436
13437               <span class="entry_type_hwlevel">[full] </span>
13438
13439
13440
13441
13442             </td> <!-- entry_type -->
13443
13444             <td class="entry_description">
13445               <p>The maximum numbers of any type of input streams
13446 that can be configured and used simultaneously by a camera device.<wbr/></p>
13447             </td>
13448
13449             <td class="entry_units">
13450             </td>
13451
13452             <td class="entry_range">
13453               <p>0 or 1.<wbr/></p>
13454             </td>
13455
13456             <td class="entry_tags">
13457             </td>
13458
13459           </tr>
13460           <tr class="entries_header">
13461             <th class="th_details" colspan="5">Details</th>
13462           </tr>
13463           <tr class="entry_cont">
13464             <td class="entry_details" colspan="5">
13465               <p>When set to 0,<wbr/> it means no input stream is supported.<wbr/></p>
13466 <p>The image format for a input stream can be any supported
13467 format provided by
13468 <a href="#static_android.scaler.availableInputOutputFormatsMap">android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map</a>.<wbr/> When using an
13469 input stream,<wbr/> there must be at least one output stream
13470 configured to to receive the reprocessed images.<wbr/></p>
13471 <p>For example,<wbr/> for Zero Shutter Lag (ZSL) still capture use case,<wbr/> the input
13472 stream image format will be RAW_<wbr/>OPAQUE,<wbr/> the associated output stream image format
13473 should be JPEG.<wbr/></p>
13474             </td>
13475           </tr>
13476
13477
13478           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13479            <!-- end of entry -->
13480
13481
13482           <tr class="entry" id="static_android.request.pipelineMaxDepth">
13483             <td class="entry_name
13484              " rowspan="5">
13485               android.<wbr/>request.<wbr/>pipeline<wbr/>Max<wbr/>Depth
13486             </td>
13487             <td class="entry_type">
13488                 <span class="entry_type_name">byte</span>
13489
13490               <span class="entry_type_visibility"> [public]</span>
13491
13492
13493               <span class="entry_type_hwlevel">[legacy] </span>
13494
13495
13496
13497
13498             </td> <!-- entry_type -->
13499
13500             <td class="entry_description">
13501               <p>Specifies the number of maximum pipeline stages a frame
13502 has to go through from when it's exposed to when it's available
13503 to the framework.<wbr/></p>
13504             </td>
13505
13506             <td class="entry_units">
13507             </td>
13508
13509             <td class="entry_range">
13510             </td>
13511
13512             <td class="entry_tags">
13513             </td>
13514
13515           </tr>
13516           <tr class="entries_header">
13517             <th class="th_details" colspan="5">Details</th>
13518           </tr>
13519           <tr class="entry_cont">
13520             <td class="entry_details" colspan="5">
13521               <p>A typical minimum value for this is 2 (one stage to expose,<wbr/>
13522 one stage to readout) from the sensor.<wbr/> The ISP then usually adds
13523 its own stages to do custom HW processing.<wbr/> Further stages may be
13524 added by SW processing.<wbr/></p>
13525 <p>Depending on what settings are used (e.<wbr/>g.<wbr/> YUV,<wbr/> JPEG) and what
13526 processing is enabled (e.<wbr/>g.<wbr/> face detection),<wbr/> the actual pipeline
13527 depth (specified by <a href="#dynamic_android.request.pipelineDepth">android.<wbr/>request.<wbr/>pipeline<wbr/>Depth</a>) may be less than
13528 the max pipeline depth.<wbr/></p>
13529 <p>A pipeline depth of X stages is equivalent to a pipeline latency of
13530 X frame intervals.<wbr/></p>
13531 <p>This value will be 8 or less.<wbr/></p>
13532             </td>
13533           </tr>
13534
13535           <tr class="entries_header">
13536             <th class="th_details" colspan="5">HAL Implementation Details</th>
13537           </tr>
13538           <tr class="entry_cont">
13539             <td class="entry_details" colspan="5">
13540               <p>This value should be 4 or less.<wbr/></p>
13541             </td>
13542           </tr>
13543
13544           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13545            <!-- end of entry -->
13546
13547
13548           <tr class="entry" id="static_android.request.partialResultCount">
13549             <td class="entry_name
13550              " rowspan="3">
13551               android.<wbr/>request.<wbr/>partial<wbr/>Result<wbr/>Count
13552             </td>
13553             <td class="entry_type">
13554                 <span class="entry_type_name">int32</span>
13555
13556               <span class="entry_type_visibility"> [public]</span>
13557
13558
13559
13560
13561
13562
13563             </td> <!-- entry_type -->
13564
13565             <td class="entry_description">
13566               <p>Defines how many sub-components
13567 a result will be composed of.<wbr/></p>
13568             </td>
13569
13570             <td class="entry_units">
13571             </td>
13572
13573             <td class="entry_range">
13574               <p>&gt;= 1</p>
13575             </td>
13576
13577             <td class="entry_tags">
13578             </td>
13579
13580           </tr>
13581           <tr class="entries_header">
13582             <th class="th_details" colspan="5">Details</th>
13583           </tr>
13584           <tr class="entry_cont">
13585             <td class="entry_details" colspan="5">
13586               <p>In order to combat the pipeline latency,<wbr/> partial results
13587 may be delivered to the application layer from the camera device as
13588 soon as they are available.<wbr/></p>
13589 <p>Optional; defaults to 1.<wbr/> A value of 1 means that partial
13590 results are not supported,<wbr/> and only the final TotalCaptureResult will
13591 be produced by the camera device.<wbr/></p>
13592 <p>A typical use case for this might be: after requesting an
13593 auto-focus (AF) lock the new AF state might be available 50%
13594 of the way through the pipeline.<wbr/>  The camera device could
13595 then immediately dispatch this state via a partial result to
13596 the application,<wbr/> and the rest of the metadata via later
13597 partial results.<wbr/></p>
13598             </td>
13599           </tr>
13600
13601
13602           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13603            <!-- end of entry -->
13604
13605
13606           <tr class="entry" id="static_android.request.availableCapabilities">
13607             <td class="entry_name
13608              " rowspan="5">
13609               android.<wbr/>request.<wbr/>available<wbr/>Capabilities
13610             </td>
13611             <td class="entry_type">
13612                 <span class="entry_type_name entry_type_name_enum">byte</span>
13613                 <span class="entry_type_container">x</span>
13614
13615                 <span class="entry_type_array">
13616                   n
13617                 </span>
13618               <span class="entry_type_visibility"> [public]</span>
13619
13620
13621               <span class="entry_type_hwlevel">[legacy] </span>
13622
13623
13624
13625                 <ul class="entry_type_enum">
13626                   <li>
13627                     <span class="entry_type_enum_name">BACKWARD_COMPATIBLE</span>
13628                     <span class="entry_type_enum_notes"><p>The minimal set of capabilities that every camera
13629 device (regardless of <a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a>)
13630 supports.<wbr/></p>
13631 <p>This capability is listed by all devices,<wbr/> and
13632 indicates that the camera device has a feature set
13633 that's comparable to the baseline requirements for the
13634 older android.<wbr/>hardware.<wbr/>Camera API.<wbr/></p></span>
13635                   </li>
13636                   <li>
13637                     <span class="entry_type_enum_name">MANUAL_SENSOR</span>
13638                     <span class="entry_type_enum_optional">[optional]</span>
13639                     <span class="entry_type_enum_notes"><p>The camera device can be manually controlled (3A algorithms such
13640 as auto-exposure,<wbr/> and auto-focus can be bypassed).<wbr/>
13641 The camera device supports basic manual control of the sensor image
13642 acquisition related stages.<wbr/> This means the following controls are
13643 guaranteed to be supported:</p>
13644 <ul>
13645 <li>Manual frame duration control<ul>
13646 <li><a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a></li>
13647 <li><a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a></li>
13648 </ul>
13649 </li>
13650 <li>Manual exposure control<ul>
13651 <li><a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a></li>
13652 <li><a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a></li>
13653 </ul>
13654 </li>
13655 <li>Manual sensitivity control<ul>
13656 <li><a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a></li>
13657 <li><a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a></li>
13658 </ul>
13659 </li>
13660 <li>Manual lens control (if the lens is adjustable)<ul>
13661 <li>android.<wbr/>lens.<wbr/>*</li>
13662 </ul>
13663 </li>
13664 <li>Manual flash control (if a flash unit is present)<ul>
13665 <li>android.<wbr/>flash.<wbr/>*</li>
13666 </ul>
13667 </li>
13668 <li>Manual black level locking<ul>
13669 <li><a href="#controls_android.blackLevel.lock">android.<wbr/>black<wbr/>Level.<wbr/>lock</a></li>
13670 </ul>
13671 </li>
13672 </ul>
13673 <p>If any of the above 3A algorithms are enabled,<wbr/> then the camera
13674 device will accurately report the values applied by 3A in the
13675 result.<wbr/></p>
13676 <p>A given camera device may also support additional manual sensor controls,<wbr/>
13677 but this capability only covers the above list of controls.<wbr/></p>
13678 <p>If this is supported,<wbr/> <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> will
13679 additionally return a min frame duration that is greater than
13680 zero for each supported size-format combination.<wbr/></p></span>
13681                   </li>
13682                   <li>
13683                     <span class="entry_type_enum_name">MANUAL_POST_PROCESSING</span>
13684                     <span class="entry_type_enum_optional">[optional]</span>
13685                     <span class="entry_type_enum_notes"><p>The camera device post-processing stages can be manually controlled.<wbr/>
13686 The camera device supports basic manual control of the image post-processing
13687 stages.<wbr/> This means the following controls are guaranteed to be supported:</p>
13688 <ul>
13689 <li>Manual tonemap control<ul>
13690 <li><a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a></li>
13691 <li><a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a></li>
13692 <li><a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></li>
13693 </ul>
13694 </li>
13695 <li>Manual white balance control<ul>
13696 <li><a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a></li>
13697 <li><a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a></li>
13698 </ul>
13699 </li>
13700 <li>Manual lens shading map control<ul>
13701 <li><a href="#controls_android.shading.mode">android.<wbr/>shading.<wbr/>mode</a></li>
13702 <li><a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a></li>
13703 <li><a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a></li>
13704 <li><a href="#static_android.lens.info.shadingMapSize">android.<wbr/>lens.<wbr/>info.<wbr/>shading<wbr/>Map<wbr/>Size</a></li>
13705 </ul>
13706 </li>
13707 <li>Manual aberration correction control (if aberration correction is supported)<ul>
13708 <li><a href="#controls_android.colorCorrection.aberrationMode">android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode</a></li>
13709 <li><a href="#static_android.colorCorrection.availableAberrationModes">android.<wbr/>color<wbr/>Correction.<wbr/>available<wbr/>Aberration<wbr/>Modes</a></li>
13710 </ul>
13711 </li>
13712 </ul>
13713 <p>If auto white balance is enabled,<wbr/> then the camera device
13714 will accurately report the values applied by AWB in the result.<wbr/></p>
13715 <p>A given camera device may also support additional post-processing
13716 controls,<wbr/> but this capability only covers the above list of controls.<wbr/></p></span>
13717                   </li>
13718                   <li>
13719                     <span class="entry_type_enum_name">RAW</span>
13720                     <span class="entry_type_enum_optional">[optional]</span>
13721                     <span class="entry_type_enum_notes"><p>The camera device supports outputting RAW buffers and
13722 metadata for interpreting them.<wbr/></p>
13723 <p>Devices supporting the RAW capability allow both for
13724 saving DNG files,<wbr/> and for direct application processing of
13725 raw sensor images.<wbr/></p>
13726 <ul>
13727 <li>RAW_<wbr/>SENSOR is supported as an output format.<wbr/></li>
13728 <li>The maximum available resolution for RAW_<wbr/>SENSOR streams
13729   will match either the value in
13730   <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a> or
13731   <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></li>
13732 <li>All DNG-related optional metadata entries are provided
13733   by the camera device.<wbr/></li>
13734 </ul></span>
13735                   </li>
13736                   <li>
13737                     <span class="entry_type_enum_name">ZSL</span>
13738                     <span class="entry_type_enum_optional">[optional]</span>
13739                     <span class="entry_type_enum_optional">[hidden]</span>
13740                     <span class="entry_type_enum_notes"><p>The camera device supports the Zero Shutter Lag use case.<wbr/></p>
13741 <ul>
13742 <li>At least one input stream can be used.<wbr/></li>
13743 <li>RAW_<wbr/>OPAQUE is supported as an output/<wbr/>input format</li>
13744 <li>Using RAW_<wbr/>OPAQUE does not cause a frame rate drop
13745   relative to the sensor's maximum capture rate (at that
13746   resolution).<wbr/></li>
13747 <li>RAW_<wbr/>OPAQUE will be reprocessable into both YUV_<wbr/>420_<wbr/>888
13748   and JPEG formats.<wbr/></li>
13749 <li>The maximum available resolution for RAW_<wbr/>OPAQUE streams
13750   (both input/<wbr/>output) will match the maximum available
13751   resolution of JPEG streams.<wbr/></li>
13752 </ul></span>
13753                   </li>
13754                 </ul>
13755
13756             </td> <!-- entry_type -->
13757
13758             <td class="entry_description">
13759               <p>List of capabilities that this camera device
13760 advertises as fully supporting.<wbr/></p>
13761             </td>
13762
13763             <td class="entry_units">
13764             </td>
13765
13766             <td class="entry_range">
13767             </td>
13768
13769             <td class="entry_tags">
13770             </td>
13771
13772           </tr>
13773           <tr class="entries_header">
13774             <th class="th_details" colspan="5">Details</th>
13775           </tr>
13776           <tr class="entry_cont">
13777             <td class="entry_details" colspan="5">
13778               <p>A capability is a contract that the camera device makes in order
13779 to be able to satisfy one or more use cases.<wbr/></p>
13780 <p>Listing a capability guarantees that the whole set of features
13781 required to support a common use will all be available.<wbr/></p>
13782 <p>Using a subset of the functionality provided by an unsupported
13783 capability may be possible on a specific camera device implementation;
13784 to do this query each of <a href="#static_android.request.availableRequestKeys">android.<wbr/>request.<wbr/>available<wbr/>Request<wbr/>Keys</a>,<wbr/>
13785 <a href="#static_android.request.availableResultKeys">android.<wbr/>request.<wbr/>available<wbr/>Result<wbr/>Keys</a>,<wbr/>
13786 <a href="#static_android.request.availableCharacteristicsKeys">android.<wbr/>request.<wbr/>available<wbr/>Characteristics<wbr/>Keys</a>.<wbr/></p>
13787 <p>The following capabilities are guaranteed to be available on
13788 <a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> <code>==</code> FULL devices:</p>
13789 <ul>
13790 <li>MANUAL_<wbr/>SENSOR</li>
13791 <li>MANUAL_<wbr/>POST_<wbr/>PROCESSING</li>
13792 </ul>
13793 <p>Other capabilities may be available on either FULL or LIMITED
13794 devices,<wbr/> but the application should query this key to be sure.<wbr/></p>
13795             </td>
13796           </tr>
13797
13798           <tr class="entries_header">
13799             <th class="th_details" colspan="5">HAL Implementation Details</th>
13800           </tr>
13801           <tr class="entry_cont">
13802             <td class="entry_details" colspan="5">
13803               <p>Additional constraint details per-capability will be available
13804 in the Compatibility Test Suite.<wbr/></p>
13805 <p>Minimum baseline requirements required for the
13806 BACKWARD_<wbr/>COMPATIBLE capability are not explicitly listed.<wbr/>
13807 Instead refer to "BC" tags and the camera CTS tests in the
13808 android.<wbr/>hardware.<wbr/>camera2.<wbr/>cts package.<wbr/></p>
13809 <p>Listed controls that can be either request or result (e.<wbr/>g.<wbr/>
13810 <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>) must be available both in the
13811 request and the result in order to be considered to be
13812 capability-compliant.<wbr/></p>
13813 <p>For example,<wbr/> if the HAL claims to support MANUAL control,<wbr/>
13814 then exposure time must be configurable via the request <em>and</em>
13815 the actual exposure applied must be available via
13816 the result.<wbr/></p>
13817 <p>If MANUAL_<wbr/>SENSOR is omitted,<wbr/> the HAL may choose to omit the
13818 <a href="#static_android.scaler.availableMinFrameDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Min<wbr/>Frame<wbr/>Durations</a> static property entirely.<wbr/></p>
13819             </td>
13820           </tr>
13821
13822           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13823            <!-- end of entry -->
13824
13825
13826           <tr class="entry" id="static_android.request.availableRequestKeys">
13827             <td class="entry_name
13828              " rowspan="5">
13829               android.<wbr/>request.<wbr/>available<wbr/>Request<wbr/>Keys
13830             </td>
13831             <td class="entry_type">
13832                 <span class="entry_type_name">int32</span>
13833                 <span class="entry_type_container">x</span>
13834
13835                 <span class="entry_type_array">
13836                   n
13837                 </span>
13838               <span class="entry_type_visibility"> [hidden]</span>
13839
13840
13841               <span class="entry_type_hwlevel">[legacy] </span>
13842
13843
13844
13845
13846             </td> <!-- entry_type -->
13847
13848             <td class="entry_description">
13849               <p>A list of all keys that the camera device has available
13850 to use with CaptureRequest.<wbr/></p>
13851             </td>
13852
13853             <td class="entry_units">
13854             </td>
13855
13856             <td class="entry_range">
13857             </td>
13858
13859             <td class="entry_tags">
13860             </td>
13861
13862           </tr>
13863           <tr class="entries_header">
13864             <th class="th_details" colspan="5">Details</th>
13865           </tr>
13866           <tr class="entry_cont">
13867             <td class="entry_details" colspan="5">
13868               <p>Attempting to set a key into a CaptureRequest that is not
13869 listed here will result in an invalid request and will be rejected
13870 by the camera device.<wbr/></p>
13871 <p>This field can be used to query the feature set of a camera device
13872 at a more granular level than capabilities.<wbr/> This is especially
13873 important for optional keys that are not listed under any capability
13874 in <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>.<wbr/></p>
13875             </td>
13876           </tr>
13877
13878           <tr class="entries_header">
13879             <th class="th_details" colspan="5">HAL Implementation Details</th>
13880           </tr>
13881           <tr class="entry_cont">
13882             <td class="entry_details" colspan="5">
13883               <p>Vendor tags must not be listed here.<wbr/> Use the vendor tag metadata
13884 extensions C api instead (refer to camera3.<wbr/>h for more details).<wbr/></p>
13885 <p>Setting/<wbr/>getting vendor tags will be checked against the metadata
13886 vendor extensions API and not against this field.<wbr/></p>
13887 <p>The HAL must not consume any request tags that are not listed either
13888 here or in the vendor tag list.<wbr/></p>
13889 <p>The public camera2 API will always make the vendor tags visible
13890 via CameraCharacteristics#getAvailableCaptureRequestKeys.<wbr/></p>
13891             </td>
13892           </tr>
13893
13894           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13895            <!-- end of entry -->
13896
13897
13898           <tr class="entry" id="static_android.request.availableResultKeys">
13899             <td class="entry_name
13900              " rowspan="5">
13901               android.<wbr/>request.<wbr/>available<wbr/>Result<wbr/>Keys
13902             </td>
13903             <td class="entry_type">
13904                 <span class="entry_type_name">int32</span>
13905                 <span class="entry_type_container">x</span>
13906
13907                 <span class="entry_type_array">
13908                   n
13909                 </span>
13910               <span class="entry_type_visibility"> [hidden]</span>
13911
13912
13913               <span class="entry_type_hwlevel">[legacy] </span>
13914
13915
13916
13917
13918             </td> <!-- entry_type -->
13919
13920             <td class="entry_description">
13921               <p>A list of all keys that the camera device has available
13922 to use with CaptureResult.<wbr/></p>
13923             </td>
13924
13925             <td class="entry_units">
13926             </td>
13927
13928             <td class="entry_range">
13929             </td>
13930
13931             <td class="entry_tags">
13932             </td>
13933
13934           </tr>
13935           <tr class="entries_header">
13936             <th class="th_details" colspan="5">Details</th>
13937           </tr>
13938           <tr class="entry_cont">
13939             <td class="entry_details" colspan="5">
13940               <p>Attempting to get a key from a CaptureResult that is not
13941 listed here will always return a <code>null</code> value.<wbr/> Getting a key from
13942 a CaptureResult that is listed here will generally never return a <code>null</code>
13943 value.<wbr/></p>
13944 <p>The following keys may return <code>null</code> unless they are enabled:</p>
13945 <ul>
13946 <li><a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a> (non-null iff <a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a> == ON)</li>
13947 </ul>
13948 <p>(Those sometimes-null keys will nevertheless be listed here
13949 if they are available.<wbr/>)</p>
13950 <p>This field can be used to query the feature set of a camera device
13951 at a more granular level than capabilities.<wbr/> This is especially
13952 important for optional keys that are not listed under any capability
13953 in <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>.<wbr/></p>
13954             </td>
13955           </tr>
13956
13957           <tr class="entries_header">
13958             <th class="th_details" colspan="5">HAL Implementation Details</th>
13959           </tr>
13960           <tr class="entry_cont">
13961             <td class="entry_details" colspan="5">
13962               <p>Tags listed here must always have an entry in the result metadata,<wbr/>
13963 even if that size is 0 elements.<wbr/> Only array-type tags (e.<wbr/>g.<wbr/> lists,<wbr/>
13964 matrices,<wbr/> strings) are allowed to have 0 elements.<wbr/></p>
13965 <p>Vendor tags must not be listed here.<wbr/> Use the vendor tag metadata
13966 extensions C api instead (refer to camera3.<wbr/>h for more details).<wbr/></p>
13967 <p>Setting/<wbr/>getting vendor tags will be checked against the metadata
13968 vendor extensions API and not against this field.<wbr/></p>
13969 <p>The HAL must not produce any result tags that are not listed either
13970 here or in the vendor tag list.<wbr/></p>
13971 <p>The public camera2 API will always make the vendor tags visible
13972 via CameraCharacteristics#getAvailableCaptureResultKeys.<wbr/></p>
13973             </td>
13974           </tr>
13975
13976           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13977            <!-- end of entry -->
13978
13979
13980           <tr class="entry" id="static_android.request.availableCharacteristicsKeys">
13981             <td class="entry_name
13982              " rowspan="5">
13983               android.<wbr/>request.<wbr/>available<wbr/>Characteristics<wbr/>Keys
13984             </td>
13985             <td class="entry_type">
13986                 <span class="entry_type_name">int32</span>
13987                 <span class="entry_type_container">x</span>
13988
13989                 <span class="entry_type_array">
13990                   n
13991                 </span>
13992               <span class="entry_type_visibility"> [hidden]</span>
13993
13994
13995               <span class="entry_type_hwlevel">[legacy] </span>
13996
13997
13998
13999
14000             </td> <!-- entry_type -->
14001
14002             <td class="entry_description">
14003               <p>A list of all keys that the camera device has available
14004 to use with CameraCharacteristics.<wbr/></p>
14005             </td>
14006
14007             <td class="entry_units">
14008             </td>
14009
14010             <td class="entry_range">
14011             </td>
14012
14013             <td class="entry_tags">
14014             </td>
14015
14016           </tr>
14017           <tr class="entries_header">
14018             <th class="th_details" colspan="5">Details</th>
14019           </tr>
14020           <tr class="entry_cont">
14021             <td class="entry_details" colspan="5">
14022               <p>This entry follows the same rules as
14023 <a href="#static_android.request.availableResultKeys">android.<wbr/>request.<wbr/>available<wbr/>Result<wbr/>Keys</a> (except that it applies for
14024 CameraCharacteristics instead of CaptureResult).<wbr/> See above for more
14025 details.<wbr/></p>
14026             </td>
14027           </tr>
14028
14029           <tr class="entries_header">
14030             <th class="th_details" colspan="5">HAL Implementation Details</th>
14031           </tr>
14032           <tr class="entry_cont">
14033             <td class="entry_details" colspan="5">
14034               <p>Keys listed here must always have an entry in the static info metadata,<wbr/>
14035 even if that size is 0 elements.<wbr/> Only array-type tags (e.<wbr/>g.<wbr/> lists,<wbr/>
14036 matrices,<wbr/> strings) are allowed to have 0 elements.<wbr/></p>
14037 <p>Vendor tags must not be listed here.<wbr/> Use the vendor tag metadata
14038 extensions C api instead (refer to camera3.<wbr/>h for more details).<wbr/></p>
14039 <p>Setting/<wbr/>getting vendor tags will be checked against the metadata
14040 vendor extensions API and not against this field.<wbr/></p>
14041 <p>The HAL must not have any tags in its static info that are not listed
14042 either here or in the vendor tag list.<wbr/></p>
14043 <p>The public camera2 API will always make the vendor tags visible
14044 via CameraCharacteristics#getKeys.<wbr/></p>
14045             </td>
14046           </tr>
14047
14048           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14049            <!-- end of entry -->
14050
14051
14052
14053       <!-- end of kind -->
14054       </tbody>
14055       <tr><td colspan="6" class="kind">dynamic</td></tr>
14056
14057       <thead class="entries_header">
14058         <tr>
14059           <th class="th_name">Property Name</th>
14060           <th class="th_type">Type</th>
14061           <th class="th_description">Description</th>
14062           <th class="th_units">Units</th>
14063           <th class="th_range">Range</th>
14064           <th class="th_tags">Tags</th>
14065         </tr>
14066       </thead>
14067
14068       <tbody>
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079           <tr class="entry" id="dynamic_android.request.frameCount">
14080             <td class="entry_name
14081                 entry_name_deprecated
14082              " rowspan="3">
14083               android.<wbr/>request.<wbr/>frame<wbr/>Count
14084             </td>
14085             <td class="entry_type">
14086                 <span class="entry_type_name">int32</span>
14087
14088               <span class="entry_type_visibility"> [hidden]</span>
14089
14090
14091
14092               <span class="entry_type_deprecated">[deprecated] </span>
14093
14094
14095
14096             </td> <!-- entry_type -->
14097
14098             <td class="entry_description">
14099               <p>A frame counter set by the framework.<wbr/> This value monotonically
14100 increases with every new result (that is,<wbr/> each new result has a unique
14101 frameCount value).<wbr/></p>
14102             </td>
14103
14104             <td class="entry_units">
14105               count of frames
14106             </td>
14107
14108             <td class="entry_range">
14109               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14110               <p>&gt; 0</p>
14111             </td>
14112
14113             <td class="entry_tags">
14114             </td>
14115
14116           </tr>
14117           <tr class="entries_header">
14118             <th class="th_details" colspan="5">Details</th>
14119           </tr>
14120           <tr class="entry_cont">
14121             <td class="entry_details" colspan="5">
14122               <p>Reset on release()</p>
14123             </td>
14124           </tr>
14125
14126
14127           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14128            <!-- end of entry -->
14129
14130
14131           <tr class="entry" id="dynamic_android.request.id">
14132             <td class="entry_name
14133              " rowspan="1">
14134               android.<wbr/>request.<wbr/>id
14135             </td>
14136             <td class="entry_type">
14137                 <span class="entry_type_name">int32</span>
14138
14139               <span class="entry_type_visibility"> [hidden]</span>
14140
14141
14142
14143
14144
14145
14146             </td> <!-- entry_type -->
14147
14148             <td class="entry_description">
14149               <p>An application-specified ID for the current
14150 request.<wbr/> Must be maintained unchanged in output
14151 frame</p>
14152             </td>
14153
14154             <td class="entry_units">
14155               arbitrary integer assigned by application
14156             </td>
14157
14158             <td class="entry_range">
14159               <p>Any int</p>
14160             </td>
14161
14162             <td class="entry_tags">
14163               <ul class="entry_tags">
14164                   <li><a href="#tag_V1">V1</a></li>
14165               </ul>
14166             </td>
14167
14168           </tr>
14169
14170
14171           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14172            <!-- end of entry -->
14173
14174
14175           <tr class="entry" id="dynamic_android.request.metadataMode">
14176             <td class="entry_name
14177              " rowspan="1">
14178               android.<wbr/>request.<wbr/>metadata<wbr/>Mode
14179             </td>
14180             <td class="entry_type">
14181                 <span class="entry_type_name entry_type_name_enum">byte</span>
14182
14183               <span class="entry_type_visibility"> [system]</span>
14184
14185
14186
14187
14188
14189                 <ul class="entry_type_enum">
14190                   <li>
14191                     <span class="entry_type_enum_name">NONE</span>
14192                     <span class="entry_type_enum_notes"><p>No metadata should be produced on output,<wbr/> except
14193 for application-bound buffer data.<wbr/> If no
14194 application-bound streams exist,<wbr/> no frame should be
14195 placed in the output frame queue.<wbr/> If such streams
14196 exist,<wbr/> a frame should be placed on the output queue
14197 with null metadata but with the necessary output buffer
14198 information.<wbr/> Timestamp information should still be
14199 included with any output stream buffers</p></span>
14200                   </li>
14201                   <li>
14202                     <span class="entry_type_enum_name">FULL</span>
14203                     <span class="entry_type_enum_notes"><p>All metadata should be produced.<wbr/> Statistics will
14204 only be produced if they are separately
14205 enabled</p></span>
14206                   </li>
14207                 </ul>
14208
14209             </td> <!-- entry_type -->
14210
14211             <td class="entry_description">
14212               <p>How much metadata to produce on
14213 output</p>
14214             </td>
14215
14216             <td class="entry_units">
14217             </td>
14218
14219             <td class="entry_range">
14220             </td>
14221
14222             <td class="entry_tags">
14223               <ul class="entry_tags">
14224                   <li><a href="#tag_FUTURE">FUTURE</a></li>
14225               </ul>
14226             </td>
14227
14228           </tr>
14229
14230
14231           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14232            <!-- end of entry -->
14233
14234
14235           <tr class="entry" id="dynamic_android.request.outputStreams">
14236             <td class="entry_name
14237                 entry_name_deprecated
14238              " rowspan="3">
14239               android.<wbr/>request.<wbr/>output<wbr/>Streams
14240             </td>
14241             <td class="entry_type">
14242                 <span class="entry_type_name">int32</span>
14243                 <span class="entry_type_container">x</span>
14244
14245                 <span class="entry_type_array">
14246                   n
14247                 </span>
14248               <span class="entry_type_visibility"> [system]</span>
14249
14250
14251
14252               <span class="entry_type_deprecated">[deprecated] </span>
14253
14254
14255
14256             </td> <!-- entry_type -->
14257
14258             <td class="entry_description">
14259               <p>Lists which camera output streams image data
14260 from this capture must be sent to</p>
14261             </td>
14262
14263             <td class="entry_units">
14264               List of camera stream IDs
14265             </td>
14266
14267             <td class="entry_range">
14268               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14269               <p>List must only include streams that have been
14270 created</p>
14271             </td>
14272
14273             <td class="entry_tags">
14274               <ul class="entry_tags">
14275                   <li><a href="#tag_HAL2">HAL2</a></li>
14276               </ul>
14277             </td>
14278
14279           </tr>
14280           <tr class="entries_header">
14281             <th class="th_details" colspan="5">Details</th>
14282           </tr>
14283           <tr class="entry_cont">
14284             <td class="entry_details" colspan="5">
14285               <p>If no output streams are listed,<wbr/> then the image
14286 data should simply be discarded.<wbr/> The image data must
14287 still be captured for metadata and statistics production,<wbr/>
14288 and the lens and flash must operate as requested.<wbr/></p>
14289             </td>
14290           </tr>
14291
14292
14293           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14294            <!-- end of entry -->
14295
14296
14297           <tr class="entry" id="dynamic_android.request.pipelineDepth">
14298             <td class="entry_name
14299              " rowspan="5">
14300               android.<wbr/>request.<wbr/>pipeline<wbr/>Depth
14301             </td>
14302             <td class="entry_type">
14303                 <span class="entry_type_name">byte</span>
14304
14305               <span class="entry_type_visibility"> [public]</span>
14306
14307
14308               <span class="entry_type_hwlevel">[legacy] </span>
14309
14310
14311
14312
14313             </td> <!-- entry_type -->
14314
14315             <td class="entry_description">
14316               <p>Specifies the number of pipeline stages the frame went
14317 through from when it was exposed to when the final completed result
14318 was available to the framework.<wbr/></p>
14319             </td>
14320
14321             <td class="entry_units">
14322             </td>
14323
14324             <td class="entry_range">
14325               <p>&lt;= <a href="#static_android.request.pipelineMaxDepth">android.<wbr/>request.<wbr/>pipeline<wbr/>Max<wbr/>Depth</a></p>
14326             </td>
14327
14328             <td class="entry_tags">
14329             </td>
14330
14331           </tr>
14332           <tr class="entries_header">
14333             <th class="th_details" colspan="5">Details</th>
14334           </tr>
14335           <tr class="entry_cont">
14336             <td class="entry_details" colspan="5">
14337               <p>Depending on what settings are used in the request,<wbr/> and
14338 what streams are configured,<wbr/> the data may undergo less processing,<wbr/>
14339 and some pipeline stages skipped.<wbr/></p>
14340 <p>See <a href="#static_android.request.pipelineMaxDepth">android.<wbr/>request.<wbr/>pipeline<wbr/>Max<wbr/>Depth</a> for more details.<wbr/></p>
14341             </td>
14342           </tr>
14343
14344           <tr class="entries_header">
14345             <th class="th_details" colspan="5">HAL Implementation Details</th>
14346           </tr>
14347           <tr class="entry_cont">
14348             <td class="entry_details" colspan="5">
14349               <p>This value must always represent the accurate count of how many
14350 pipeline stages were actually used.<wbr/></p>
14351             </td>
14352           </tr>
14353
14354           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14355            <!-- end of entry -->
14356
14357
14358
14359       <!-- end of kind -->
14360       </tbody>
14361
14362   <!-- end of section -->
14363   <tr><td colspan="6" id="section_scaler" class="section">scaler</td></tr>
14364
14365
14366       <tr><td colspan="6" class="kind">controls</td></tr>
14367
14368       <thead class="entries_header">
14369         <tr>
14370           <th class="th_name">Property Name</th>
14371           <th class="th_type">Type</th>
14372           <th class="th_description">Description</th>
14373           <th class="th_units">Units</th>
14374           <th class="th_range">Range</th>
14375           <th class="th_tags">Tags</th>
14376         </tr>
14377       </thead>
14378
14379       <tbody>
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390           <tr class="entry" id="controls_android.scaler.cropRegion">
14391             <td class="entry_name
14392              " rowspan="5">
14393               android.<wbr/>scaler.<wbr/>crop<wbr/>Region
14394             </td>
14395             <td class="entry_type">
14396                 <span class="entry_type_name">int32</span>
14397                 <span class="entry_type_container">x</span>
14398
14399                 <span class="entry_type_array">
14400                   4
14401                 </span>
14402               <span class="entry_type_visibility"> [public as rectangle]</span>
14403
14404
14405               <span class="entry_type_hwlevel">[legacy] </span>
14406
14407
14408
14409
14410             </td> <!-- entry_type -->
14411
14412             <td class="entry_description">
14413               <p>The desired region of the sensor to read out for this capture.<wbr/></p>
14414             </td>
14415
14416             <td class="entry_units">
14417               Pixel coordinates relative to
14418           android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
14419             </td>
14420
14421             <td class="entry_range">
14422             </td>
14423
14424             <td class="entry_tags">
14425               <ul class="entry_tags">
14426                   <li><a href="#tag_BC">BC</a></li>
14427               </ul>
14428             </td>
14429
14430           </tr>
14431           <tr class="entries_header">
14432             <th class="th_details" colspan="5">Details</th>
14433           </tr>
14434           <tr class="entry_cont">
14435             <td class="entry_details" colspan="5">
14436               <p>This control can be used to implement digital zoom.<wbr/></p>
14437 <p>The crop region coordinate system is based off
14438 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>,<wbr/> with <code>(0,<wbr/> 0)</code> being the
14439 top-left corner of the sensor active array.<wbr/></p>
14440 <p>Output streams use this rectangle to produce their output,<wbr/>
14441 cropping to a smaller region if necessary to maintain the
14442 stream's aspect ratio,<wbr/> then scaling the sensor input to
14443 match the output's configured resolution.<wbr/></p>
14444 <p>The crop region is applied after the RAW to other color
14445 space (e.<wbr/>g.<wbr/> YUV) conversion.<wbr/> Since raw streams
14446 (e.<wbr/>g.<wbr/> RAW16) don't have the conversion stage,<wbr/> they are not
14447 croppable.<wbr/> The crop region will be ignored by raw streams.<wbr/></p>
14448 <p>For non-raw streams,<wbr/> any additional per-stream cropping will
14449 be done to maximize the final pixel area of the stream.<wbr/></p>
14450 <p>For example,<wbr/> if the crop region is set to a 4:3 aspect
14451 ratio,<wbr/> then 4:3 streams will use the exact crop
14452 region.<wbr/> 16:9 streams will further crop vertically
14453 (letterbox).<wbr/></p>
14454 <p>Conversely,<wbr/> if the crop region is set to a 16:9,<wbr/> then 4:3
14455 outputs will crop horizontally (pillarbox),<wbr/> and 16:9
14456 streams will match exactly.<wbr/> These additional crops will
14457 be centered within the crop region.<wbr/></p>
14458 <p>The width and height of the crop region cannot
14459 be set to be smaller than
14460 <code>floor( activeArraySize.<wbr/>width /<wbr/> <a href="#static_android.scaler.availableMaxDigitalZoom">android.<wbr/>scaler.<wbr/>available<wbr/>Max<wbr/>Digital<wbr/>Zoom</a> )</code> and
14461 <code>floor( activeArraySize.<wbr/>height /<wbr/> <a href="#static_android.scaler.availableMaxDigitalZoom">android.<wbr/>scaler.<wbr/>available<wbr/>Max<wbr/>Digital<wbr/>Zoom</a> )</code>,<wbr/> respectively.<wbr/></p>
14462 <p>The camera device may adjust the crop region to account
14463 for rounding and other hardware requirements; the final
14464 crop region used will be included in the output capture
14465 result.<wbr/></p>
14466             </td>
14467           </tr>
14468
14469           <tr class="entries_header">
14470             <th class="th_details" colspan="5">HAL Implementation Details</th>
14471           </tr>
14472           <tr class="entry_cont">
14473             <td class="entry_details" colspan="5">
14474               <p>The output streams must maintain square pixels at all
14475 times,<wbr/> no matter what the relative aspect ratios of the
14476 crop region and the stream are.<wbr/>  Negative values for
14477 corner are allowed for raw output if full pixel array is
14478 larger than active pixel array.<wbr/> Width and height may be
14479 rounded to nearest larger supportable width,<wbr/> especially
14480 for raw output,<wbr/> where only a few fixed scales may be
14481 possible.<wbr/></p>
14482 <p>HAL2.<wbr/>x uses only (x,<wbr/> y,<wbr/> width)</p>
14483             </td>
14484           </tr>
14485
14486           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14487            <!-- end of entry -->
14488
14489
14490
14491       <!-- end of kind -->
14492       </tbody>
14493       <tr><td colspan="6" class="kind">static</td></tr>
14494
14495       <thead class="entries_header">
14496         <tr>
14497           <th class="th_name">Property Name</th>
14498           <th class="th_type">Type</th>
14499           <th class="th_description">Description</th>
14500           <th class="th_units">Units</th>
14501           <th class="th_range">Range</th>
14502           <th class="th_tags">Tags</th>
14503         </tr>
14504       </thead>
14505
14506       <tbody>
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517           <tr class="entry" id="static_android.scaler.availableFormats">
14518             <td class="entry_name
14519                 entry_name_deprecated
14520              " rowspan="5">
14521               android.<wbr/>scaler.<wbr/>available<wbr/>Formats
14522             </td>
14523             <td class="entry_type">
14524                 <span class="entry_type_name entry_type_name_enum">int32</span>
14525                 <span class="entry_type_container">x</span>
14526
14527                 <span class="entry_type_array">
14528                   n
14529                 </span>
14530               <span class="entry_type_visibility"> [hidden as imageFormat]</span>
14531
14532
14533
14534               <span class="entry_type_deprecated">[deprecated] </span>
14535
14536
14537                 <ul class="entry_type_enum">
14538                   <li>
14539                     <span class="entry_type_enum_name">RAW16</span>
14540                     <span class="entry_type_enum_optional">[optional]</span>
14541                     <span class="entry_type_enum_value">0x20</span>
14542                     <span class="entry_type_enum_notes"><p>RAW16 is a standard,<wbr/> cross-platform format for raw image
14543 buffers with 16-bit pixels.<wbr/></p>
14544 <p>Buffers of this format are typically expected to have a
14545 Bayer Color Filter Array (CFA) layout,<wbr/> which is given in
14546 <a href="#static_android.sensor.info.colorFilterArrangement">android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement</a>.<wbr/> Sensors with
14547 CFAs that are not representable by a format in
14548 <a href="#static_android.sensor.info.colorFilterArrangement">android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement</a> should not
14549 use this format.<wbr/></p>
14550 <p>Buffers of this format will also follow the constraints given for
14551 RAW_<wbr/>OPAQUE buffers,<wbr/> but with relaxed performance constraints.<wbr/></p>
14552 <p>See <a href="#static_android.scaler.availableInputOutputFormatsMap">android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map</a> for
14553 the full set of performance guarantees.<wbr/></p></span>
14554                   </li>
14555                   <li>
14556                     <span class="entry_type_enum_name">RAW_OPAQUE</span>
14557                     <span class="entry_type_enum_optional">[optional]</span>
14558                     <span class="entry_type_enum_value">0x24</span>
14559                     <span class="entry_type_enum_notes"><p>RAW_<wbr/>OPAQUE is a format for raw image buffers coming from an
14560 image sensor.<wbr/></p>
14561 <p>The actual structure of buffers of this format is
14562 platform-specific,<wbr/> but must follow several constraints:</p>
14563 <ol>
14564 <li>No image post-processing operations may have been applied to
14565 buffers of this type.<wbr/> These buffers contain raw image data coming
14566 directly from the image sensor.<wbr/></li>
14567 <li>If a buffer of this format is passed to the camera device for
14568 reprocessing,<wbr/> the resulting images will be identical to the images
14569 produced if the buffer had come directly from the sensor and was
14570 processed with the same settings.<wbr/></li>
14571 </ol>
14572 <p>The intended use for this format is to allow access to the native
14573 raw format buffers coming directly from the camera sensor without
14574 any additional conversions or decrease in framerate.<wbr/></p>
14575 <p>See <a href="#static_android.scaler.availableInputOutputFormatsMap">android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map</a> for the full set of
14576 performance guarantees.<wbr/></p></span>
14577                   </li>
14578                   <li>
14579                     <span class="entry_type_enum_name">YV12</span>
14580                     <span class="entry_type_enum_optional">[optional]</span>
14581                     <span class="entry_type_enum_value">0x32315659</span>
14582                     <span class="entry_type_enum_notes"><p>YCrCb 4:2:0 Planar</p></span>
14583                   </li>
14584                   <li>
14585                     <span class="entry_type_enum_name">YCrCb_420_SP</span>
14586                     <span class="entry_type_enum_optional">[optional]</span>
14587                     <span class="entry_type_enum_value">0x11</span>
14588                     <span class="entry_type_enum_notes"><p>NV21</p></span>
14589                   </li>
14590                   <li>
14591                     <span class="entry_type_enum_name">IMPLEMENTATION_DEFINED</span>
14592                     <span class="entry_type_enum_value">0x22</span>
14593                     <span class="entry_type_enum_notes"><p>System internal format,<wbr/> not application-accessible</p></span>
14594                   </li>
14595                   <li>
14596                     <span class="entry_type_enum_name">YCbCr_420_888</span>
14597                     <span class="entry_type_enum_value">0x23</span>
14598                     <span class="entry_type_enum_notes"><p>Flexible YUV420 Format</p></span>
14599                   </li>
14600                   <li>
14601                     <span class="entry_type_enum_name">BLOB</span>
14602                     <span class="entry_type_enum_value">0x21</span>
14603                     <span class="entry_type_enum_notes"><p>JPEG format</p></span>
14604                   </li>
14605                 </ul>
14606
14607             </td> <!-- entry_type -->
14608
14609             <td class="entry_description">
14610               <p>The list of image formats that are supported by this
14611 camera device for output streams.<wbr/></p>
14612             </td>
14613
14614             <td class="entry_units">
14615             </td>
14616
14617             <td class="entry_range">
14618               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14619             </td>
14620
14621             <td class="entry_tags">
14622               <ul class="entry_tags">
14623                   <li><a href="#tag_BC">BC</a></li>
14624               </ul>
14625             </td>
14626
14627           </tr>
14628           <tr class="entries_header">
14629             <th class="th_details" colspan="5">Details</th>
14630           </tr>
14631           <tr class="entry_cont">
14632             <td class="entry_details" colspan="5">
14633               <p>All camera devices will support JPEG and YUV_<wbr/>420_<wbr/>888 formats.<wbr/></p>
14634 <p>When set to YUV_<wbr/>420_<wbr/>888,<wbr/> application can access the YUV420 data directly.<wbr/></p>
14635             </td>
14636           </tr>
14637
14638           <tr class="entries_header">
14639             <th class="th_details" colspan="5">HAL Implementation Details</th>
14640           </tr>
14641           <tr class="entry_cont">
14642             <td class="entry_details" colspan="5">
14643               <p>These format values are from HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>* in
14644 system/<wbr/>core/<wbr/>include/<wbr/>system/<wbr/>graphics.<wbr/>h.<wbr/></p>
14645 <p>When IMPLEMENTATION_<wbr/>DEFINED is used,<wbr/> the platform
14646 gralloc module will select a format based on the usage flags provided
14647 by the camera HAL device and the other endpoint of the stream.<wbr/> It is
14648 usually used by preview and recording streams,<wbr/> where the application doesn't
14649 need access the image data.<wbr/></p>
14650 <p>YCb<wbr/>Cr_<wbr/>420_<wbr/>888 format must be supported by the HAL.<wbr/> When an image stream
14651 needs CPU/<wbr/>application direct access,<wbr/> this format will be used.<wbr/></p>
14652 <p>The BLOB format must be supported by the HAL.<wbr/> This is used for the JPEG stream.<wbr/></p>
14653 <p>A RAW_<wbr/>OPAQUE buffer should contain only pixel data.<wbr/> It is strongly
14654 recommended that any information used by the camera device when
14655 processing images is fully expressed by the result metadata
14656 for that image buffer.<wbr/></p>
14657             </td>
14658           </tr>
14659
14660           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14661            <!-- end of entry -->
14662
14663
14664           <tr class="entry" id="static_android.scaler.availableJpegMinDurations">
14665             <td class="entry_name
14666                 entry_name_deprecated
14667              " rowspan="3">
14668               android.<wbr/>scaler.<wbr/>available<wbr/>Jpeg<wbr/>Min<wbr/>Durations
14669             </td>
14670             <td class="entry_type">
14671                 <span class="entry_type_name">int64</span>
14672                 <span class="entry_type_container">x</span>
14673
14674                 <span class="entry_type_array">
14675                   n
14676                 </span>
14677               <span class="entry_type_visibility"> [hidden]</span>
14678
14679
14680
14681               <span class="entry_type_deprecated">[deprecated] </span>
14682
14683
14684
14685             </td> <!-- entry_type -->
14686
14687             <td class="entry_description">
14688               <p>The minimum frame duration that is supported
14689 for each resolution in <a href="#static_android.scaler.availableJpegSizes">android.<wbr/>scaler.<wbr/>available<wbr/>Jpeg<wbr/>Sizes</a>.<wbr/></p>
14690             </td>
14691
14692             <td class="entry_units">
14693               Nanoseconds
14694             </td>
14695
14696             <td class="entry_range">
14697               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14698               <p>TODO: Remove property.<wbr/></p>
14699             </td>
14700
14701             <td class="entry_tags">
14702               <ul class="entry_tags">
14703                   <li><a href="#tag_BC">BC</a></li>
14704               </ul>
14705             </td>
14706
14707           </tr>
14708           <tr class="entries_header">
14709             <th class="th_details" colspan="5">Details</th>
14710           </tr>
14711           <tr class="entry_cont">
14712             <td class="entry_details" colspan="5">
14713               <p>This corresponds to the minimum steady-state frame duration when only
14714 that JPEG stream is active and captured in a burst,<wbr/> with all
14715 processing (typically in android.<wbr/>*.<wbr/>mode) set to FAST.<wbr/></p>
14716 <p>When multiple streams are configured,<wbr/> the minimum
14717 frame duration will be &gt;= max(individual stream min
14718 durations)</p>
14719             </td>
14720           </tr>
14721
14722
14723           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14724            <!-- end of entry -->
14725
14726
14727           <tr class="entry" id="static_android.scaler.availableJpegSizes">
14728             <td class="entry_name
14729                 entry_name_deprecated
14730              " rowspan="5">
14731               android.<wbr/>scaler.<wbr/>available<wbr/>Jpeg<wbr/>Sizes
14732             </td>
14733             <td class="entry_type">
14734                 <span class="entry_type_name">int32</span>
14735                 <span class="entry_type_container">x</span>
14736
14737                 <span class="entry_type_array">
14738                   n x 2
14739                 </span>
14740               <span class="entry_type_visibility"> [hidden as size]</span>
14741
14742
14743
14744               <span class="entry_type_deprecated">[deprecated] </span>
14745
14746
14747
14748             </td> <!-- entry_type -->
14749
14750             <td class="entry_description">
14751               <p>The JPEG resolutions that are supported by this camera device.<wbr/></p>
14752             </td>
14753
14754             <td class="entry_units">
14755             </td>
14756
14757             <td class="entry_range">
14758               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14759               <p>TODO: Remove property.<wbr/></p>
14760             </td>
14761
14762             <td class="entry_tags">
14763               <ul class="entry_tags">
14764                   <li><a href="#tag_BC">BC</a></li>
14765               </ul>
14766             </td>
14767
14768           </tr>
14769           <tr class="entries_header">
14770             <th class="th_details" colspan="5">Details</th>
14771           </tr>
14772           <tr class="entry_cont">
14773             <td class="entry_details" colspan="5">
14774               <p>The resolutions are listed as <code>(width,<wbr/> height)</code> pairs.<wbr/> All camera devices will support
14775 sensor maximum resolution (defined by <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>).<wbr/></p>
14776             </td>
14777           </tr>
14778
14779           <tr class="entries_header">
14780             <th class="th_details" colspan="5">HAL Implementation Details</th>
14781           </tr>
14782           <tr class="entry_cont">
14783             <td class="entry_details" colspan="5">
14784               <p>The HAL must include sensor maximum resolution
14785 (defined by <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>),<wbr/>
14786 and should include half/<wbr/>quarter of sensor maximum resolution.<wbr/></p>
14787             </td>
14788           </tr>
14789
14790           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14791            <!-- end of entry -->
14792
14793
14794           <tr class="entry" id="static_android.scaler.availableMaxDigitalZoom">
14795             <td class="entry_name
14796              " rowspan="3">
14797               android.<wbr/>scaler.<wbr/>available<wbr/>Max<wbr/>Digital<wbr/>Zoom
14798             </td>
14799             <td class="entry_type">
14800                 <span class="entry_type_name">float</span>
14801
14802               <span class="entry_type_visibility"> [public]</span>
14803
14804
14805               <span class="entry_type_hwlevel">[legacy] </span>
14806
14807
14808
14809
14810             </td> <!-- entry_type -->
14811
14812             <td class="entry_description">
14813               <p>The maximum ratio between both active area width
14814 and crop region width,<wbr/> and active area height and
14815 crop region height,<wbr/> for <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a>.<wbr/></p>
14816             </td>
14817
14818             <td class="entry_units">
14819               Zoom scale factor
14820             </td>
14821
14822             <td class="entry_range">
14823               <p>&gt;=1</p>
14824             </td>
14825
14826             <td class="entry_tags">
14827               <ul class="entry_tags">
14828                   <li><a href="#tag_BC">BC</a></li>
14829               </ul>
14830             </td>
14831
14832           </tr>
14833           <tr class="entries_header">
14834             <th class="th_details" colspan="5">Details</th>
14835           </tr>
14836           <tr class="entry_cont">
14837             <td class="entry_details" colspan="5">
14838               <p>This represents the maximum amount of zooming possible by
14839 the camera device,<wbr/> or equivalently,<wbr/> the minimum cropping
14840 window size.<wbr/></p>
14841 <p>Crop regions that have a width or height that is smaller
14842 than this ratio allows will be rounded up to the minimum
14843 allowed size by the camera device.<wbr/></p>
14844             </td>
14845           </tr>
14846
14847
14848           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14849            <!-- end of entry -->
14850
14851
14852           <tr class="entry" id="static_android.scaler.availableProcessedMinDurations">
14853             <td class="entry_name
14854                 entry_name_deprecated
14855              " rowspan="3">
14856               android.<wbr/>scaler.<wbr/>available<wbr/>Processed<wbr/>Min<wbr/>Durations
14857             </td>
14858             <td class="entry_type">
14859                 <span class="entry_type_name">int64</span>
14860                 <span class="entry_type_container">x</span>
14861
14862                 <span class="entry_type_array">
14863                   n
14864                 </span>
14865               <span class="entry_type_visibility"> [hidden]</span>
14866
14867
14868
14869               <span class="entry_type_deprecated">[deprecated] </span>
14870
14871
14872
14873             </td> <!-- entry_type -->
14874
14875             <td class="entry_description">
14876               <p>For each available processed output size (defined in
14877 <a href="#static_android.scaler.availableProcessedSizes">android.<wbr/>scaler.<wbr/>available<wbr/>Processed<wbr/>Sizes</a>),<wbr/> this property lists the
14878 minimum supportable frame duration for that size.<wbr/></p>
14879             </td>
14880
14881             <td class="entry_units">
14882               Nanoseconds
14883             </td>
14884
14885             <td class="entry_range">
14886               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14887             </td>
14888
14889             <td class="entry_tags">
14890               <ul class="entry_tags">
14891                   <li><a href="#tag_BC">BC</a></li>
14892               </ul>
14893             </td>
14894
14895           </tr>
14896           <tr class="entries_header">
14897             <th class="th_details" colspan="5">Details</th>
14898           </tr>
14899           <tr class="entry_cont">
14900             <td class="entry_details" colspan="5">
14901               <p>This should correspond to the frame duration when only that processed
14902 stream is active,<wbr/> with all processing (typically in android.<wbr/>*.<wbr/>mode)
14903 set to FAST.<wbr/></p>
14904 <p>When multiple streams are configured,<wbr/> the minimum frame duration will
14905 be &gt;= max(individual stream min durations).<wbr/></p>
14906             </td>
14907           </tr>
14908
14909
14910           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14911            <!-- end of entry -->
14912
14913
14914           <tr class="entry" id="static_android.scaler.availableProcessedSizes">
14915             <td class="entry_name
14916                 entry_name_deprecated
14917              " rowspan="5">
14918               android.<wbr/>scaler.<wbr/>available<wbr/>Processed<wbr/>Sizes
14919             </td>
14920             <td class="entry_type">
14921                 <span class="entry_type_name">int32</span>
14922                 <span class="entry_type_container">x</span>
14923
14924                 <span class="entry_type_array">
14925                   n x 2
14926                 </span>
14927               <span class="entry_type_visibility"> [hidden as size]</span>
14928
14929
14930
14931               <span class="entry_type_deprecated">[deprecated] </span>
14932
14933
14934
14935             </td> <!-- entry_type -->
14936
14937             <td class="entry_description">
14938               <p>The resolutions available for use with
14939 processed output streams,<wbr/> such as YV12,<wbr/> NV12,<wbr/> and
14940 platform opaque YUV/<wbr/>RGB streams to the GPU or video
14941 encoders.<wbr/></p>
14942             </td>
14943
14944             <td class="entry_units">
14945             </td>
14946
14947             <td class="entry_range">
14948               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14949             </td>
14950
14951             <td class="entry_tags">
14952               <ul class="entry_tags">
14953                   <li><a href="#tag_BC">BC</a></li>
14954               </ul>
14955             </td>
14956
14957           </tr>
14958           <tr class="entries_header">
14959             <th class="th_details" colspan="5">Details</th>
14960           </tr>
14961           <tr class="entry_cont">
14962             <td class="entry_details" colspan="5">
14963               <p>The resolutions are listed as <code>(width,<wbr/> height)</code> pairs.<wbr/></p>
14964 <p>For a given use case,<wbr/> the actual maximum supported resolution
14965 may be lower than what is listed here,<wbr/> depending on the destination
14966 Surface for the image data.<wbr/> For example,<wbr/> for recording video,<wbr/>
14967 the video encoder chosen may have a maximum size limit (e.<wbr/>g.<wbr/> 1080p)
14968 smaller than what the camera (e.<wbr/>g.<wbr/> maximum resolution is 3264x2448)
14969 can provide.<wbr/></p>
14970 <p>Please reference the documentation for the image data destination to
14971 check if it limits the maximum size for image data.<wbr/></p>
14972             </td>
14973           </tr>
14974
14975           <tr class="entries_header">
14976             <th class="th_details" colspan="5">HAL Implementation Details</th>
14977           </tr>
14978           <tr class="entry_cont">
14979             <td class="entry_details" colspan="5">
14980               <p>For FULL capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL</code>),<wbr/>
14981 the HAL must include all JPEG sizes listed in <a href="#static_android.scaler.availableJpegSizes">android.<wbr/>scaler.<wbr/>available<wbr/>Jpeg<wbr/>Sizes</a>
14982 and each below resolution if it is smaller than or equal to the sensor
14983 maximum resolution (if they are not listed in JPEG sizes already):</p>
14984 <ul>
14985 <li>240p (320 x 240)</li>
14986 <li>480p (640 x 480)</li>
14987 <li>720p (1280 x 720)</li>
14988 <li>1080p (1920 x 1080)</li>
14989 </ul>
14990 <p>For LIMITED capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == LIMITED</code>),<wbr/>
14991 the HAL only has to list up to the maximum video size supported by the devices.<wbr/></p>
14992             </td>
14993           </tr>
14994
14995           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14996            <!-- end of entry -->
14997
14998
14999           <tr class="entry" id="static_android.scaler.availableRawMinDurations">
15000             <td class="entry_name
15001                 entry_name_deprecated
15002              " rowspan="3">
15003               android.<wbr/>scaler.<wbr/>available<wbr/>Raw<wbr/>Min<wbr/>Durations
15004             </td>
15005             <td class="entry_type">
15006                 <span class="entry_type_name">int64</span>
15007                 <span class="entry_type_container">x</span>
15008
15009                 <span class="entry_type_array">
15010                   n
15011                 </span>
15012               <span class="entry_type_visibility"> [system]</span>
15013
15014
15015
15016               <span class="entry_type_deprecated">[deprecated] </span>
15017
15018
15019
15020             </td> <!-- entry_type -->
15021
15022             <td class="entry_description">
15023               <p>For each available raw output size (defined in
15024 <a href="#static_android.scaler.availableRawSizes">android.<wbr/>scaler.<wbr/>available<wbr/>Raw<wbr/>Sizes</a>),<wbr/> this property lists the minimum
15025 supportable frame duration for that size.<wbr/></p>
15026             </td>
15027
15028             <td class="entry_units">
15029               Nanoseconds
15030             </td>
15031
15032             <td class="entry_range">
15033               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
15034             </td>
15035
15036             <td class="entry_tags">
15037               <ul class="entry_tags">
15038                   <li><a href="#tag_BC">BC</a></li>
15039               </ul>
15040             </td>
15041
15042           </tr>
15043           <tr class="entries_header">
15044             <th class="th_details" colspan="5">Details</th>
15045           </tr>
15046           <tr class="entry_cont">
15047             <td class="entry_details" colspan="5">
15048               <p>Should correspond to the frame duration when only the raw stream is
15049 active.<wbr/></p>
15050 <p>When multiple streams are configured,<wbr/> the minimum
15051 frame duration will be &gt;= max(individual stream min
15052 durations)</p>
15053             </td>
15054           </tr>
15055
15056
15057           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15058            <!-- end of entry -->
15059
15060
15061           <tr class="entry" id="static_android.scaler.availableRawSizes">
15062             <td class="entry_name
15063                 entry_name_deprecated
15064              " rowspan="1">
15065               android.<wbr/>scaler.<wbr/>available<wbr/>Raw<wbr/>Sizes
15066             </td>
15067             <td class="entry_type">
15068                 <span class="entry_type_name">int32</span>
15069                 <span class="entry_type_container">x</span>
15070
15071                 <span class="entry_type_array">
15072                   n x 2
15073                 </span>
15074               <span class="entry_type_visibility"> [system as size]</span>
15075
15076
15077
15078               <span class="entry_type_deprecated">[deprecated] </span>
15079
15080
15081
15082             </td> <!-- entry_type -->
15083
15084             <td class="entry_description">
15085               <p>The resolutions available for use with raw
15086 sensor output streams,<wbr/> listed as width,<wbr/>
15087 height</p>
15088             </td>
15089
15090             <td class="entry_units">
15091             </td>
15092
15093             <td class="entry_range">
15094               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
15095             </td>
15096
15097             <td class="entry_tags">
15098             </td>
15099
15100           </tr>
15101
15102
15103           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15104            <!-- end of entry -->
15105
15106
15107           <tr class="entry" id="static_android.scaler.availableInputOutputFormatsMap">
15108             <td class="entry_name
15109              " rowspan="5">
15110               android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map
15111             </td>
15112             <td class="entry_type">
15113                 <span class="entry_type_name">int32</span>
15114                 <span class="entry_type_container">x</span>
15115
15116                 <span class="entry_type_array">
15117                   n
15118                 </span>
15119               <span class="entry_type_visibility"> [hidden as imageFormat]</span>
15120
15121
15122               <span class="entry_type_hwlevel">[full] </span>
15123
15124
15125
15126
15127             </td> <!-- entry_type -->
15128
15129             <td class="entry_description">
15130               <p>The mapping of image formats that are supported by this
15131 camera device for input streams,<wbr/> to their corresponding output formats.<wbr/></p>
15132             </td>
15133
15134             <td class="entry_units">
15135             </td>
15136
15137             <td class="entry_range">
15138             </td>
15139
15140             <td class="entry_tags">
15141             </td>
15142
15143           </tr>
15144           <tr class="entries_header">
15145             <th class="th_details" colspan="5">Details</th>
15146           </tr>
15147           <tr class="entry_cont">
15148             <td class="entry_details" colspan="5">
15149               <p>All camera devices with at least 1
15150 <a href="#static_android.request.maxNumInputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Input<wbr/>Streams</a> will have at least one
15151 available input format.<wbr/></p>
15152 <p>The camera device will support the following map of formats,<wbr/>
15153 if its dependent capability is supported:</p>
15154 <table>
15155 <thead>
15156 <tr>
15157 <th align="left">Input Format</th>
15158 <th align="left">Output Format</th>
15159 <th align="left">Capability</th>
15160 </tr>
15161 </thead>
15162 <tbody>
15163 <tr>
15164 <td align="left">RAW_<wbr/>OPAQUE</td>
15165 <td align="left">JPEG</td>
15166 <td align="left">ZSL</td>
15167 </tr>
15168 <tr>
15169 <td align="left">RAW_<wbr/>OPAQUE</td>
15170 <td align="left">YUV_<wbr/>420_<wbr/>888</td>
15171 <td align="left">ZSL</td>
15172 </tr>
15173 <tr>
15174 <td align="left">RAW_<wbr/>OPAQUE</td>
15175 <td align="left">RAW16</td>
15176 <td align="left">RAW</td>
15177 </tr>
15178 <tr>
15179 <td align="left">RAW16</td>
15180 <td align="left">YUV_<wbr/>420_<wbr/>888</td>
15181 <td align="left">RAW</td>
15182 </tr>
15183 <tr>
15184 <td align="left">RAW16</td>
15185 <td align="left">JPEG</td>
15186 <td align="left">RAW</td>
15187 </tr>
15188 </tbody>
15189 </table>
15190 <p>For ZSL-capable camera devices,<wbr/> using the RAW_<wbr/>OPAQUE format
15191 as either input or output will never hurt maximum frame rate (i.<wbr/>e.<wbr/>
15192 Stream<wbr/>Configuration<wbr/>Map#get<wbr/>Output<wbr/>Stall<wbr/>Duration(int,<wbr/>Size)
15193 for a <code>format =</code> RAW_<wbr/>OPAQUE is always 0).<wbr/></p>
15194 <p>Attempting to configure an input stream with output streams not
15195 listed as available in this map is not valid.<wbr/></p>
15196 <p>TODO: typedef to ReprocessFormatMap</p>
15197             </td>
15198           </tr>
15199
15200           <tr class="entries_header">
15201             <th class="th_details" colspan="5">HAL Implementation Details</th>
15202           </tr>
15203           <tr class="entry_cont">
15204             <td class="entry_details" colspan="5">
15205               <p>For the formats,<wbr/> see <code>system/<wbr/>core/<wbr/>include/<wbr/>system/<wbr/>graphics.<wbr/>h</code> for a definition
15206 of the image format enumerations.<wbr/></p>
15207 <p>This value is encoded as a variable-size array-of-arrays.<wbr/>
15208 The inner array always contains <code>[format,<wbr/> length,<wbr/> ...<wbr/>]</code> where
15209 <code>...<wbr/></code> has <code>length</code> elements.<wbr/> An inner array is followed by another
15210 inner array if the total metadata entry size hasn't yet been exceeded.<wbr/></p>
15211 <p>A code sample to read/<wbr/>write this encoding (with a device that
15212 supports reprocessing RAW_<wbr/>OPAQUE to RAW16,<wbr/> YUV_<wbr/>420_<wbr/>888,<wbr/> and JPEG,<wbr/>
15213 and reprocessing RAW16 to YUV_<wbr/>420_<wbr/>888 and JPEG):</p>
15214 <pre><code>//<wbr/> reading
15215 int32_<wbr/>t* contents = &amp;entry.<wbr/>i32[0];
15216 for (size_<wbr/>t i = 0; i &lt; entry.<wbr/>count; ) {
15217     int32_<wbr/>t format = contents[i++];
15218     int32_<wbr/>t length = contents[i++];
15219     int32_<wbr/>t output_<wbr/>formats[length];
15220     memcpy(&amp;output_<wbr/>formats[0],<wbr/> &amp;contents[i],<wbr/>
15221            length * sizeof(int32_<wbr/>t));
15222     i += length;
15223 }
15224
15225 //<wbr/> writing (static example,<wbr/> RAW+ZSL)
15226 int32_<wbr/>t[] contents = {
15227   RAW_<wbr/>OPAQUE,<wbr/> 3,<wbr/> RAW16,<wbr/> YUV_<wbr/>420_<wbr/>888,<wbr/> BLOB,<wbr/>
15228   RAW16,<wbr/> 2,<wbr/> YUV_<wbr/>420_<wbr/>888,<wbr/> BLOB,<wbr/>
15229 };
15230 update_<wbr/>camera_<wbr/>metadata_<wbr/>entry(metadata,<wbr/> index,<wbr/> &amp;contents[0],<wbr/>
15231       sizeof(contents)/<wbr/>sizeof(contents[0]),<wbr/> &amp;updated_<wbr/>entry);
15232 </code></pre>
15233 <p>If the HAL claims to support any of the capabilities listed in the
15234 above details,<wbr/> then it must also support all the input-output
15235 combinations listed for that capability.<wbr/> It can optionally support
15236 additional formats if it so chooses.<wbr/></p>
15237 <p>Refer to <a href="#static_android.scaler.availableFormats">android.<wbr/>scaler.<wbr/>available<wbr/>Formats</a> for the enum values
15238 which correspond to HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>* in
15239 system/<wbr/>core/<wbr/>include/<wbr/>system/<wbr/>graphics.<wbr/>h.<wbr/></p>
15240             </td>
15241           </tr>
15242
15243           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15244            <!-- end of entry -->
15245
15246
15247           <tr class="entry" id="static_android.scaler.availableStreamConfigurations">
15248             <td class="entry_name
15249              " rowspan="5">
15250               android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations
15251             </td>
15252             <td class="entry_type">
15253                 <span class="entry_type_name entry_type_name_enum">int32</span>
15254                 <span class="entry_type_container">x</span>
15255
15256                 <span class="entry_type_array">
15257                   n x 4
15258                 </span>
15259               <span class="entry_type_visibility"> [hidden as streamConfiguration]</span>
15260
15261
15262               <span class="entry_type_hwlevel">[legacy] </span>
15263
15264
15265
15266                 <ul class="entry_type_enum">
15267                   <li>
15268                     <span class="entry_type_enum_name">OUTPUT</span>
15269                   </li>
15270                   <li>
15271                     <span class="entry_type_enum_name">INPUT</span>
15272                   </li>
15273                 </ul>
15274
15275             </td> <!-- entry_type -->
15276
15277             <td class="entry_description">
15278               <p>The available stream configurations that this
15279 camera device supports
15280 (i.<wbr/>e.<wbr/> format,<wbr/> width,<wbr/> height,<wbr/> output/<wbr/>input stream).<wbr/></p>
15281             </td>
15282
15283             <td class="entry_units">
15284             </td>
15285
15286             <td class="entry_range">
15287             </td>
15288
15289             <td class="entry_tags">
15290             </td>
15291
15292           </tr>
15293           <tr class="entries_header">
15294             <th class="th_details" colspan="5">Details</th>
15295           </tr>
15296           <tr class="entry_cont">
15297             <td class="entry_details" colspan="5">
15298               <p>The configurations are listed as <code>(format,<wbr/> width,<wbr/> height,<wbr/> input?)</code>
15299 tuples.<wbr/></p>
15300 <p>For a given use case,<wbr/> the actual maximum supported resolution
15301 may be lower than what is listed here,<wbr/> depending on the destination
15302 Surface for the image data.<wbr/> For example,<wbr/> for recording video,<wbr/>
15303 the video encoder chosen may have a maximum size limit (e.<wbr/>g.<wbr/> 1080p)
15304 smaller than what the camera (e.<wbr/>g.<wbr/> maximum resolution is 3264x2448)
15305 can provide.<wbr/></p>
15306 <p>Please reference the documentation for the image data destination to
15307 check if it limits the maximum size for image data.<wbr/></p>
15308 <p>Not all output formats may be supported in a configuration with
15309 an input stream of a particular format.<wbr/> For more details,<wbr/> see
15310 <a href="#static_android.scaler.availableInputOutputFormatsMap">android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map</a>.<wbr/></p>
15311 <p>The following table describes the minimum required output stream
15312 configurations based on the hardware level
15313 (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a>):</p>
15314 <table>
15315 <thead>
15316 <tr>
15317 <th align="center">Format</th>
15318 <th align="center">Size</th>
15319 <th align="center">Hardware Level</th>
15320 <th align="center">Notes</th>
15321 </tr>
15322 </thead>
15323 <tbody>
15324 <tr>
15325 <td align="center">JPEG</td>
15326 <td align="center"><a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></td>
15327 <td align="center">Any</td>
15328 <td align="center"></td>
15329 </tr>
15330 <tr>
15331 <td align="center">JPEG</td>
15332 <td align="center">1920x1080 (1080p)</td>
15333 <td align="center">Any</td>
15334 <td align="center">if 1080p &lt;= activeArraySize</td>
15335 </tr>
15336 <tr>
15337 <td align="center">JPEG</td>
15338 <td align="center">1280x720 (720)</td>
15339 <td align="center">Any</td>
15340 <td align="center">if 720p &lt;= activeArraySize</td>
15341 </tr>
15342 <tr>
15343 <td align="center">JPEG</td>
15344 <td align="center">640x480 (480p)</td>
15345 <td align="center">Any</td>
15346 <td align="center">if 480p &lt;= activeArraySize</td>
15347 </tr>
15348 <tr>
15349 <td align="center">JPEG</td>
15350 <td align="center">320x240 (240p)</td>
15351 <td align="center">Any</td>
15352 <td align="center">if 240p &lt;= activeArraySize</td>
15353 </tr>
15354 <tr>
15355 <td align="center">YUV_<wbr/>420_<wbr/>888</td>
15356 <td align="center">all output sizes available for JPEG</td>
15357 <td align="center">FULL</td>
15358 <td align="center"></td>
15359 </tr>
15360 <tr>
15361 <td align="center">YUV_<wbr/>420_<wbr/>888</td>
15362 <td align="center">all output sizes available for JPEG,<wbr/> up to the maximum video size</td>
15363 <td align="center">LIMITED</td>
15364 <td align="center"></td>
15365 </tr>
15366 <tr>
15367 <td align="center">IMPLEMENTATION_<wbr/>DEFINED</td>
15368 <td align="center">same as YUV_<wbr/>420_<wbr/>888</td>
15369 <td align="center">Any</td>
15370 <td align="center"></td>
15371 </tr>
15372 </tbody>
15373 </table>
15374 <p>Refer to <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> for additional
15375 mandatory stream configurations on a per-capability basis.<wbr/></p>
15376             </td>
15377           </tr>
15378
15379           <tr class="entries_header">
15380             <th class="th_details" colspan="5">HAL Implementation Details</th>
15381           </tr>
15382           <tr class="entry_cont">
15383             <td class="entry_details" colspan="5">
15384               <p>It is recommended (but not mandatory) to also include half/<wbr/>quarter
15385 of sensor maximum resolution for JPEG formats (regardless of hardware
15386 level).<wbr/></p>
15387 <p>(The following is a rewording of the above required table):</p>
15388 <p>For JPEG format,<wbr/> the sizes may be restricted by below conditions:</p>
15389 <ul>
15390 <li>The HAL may choose the aspect ratio of each Jpeg size to be one of well known ones
15391 (e.<wbr/>g.<wbr/> 4:3,<wbr/> 16:9,<wbr/> 3:2 etc.<wbr/>).<wbr/> If the sensor maximum resolution
15392 (defined by <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>) has an aspect ratio other than these,<wbr/>
15393 it does not have to be included in the supported JPEG sizes.<wbr/></li>
15394 <li>Some hardware JPEG encoders may have pixel boundary alignment requirements,<wbr/> such as
15395 the dimensions being a multiple of 16.<wbr/></li>
15396 </ul>
15397 <p>Therefore,<wbr/> the maximum JPEG size may be smaller than sensor maximum resolution.<wbr/>
15398 However,<wbr/> the largest JPEG size must be as close as possible to the sensor maximum
15399 resolution given above constraints.<wbr/> It is required that after aspect ratio adjustments,<wbr/>
15400 additional size reduction due to other issues must be less than 3% in area.<wbr/> For example,<wbr/>
15401 if the sensor maximum resolution is 3280x2464,<wbr/> if the maximum JPEG size has aspect
15402 ratio 4:3,<wbr/> the JPEG encoder alignment requirement is 16,<wbr/> the maximum JPEG size will be
15403 3264x2448.<wbr/></p>
15404 <p>For FULL capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL</code>),<wbr/>
15405 the HAL must include all YUV_<wbr/>420_<wbr/>888 sizes that have JPEG sizes listed
15406 here as output streams.<wbr/></p>
15407 <p>It must also include each below resolution if it is smaller than or
15408 equal to the sensor maximum resolution (for both YUV_<wbr/>420_<wbr/>888 and JPEG
15409 formats),<wbr/> as output streams:</p>
15410 <ul>
15411 <li>240p (320 x 240)</li>
15412 <li>480p (640 x 480)</li>
15413 <li>720p (1280 x 720)</li>
15414 <li>1080p (1920 x 1080)</li>
15415 </ul>
15416 <p>For LIMITED capability devices
15417 (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == LIMITED</code>),<wbr/>
15418 the HAL only has to list up to the maximum video size
15419 supported by the device.<wbr/></p>
15420 <p>Regardless of hardware level,<wbr/> every output resolution available for
15421 YUV_<wbr/>420_<wbr/>888 must also be available for IMPLEMENTATION_<wbr/>DEFINED.<wbr/></p>
15422 <p>This supercedes the following fields,<wbr/> which are now deprecated:</p>
15423 <ul>
15424 <li>availableFormats</li>
15425 <li>available[Processed,<wbr/>Raw,<wbr/>Jpeg]Sizes</li>
15426 </ul>
15427             </td>
15428           </tr>
15429
15430           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15431            <!-- end of entry -->
15432
15433
15434           <tr class="entry" id="static_android.scaler.availableMinFrameDurations">
15435             <td class="entry_name
15436              " rowspan="3">
15437               android.<wbr/>scaler.<wbr/>available<wbr/>Min<wbr/>Frame<wbr/>Durations
15438             </td>
15439             <td class="entry_type">
15440                 <span class="entry_type_name">int64</span>
15441                 <span class="entry_type_container">x</span>
15442
15443                 <span class="entry_type_array">
15444                   4 x n
15445                 </span>
15446               <span class="entry_type_visibility"> [hidden as streamConfigurationDuration]</span>
15447
15448
15449               <span class="entry_type_hwlevel">[legacy] </span>
15450
15451
15452
15453
15454             </td> <!-- entry_type -->
15455
15456             <td class="entry_description">
15457               <p>This lists the minimum frame duration for each
15458 format/<wbr/>size combination.<wbr/></p>
15459             </td>
15460
15461             <td class="entry_units">
15462               (format,<wbr/> width,<wbr/> height,<wbr/> ns) x n
15463             </td>
15464
15465             <td class="entry_range">
15466             </td>
15467
15468             <td class="entry_tags">
15469               <ul class="entry_tags">
15470                   <li><a href="#tag_V1">V1</a></li>
15471               </ul>
15472             </td>
15473
15474           </tr>
15475           <tr class="entries_header">
15476             <th class="th_details" colspan="5">Details</th>
15477           </tr>
15478           <tr class="entry_cont">
15479             <td class="entry_details" colspan="5">
15480               <p>This should correspond to the frame duration when only that
15481 stream is active,<wbr/> with all processing (typically in android.<wbr/>*.<wbr/>mode)
15482 set to either OFF or FAST.<wbr/></p>
15483 <p>When multiple streams are used in a request,<wbr/> the minimum frame
15484 duration will be max(individual stream min durations).<wbr/></p>
15485 <p>The minimum frame duration of a stream (of a particular format,<wbr/> size)
15486 is the same regardless of whether the stream is input or output.<wbr/></p>
15487 <p>See <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> and
15488 <a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a> for more details about
15489 calculating the max frame rate.<wbr/></p>
15490 <p>(Keep in sync with
15491 StreamConfigurationMap#getOutputMinFrameDuration)</p>
15492             </td>
15493           </tr>
15494
15495
15496           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15497            <!-- end of entry -->
15498
15499
15500           <tr class="entry" id="static_android.scaler.availableStallDurations">
15501             <td class="entry_name
15502              " rowspan="5">
15503               android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations
15504             </td>
15505             <td class="entry_type">
15506                 <span class="entry_type_name">int64</span>
15507                 <span class="entry_type_container">x</span>
15508
15509                 <span class="entry_type_array">
15510                   4 x n
15511                 </span>
15512               <span class="entry_type_visibility"> [hidden as streamConfigurationDuration]</span>
15513
15514
15515               <span class="entry_type_hwlevel">[legacy] </span>
15516
15517
15518
15519
15520             </td> <!-- entry_type -->
15521
15522             <td class="entry_description">
15523               <p>This lists the maximum stall duration for each
15524 format/<wbr/>size combination.<wbr/></p>
15525             </td>
15526
15527             <td class="entry_units">
15528               (format,<wbr/> width,<wbr/> height,<wbr/> ns) x n
15529             </td>
15530
15531             <td class="entry_range">
15532             </td>
15533
15534             <td class="entry_tags">
15535               <ul class="entry_tags">
15536                   <li><a href="#tag_V1">V1</a></li>
15537               </ul>
15538             </td>
15539
15540           </tr>
15541           <tr class="entries_header">
15542             <th class="th_details" colspan="5">Details</th>
15543           </tr>
15544           <tr class="entry_cont">
15545             <td class="entry_details" colspan="5">
15546               <p>A stall duration is how much extra time would get added
15547 to the normal minimum frame duration for a repeating request
15548 that has streams with non-zero stall.<wbr/></p>
15549 <p>For example,<wbr/> consider JPEG captures which have the following
15550 characteristics:</p>
15551 <ul>
15552 <li>JPEG streams act like processed YUV streams in requests for which
15553 they are not included; in requests in which they are directly
15554 referenced,<wbr/> they act as JPEG streams.<wbr/> This is because supporting a
15555 JPEG stream requires the underlying YUV data to always be ready for
15556 use by a JPEG encoder,<wbr/> but the encoder will only be used (and impact
15557 frame duration) on requests that actually reference a JPEG stream.<wbr/></li>
15558 <li>The JPEG processor can run concurrently to the rest of the camera
15559 pipeline,<wbr/> but cannot process more than 1 capture at a time.<wbr/></li>
15560 </ul>
15561 <p>In other words,<wbr/> using a repeating YUV request would result
15562 in a steady frame rate (let's say it's 30 FPS).<wbr/> If a single
15563 JPEG request is submitted periodically,<wbr/> the frame rate will stay
15564 at 30 FPS (as long as we wait for the previous JPEG to return each
15565 time).<wbr/> If we try to submit a repeating YUV + JPEG request,<wbr/> then
15566 the frame rate will drop from 30 FPS.<wbr/></p>
15567 <p>In general,<wbr/> submitting a new request with a non-0 stall time
15568 stream will <em>not</em> cause a frame rate drop unless there are still
15569 outstanding buffers for that stream from previous requests.<wbr/></p>
15570 <p>Submitting a repeating request with streams (call this <code>S</code>)
15571 is the same as setting the minimum frame duration from
15572 the normal minimum frame duration corresponding to <code>S</code>,<wbr/> added with
15573 the maximum stall duration for <code>S</code>.<wbr/></p>
15574 <p>If interleaving requests with and without a stall duration,<wbr/>
15575 a request will stall by the maximum of the remaining times
15576 for each can-stall stream with outstanding buffers.<wbr/></p>
15577 <p>This means that a stalling request will not have an exposure start
15578 until the stall has completed.<wbr/></p>
15579 <p>This should correspond to the stall duration when only that stream is
15580 active,<wbr/> with all processing (typically in android.<wbr/>*.<wbr/>mode) set to FAST
15581 or OFF.<wbr/> Setting any of the processing modes to HIGH_<wbr/>QUALITY
15582 effectively results in an indeterminate stall duration for all
15583 streams in a request (the regular stall calculation rules are
15584 ignored).<wbr/></p>
15585 <p>The following formats may always have a stall duration:</p>
15586 <ul>
15587 <li>ImageFormat#JPEG</li>
15588 <li>ImageFormat#RAW_<wbr/>SENSOR</li>
15589 </ul>
15590 <p>The following formats will never have a stall duration:</p>
15591 <ul>
15592 <li>Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</li>
15593 </ul>
15594 <p>All other formats may or may not have an allowed stall duration on
15595 a per-capability basis; refer to <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
15596 for more details.<wbr/></p>
15597 <p>See <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> for more information about
15598 calculating the max frame rate (absent stalls).<wbr/></p>
15599 <p>(Keep up to date with
15600 StreamConfigurationMap#getOutputStallDuration(int,<wbr/> Size) )</p>
15601             </td>
15602           </tr>
15603
15604           <tr class="entries_header">
15605             <th class="th_details" colspan="5">HAL Implementation Details</th>
15606           </tr>
15607           <tr class="entry_cont">
15608             <td class="entry_details" colspan="5">
15609               <p>If possible,<wbr/> it is recommended that all non-JPEG formats
15610 (such as RAW16) should not have a stall duration.<wbr/> RAW10,<wbr/> RAW_<wbr/>OPAQUE and
15611 IMPLEMENTATION_<wbr/>DEFINED must not have stall durations.<wbr/></p>
15612             </td>
15613           </tr>
15614
15615           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15616            <!-- end of entry -->
15617
15618
15619           <tr class="entry" id="static_android.scaler.streamConfigurationMap">
15620             <td class="entry_name
15621              " rowspan="5">
15622               android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map
15623             </td>
15624             <td class="entry_type">
15625                 <span class="entry_type_name">int32</span>
15626
15627               <span class="entry_type_visibility"> [public as streamConfigurationMap]</span>
15628
15629               <span class="entry_type_synthetic">[synthetic] </span>
15630
15631               <span class="entry_type_hwlevel">[legacy] </span>
15632
15633
15634
15635
15636             </td> <!-- entry_type -->
15637
15638             <td class="entry_description">
15639               <p>The available stream configurations that this
15640 camera device supports; also includes the minimum frame durations
15641 and the stall durations for each format/<wbr/>size combination.<wbr/></p>
15642             </td>
15643
15644             <td class="entry_units">
15645             </td>
15646
15647             <td class="entry_range">
15648             </td>
15649
15650             <td class="entry_tags">
15651             </td>
15652
15653           </tr>
15654           <tr class="entries_header">
15655             <th class="th_details" colspan="5">Details</th>
15656           </tr>
15657           <tr class="entry_cont">
15658             <td class="entry_details" colspan="5">
15659               <p>All camera devices will support sensor maximum resolution (defined by
15660 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>) for the JPEG format.<wbr/></p>
15661 <p>For a given use case,<wbr/> the actual maximum supported resolution
15662 may be lower than what is listed here,<wbr/> depending on the destination
15663 Surface for the image data.<wbr/> For example,<wbr/> for recording video,<wbr/>
15664 the video encoder chosen may have a maximum size limit (e.<wbr/>g.<wbr/> 1080p)
15665 smaller than what the camera (e.<wbr/>g.<wbr/> maximum resolution is 3264x2448)
15666 can provide.<wbr/></p>
15667 <p>Please reference the documentation for the image data destination to
15668 check if it limits the maximum size for image data.<wbr/></p>
15669 <p>The following table describes the minimum required output stream
15670 configurations based on the hardware level
15671 (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a>):</p>
15672 <table>
15673 <thead>
15674 <tr>
15675 <th align="center">Format</th>
15676 <th align="center">Size</th>
15677 <th align="center">Hardware Level</th>
15678 <th align="center">Notes</th>
15679 </tr>
15680 </thead>
15681 <tbody>
15682 <tr>
15683 <td align="center">JPEG</td>
15684 <td align="center"><a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></td>
15685 <td align="center">Any</td>
15686 <td align="center"></td>
15687 </tr>
15688 <tr>
15689 <td align="center">JPEG</td>
15690 <td align="center">1920x1080 (1080p)</td>
15691 <td align="center">Any</td>
15692 <td align="center">if 1080p &lt;= activeArraySize</td>
15693 </tr>
15694 <tr>
15695 <td align="center">JPEG</td>
15696 <td align="center">1280x720 (720)</td>
15697 <td align="center">Any</td>
15698 <td align="center">if 720p &lt;= activeArraySize</td>
15699 </tr>
15700 <tr>
15701 <td align="center">JPEG</td>
15702 <td align="center">640x480 (480p)</td>
15703 <td align="center">Any</td>
15704 <td align="center">if 480p &lt;= activeArraySize</td>
15705 </tr>
15706 <tr>
15707 <td align="center">JPEG</td>
15708 <td align="center">320x240 (240p)</td>
15709 <td align="center">Any</td>
15710 <td align="center">if 240p &lt;= activeArraySize</td>
15711 </tr>
15712 <tr>
15713 <td align="center">YUV_<wbr/>420_<wbr/>888</td>
15714 <td align="center">all output sizes available for JPEG</td>
15715 <td align="center">FULL</td>
15716 <td align="center"></td>
15717 </tr>
15718 <tr>
15719 <td align="center">YUV_<wbr/>420_<wbr/>888</td>
15720 <td align="center">all output sizes available for JPEG,<wbr/> up to the maximum video size</td>
15721 <td align="center">LIMITED</td>
15722 <td align="center"></td>
15723 </tr>
15724 <tr>
15725 <td align="center">IMPLEMENTATION_<wbr/>DEFINED</td>
15726 <td align="center">same as YUV_<wbr/>420_<wbr/>888</td>
15727 <td align="center">Any</td>
15728 <td align="center"></td>
15729 </tr>
15730 </tbody>
15731 </table>
15732 <p>Refer to <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> for additional
15733 mandatory stream configurations on a per-capability basis.<wbr/></p>
15734             </td>
15735           </tr>
15736
15737           <tr class="entries_header">
15738             <th class="th_details" colspan="5">HAL Implementation Details</th>
15739           </tr>
15740           <tr class="entry_cont">
15741             <td class="entry_details" colspan="5">
15742               <p>Do not set this property directly
15743 (it is synthetic and will not be available at the HAL layer);
15744 set the <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a> instead.<wbr/></p>
15745 <p>Not all output formats may be supported in a configuration with
15746 an input stream of a particular format.<wbr/> For more details,<wbr/> see
15747 <a href="#static_android.scaler.availableInputOutputFormatsMap">android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map</a>.<wbr/></p>
15748 <p>It is recommended (but not mandatory) to also include half/<wbr/>quarter
15749 of sensor maximum resolution for JPEG formats (regardless of hardware
15750 level).<wbr/></p>
15751 <p>(The following is a rewording of the above required table):</p>
15752 <p>The HAL must include sensor maximum resolution (defined by
15753 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>).<wbr/></p>
15754 <p>For FULL capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL</code>),<wbr/>
15755 the HAL must include all YUV_<wbr/>420_<wbr/>888 sizes that have JPEG sizes listed
15756 here as output streams.<wbr/></p>
15757 <p>It must also include each below resolution if it is smaller than or
15758 equal to the sensor maximum resolution (for both YUV_<wbr/>420_<wbr/>888 and JPEG
15759 formats),<wbr/> as output streams:</p>
15760 <ul>
15761 <li>240p (320 x 240)</li>
15762 <li>480p (640 x 480)</li>
15763 <li>720p (1280 x 720)</li>
15764 <li>1080p (1920 x 1080)</li>
15765 </ul>
15766 <p>For LIMITED capability devices
15767 (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == LIMITED</code>),<wbr/>
15768 the HAL only has to list up to the maximum video size
15769 supported by the device.<wbr/></p>
15770 <p>Regardless of hardware level,<wbr/> every output resolution available for
15771 YUV_<wbr/>420_<wbr/>888 must also be available for IMPLEMENTATION_<wbr/>DEFINED.<wbr/></p>
15772 <p>This supercedes the following fields,<wbr/> which are now deprecated:</p>
15773 <ul>
15774 <li>availableFormats</li>
15775 <li>available[Processed,<wbr/>Raw,<wbr/>Jpeg]Sizes</li>
15776 </ul>
15777             </td>
15778           </tr>
15779
15780           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15781            <!-- end of entry -->
15782
15783
15784           <tr class="entry" id="static_android.scaler.croppingType">
15785             <td class="entry_name
15786              " rowspan="3">
15787               android.<wbr/>scaler.<wbr/>cropping<wbr/>Type
15788             </td>
15789             <td class="entry_type">
15790                 <span class="entry_type_name entry_type_name_enum">byte</span>
15791
15792               <span class="entry_type_visibility"> [public]</span>
15793
15794
15795               <span class="entry_type_hwlevel">[legacy] </span>
15796
15797
15798
15799                 <ul class="entry_type_enum">
15800                   <li>
15801                     <span class="entry_type_enum_name">CENTER_ONLY</span>
15802                     <span class="entry_type_enum_notes"><p>The camera device only supports centered crop regions.<wbr/></p></span>
15803                   </li>
15804                   <li>
15805                     <span class="entry_type_enum_name">FREEFORM</span>
15806                     <span class="entry_type_enum_notes"><p>The camera device supports arbitrarily chosen crop regions.<wbr/></p></span>
15807                   </li>
15808                 </ul>
15809
15810             </td> <!-- entry_type -->
15811
15812             <td class="entry_description">
15813               <p>The crop type that this camera device supports.<wbr/></p>
15814             </td>
15815
15816             <td class="entry_units">
15817             </td>
15818
15819             <td class="entry_range">
15820             </td>
15821
15822             <td class="entry_tags">
15823             </td>
15824
15825           </tr>
15826           <tr class="entries_header">
15827             <th class="th_details" colspan="5">Details</th>
15828           </tr>
15829           <tr class="entry_cont">
15830             <td class="entry_details" colspan="5">
15831               <p>When passing a non-centered crop region (<a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a>) to a camera
15832 device that only supports CENTER_<wbr/>ONLY cropping,<wbr/> the camera device will move the
15833 crop region to the center of the sensor active array (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>)
15834 and keep the crop region width and height unchanged.<wbr/> The camera device will return the
15835 final used crop region in metadata result <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a>.<wbr/></p>
15836 <p>Camera devices that support FREEFORM cropping will support any crop region that
15837 is inside of the active array.<wbr/> The camera device will apply the same crop region and
15838 return the final used crop region in capture result metadata <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a>.<wbr/></p>
15839 <p>FULL capability devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> <code>==</code> FULL) will support
15840 FREEFORM cropping.<wbr/> LEGACY capability devices will only support CENTER_<wbr/>ONLY cropping.<wbr/></p>
15841             </td>
15842           </tr>
15843
15844
15845           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15846            <!-- end of entry -->
15847
15848
15849
15850       <!-- end of kind -->
15851       </tbody>
15852       <tr><td colspan="6" class="kind">dynamic</td></tr>
15853
15854       <thead class="entries_header">
15855         <tr>
15856           <th class="th_name">Property Name</th>
15857           <th class="th_type">Type</th>
15858           <th class="th_description">Description</th>
15859           <th class="th_units">Units</th>
15860           <th class="th_range">Range</th>
15861           <th class="th_tags">Tags</th>
15862         </tr>
15863       </thead>
15864
15865       <tbody>
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876           <tr class="entry" id="dynamic_android.scaler.cropRegion">
15877             <td class="entry_name
15878              " rowspan="5">
15879               android.<wbr/>scaler.<wbr/>crop<wbr/>Region
15880             </td>
15881             <td class="entry_type">
15882                 <span class="entry_type_name">int32</span>
15883                 <span class="entry_type_container">x</span>
15884
15885                 <span class="entry_type_array">
15886                   4
15887                 </span>
15888               <span class="entry_type_visibility"> [public as rectangle]</span>
15889
15890
15891               <span class="entry_type_hwlevel">[legacy] </span>
15892
15893
15894
15895
15896             </td> <!-- entry_type -->
15897
15898             <td class="entry_description">
15899               <p>The desired region of the sensor to read out for this capture.<wbr/></p>
15900             </td>
15901
15902             <td class="entry_units">
15903               Pixel coordinates relative to
15904           android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
15905             </td>
15906
15907             <td class="entry_range">
15908             </td>
15909
15910             <td class="entry_tags">
15911               <ul class="entry_tags">
15912                   <li><a href="#tag_BC">BC</a></li>
15913               </ul>
15914             </td>
15915
15916           </tr>
15917           <tr class="entries_header">
15918             <th class="th_details" colspan="5">Details</th>
15919           </tr>
15920           <tr class="entry_cont">
15921             <td class="entry_details" colspan="5">
15922               <p>This control can be used to implement digital zoom.<wbr/></p>
15923 <p>The crop region coordinate system is based off
15924 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>,<wbr/> with <code>(0,<wbr/> 0)</code> being the
15925 top-left corner of the sensor active array.<wbr/></p>
15926 <p>Output streams use this rectangle to produce their output,<wbr/>
15927 cropping to a smaller region if necessary to maintain the
15928 stream's aspect ratio,<wbr/> then scaling the sensor input to
15929 match the output's configured resolution.<wbr/></p>
15930 <p>The crop region is applied after the RAW to other color
15931 space (e.<wbr/>g.<wbr/> YUV) conversion.<wbr/> Since raw streams
15932 (e.<wbr/>g.<wbr/> RAW16) don't have the conversion stage,<wbr/> they are not
15933 croppable.<wbr/> The crop region will be ignored by raw streams.<wbr/></p>
15934 <p>For non-raw streams,<wbr/> any additional per-stream cropping will
15935 be done to maximize the final pixel area of the stream.<wbr/></p>
15936 <p>For example,<wbr/> if the crop region is set to a 4:3 aspect
15937 ratio,<wbr/> then 4:3 streams will use the exact crop
15938 region.<wbr/> 16:9 streams will further crop vertically
15939 (letterbox).<wbr/></p>
15940 <p>Conversely,<wbr/> if the crop region is set to a 16:9,<wbr/> then 4:3
15941 outputs will crop horizontally (pillarbox),<wbr/> and 16:9
15942 streams will match exactly.<wbr/> These additional crops will
15943 be centered within the crop region.<wbr/></p>
15944 <p>The width and height of the crop region cannot
15945 be set to be smaller than
15946 <code>floor( activeArraySize.<wbr/>width /<wbr/> <a href="#static_android.scaler.availableMaxDigitalZoom">android.<wbr/>scaler.<wbr/>available<wbr/>Max<wbr/>Digital<wbr/>Zoom</a> )</code> and
15947 <code>floor( activeArraySize.<wbr/>height /<wbr/> <a href="#static_android.scaler.availableMaxDigitalZoom">android.<wbr/>scaler.<wbr/>available<wbr/>Max<wbr/>Digital<wbr/>Zoom</a> )</code>,<wbr/> respectively.<wbr/></p>
15948 <p>The camera device may adjust the crop region to account
15949 for rounding and other hardware requirements; the final
15950 crop region used will be included in the output capture
15951 result.<wbr/></p>
15952             </td>
15953           </tr>
15954
15955           <tr class="entries_header">
15956             <th class="th_details" colspan="5">HAL Implementation Details</th>
15957           </tr>
15958           <tr class="entry_cont">
15959             <td class="entry_details" colspan="5">
15960               <p>The output streams must maintain square pixels at all
15961 times,<wbr/> no matter what the relative aspect ratios of the
15962 crop region and the stream are.<wbr/>  Negative values for
15963 corner are allowed for raw output if full pixel array is
15964 larger than active pixel array.<wbr/> Width and height may be
15965 rounded to nearest larger supportable width,<wbr/> especially
15966 for raw output,<wbr/> where only a few fixed scales may be
15967 possible.<wbr/></p>
15968 <p>HAL2.<wbr/>x uses only (x,<wbr/> y,<wbr/> width)</p>
15969             </td>
15970           </tr>
15971
15972           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15973            <!-- end of entry -->
15974
15975
15976
15977       <!-- end of kind -->
15978       </tbody>
15979
15980   <!-- end of section -->
15981   <tr><td colspan="6" id="section_sensor" class="section">sensor</td></tr>
15982
15983
15984       <tr><td colspan="6" class="kind">controls</td></tr>
15985
15986       <thead class="entries_header">
15987         <tr>
15988           <th class="th_name">Property Name</th>
15989           <th class="th_type">Type</th>
15990           <th class="th_description">Description</th>
15991           <th class="th_units">Units</th>
15992           <th class="th_range">Range</th>
15993           <th class="th_tags">Tags</th>
15994         </tr>
15995       </thead>
15996
15997       <tbody>
15998
15999
16000
16001
16002
16003
16004
16005
16006
16007
16008           <tr class="entry" id="controls_android.sensor.exposureTime">
16009             <td class="entry_name
16010              " rowspan="3">
16011               android.<wbr/>sensor.<wbr/>exposure<wbr/>Time
16012             </td>
16013             <td class="entry_type">
16014                 <span class="entry_type_name">int64</span>
16015
16016               <span class="entry_type_visibility"> [public]</span>
16017
16018
16019               <span class="entry_type_hwlevel">[full] </span>
16020
16021
16022
16023
16024             </td> <!-- entry_type -->
16025
16026             <td class="entry_description">
16027               <p>Duration each pixel is exposed to
16028 light.<wbr/></p>
16029             </td>
16030
16031             <td class="entry_units">
16032               Nanoseconds
16033             </td>
16034
16035             <td class="entry_range">
16036               <p><a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a></p>
16037             </td>
16038
16039             <td class="entry_tags">
16040               <ul class="entry_tags">
16041                   <li><a href="#tag_V1">V1</a></li>
16042               </ul>
16043             </td>
16044
16045           </tr>
16046           <tr class="entries_header">
16047             <th class="th_details" colspan="5">Details</th>
16048           </tr>
16049           <tr class="entry_cont">
16050             <td class="entry_details" colspan="5">
16051               <p>If the sensor can't expose this exact duration,<wbr/> it will shorten the
16052 duration exposed to the nearest possible value (rather than expose longer).<wbr/>
16053 The final exposure time used will be available in the output capture result.<wbr/></p>
16054 <p>This control is only effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is set to
16055 OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
16056             </td>
16057           </tr>
16058
16059
16060           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16061            <!-- end of entry -->
16062
16063
16064           <tr class="entry" id="controls_android.sensor.frameDuration">
16065             <td class="entry_name
16066              " rowspan="5">
16067               android.<wbr/>sensor.<wbr/>frame<wbr/>Duration
16068             </td>
16069             <td class="entry_type">
16070                 <span class="entry_type_name">int64</span>
16071
16072               <span class="entry_type_visibility"> [public]</span>
16073
16074
16075               <span class="entry_type_hwlevel">[full] </span>
16076
16077
16078
16079
16080             </td> <!-- entry_type -->
16081
16082             <td class="entry_description">
16083               <p>Duration from start of frame exposure to
16084 start of next frame exposure.<wbr/></p>
16085             </td>
16086
16087             <td class="entry_units">
16088               Nanoseconds
16089             </td>
16090
16091             <td class="entry_range">
16092               <p>See <a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a>,<wbr/>
16093 <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/> The duration
16094 is capped to <code>max(duration,<wbr/> exposureTime + overhead)</code>.<wbr/></p>
16095             </td>
16096
16097             <td class="entry_tags">
16098               <ul class="entry_tags">
16099                   <li><a href="#tag_V1">V1</a></li>
16100               </ul>
16101             </td>
16102
16103           </tr>
16104           <tr class="entries_header">
16105             <th class="th_details" colspan="5">Details</th>
16106           </tr>
16107           <tr class="entry_cont">
16108             <td class="entry_details" colspan="5">
16109               <p>The maximum frame rate that can be supported by a camera subsystem is
16110 a function of many factors:</p>
16111 <ul>
16112 <li>Requested resolutions of output image streams</li>
16113 <li>Availability of binning /<wbr/> skipping modes on the imager</li>
16114 <li>The bandwidth of the imager interface</li>
16115 <li>The bandwidth of the various ISP processing blocks</li>
16116 </ul>
16117 <p>Since these factors can vary greatly between different ISPs and
16118 sensors,<wbr/> the camera abstraction tries to represent the bandwidth
16119 restrictions with as simple a model as possible.<wbr/></p>
16120 <p>The model presented has the following characteristics:</p>
16121 <ul>
16122 <li>The image sensor is always configured to output the smallest
16123 resolution possible given the application's requested output stream
16124 sizes.<wbr/>  The smallest resolution is defined as being at least as large
16125 as the largest requested output stream size; the camera pipeline must
16126 never digitally upsample sensor data when the crop region covers the
16127 whole sensor.<wbr/> In general,<wbr/> this means that if only small output stream
16128 resolutions are configured,<wbr/> the sensor can provide a higher frame
16129 rate.<wbr/></li>
16130 <li>Since any request may use any or all the currently configured
16131 output streams,<wbr/> the sensor and ISP must be configured to support
16132 scaling a single capture to all the streams at the same time.<wbr/>  This
16133 means the camera pipeline must be ready to produce the largest
16134 requested output size without any delay.<wbr/>  Therefore,<wbr/> the overall
16135 frame rate of a given configured stream set is governed only by the
16136 largest requested stream resolution.<wbr/></li>
16137 <li>Using more than one output stream in a request does not affect the
16138 frame duration.<wbr/></li>
16139 <li>Certain format-streams may need to do additional background processing
16140 before data is consumed/<wbr/>produced by that stream.<wbr/> These processors
16141 can run concurrently to the rest of the camera pipeline,<wbr/> but
16142 cannot process more than 1 capture at a time.<wbr/></li>
16143 </ul>
16144 <p>The necessary information for the application,<wbr/> given the model above,<wbr/>
16145 is provided via the <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> field
16146 using StreamConfigurationMap#getOutputMinFrameDuration(int,<wbr/> Size).<wbr/>
16147 These are used to determine the maximum frame rate /<wbr/> minimum frame
16148 duration that is possible for a given stream configuration.<wbr/></p>
16149 <p>Specifically,<wbr/> the application can use the following rules to
16150 determine the minimum frame duration it can request from the camera
16151 device:</p>
16152 <ol>
16153 <li>Let the set of currently configured input/<wbr/>output streams
16154 be called <code>S</code>.<wbr/></li>
16155 <li>Find the minimum frame durations for each stream in <code>S</code>,<wbr/> by
16156 looking it up in <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> using
16157 StreamConfigurationMap#getOutputMinFrameDuration(int,<wbr/> Size) (with
16158 its respective size/<wbr/>format).<wbr/> Let this set of frame durations be called
16159 <code>F</code>.<wbr/></li>
16160 <li>For any given request <code>R</code>,<wbr/> the minimum frame duration allowed
16161 for <code>R</code> is the maximum out of all values in <code>F</code>.<wbr/> Let the streams
16162 used in <code>R</code> be called <code>S_<wbr/>r</code>.<wbr/></li>
16163 </ol>
16164 <p>If none of the streams in <code>S_<wbr/>r</code> have a stall time (listed in
16165 StreamConfigurationMap#getOutputStallDuration(int,<wbr/>Size) using its
16166 respective size/<wbr/>format),<wbr/> then the frame duration in
16167 <code>F</code> determines the steady state frame rate that the application will
16168 get if it uses <code>R</code> as a repeating request.<wbr/> Let this special kind
16169 of request be called <code>Rsimple</code>.<wbr/></p>
16170 <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved
16171 by a single capture of a new request <code>Rstall</code> (which has at least
16172 one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the
16173 same minimum frame duration this will not cause a frame rate loss
16174 if all buffers from the previous <code>Rstall</code> have already been
16175 delivered.<wbr/></p>
16176 <p>For more details about stalling,<wbr/> see
16177 StreamConfigurationMap#getOutputStallDuration(int,<wbr/>Size).<wbr/></p>
16178 <p>This control is only effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is set to
16179 OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
16180             </td>
16181           </tr>
16182
16183           <tr class="entries_header">
16184             <th class="th_details" colspan="5">HAL Implementation Details</th>
16185           </tr>
16186           <tr class="entry_cont">
16187             <td class="entry_details" colspan="5">
16188               <p>For more details about stalling,<wbr/> see
16189 <a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a>.<wbr/></p>
16190             </td>
16191           </tr>
16192
16193           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16194            <!-- end of entry -->
16195
16196
16197           <tr class="entry" id="controls_android.sensor.sensitivity">
16198             <td class="entry_name
16199              " rowspan="5">
16200               android.<wbr/>sensor.<wbr/>sensitivity
16201             </td>
16202             <td class="entry_type">
16203                 <span class="entry_type_name">int32</span>
16204
16205               <span class="entry_type_visibility"> [public]</span>
16206
16207
16208               <span class="entry_type_hwlevel">[full] </span>
16209
16210
16211
16212
16213             </td> <!-- entry_type -->
16214
16215             <td class="entry_description">
16216               <p>The amount of gain applied to sensor data
16217 before processing.<wbr/></p>
16218             </td>
16219
16220             <td class="entry_units">
16221               ISO arithmetic units
16222             </td>
16223
16224             <td class="entry_range">
16225               <p><a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a></p>
16226             </td>
16227
16228             <td class="entry_tags">
16229               <ul class="entry_tags">
16230                   <li><a href="#tag_V1">V1</a></li>
16231               </ul>
16232             </td>
16233
16234           </tr>
16235           <tr class="entries_header">
16236             <th class="th_details" colspan="5">Details</th>
16237           </tr>
16238           <tr class="entry_cont">
16239             <td class="entry_details" colspan="5">
16240               <p>The sensitivity is the standard ISO sensitivity value,<wbr/>
16241 as defined in ISO 12232:2006.<wbr/></p>
16242 <p>The sensitivity must be within <a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a>,<wbr/> and
16243 if if it less than <a href="#static_android.sensor.maxAnalogSensitivity">android.<wbr/>sensor.<wbr/>max<wbr/>Analog<wbr/>Sensitivity</a>,<wbr/> the camera device
16244 is guaranteed to use only analog amplification for applying the gain.<wbr/></p>
16245 <p>If the camera device cannot apply the exact sensitivity
16246 requested,<wbr/> it will reduce the gain to the nearest supported
16247 value.<wbr/> The final sensitivity used will be available in the
16248 output capture result.<wbr/></p>
16249             </td>
16250           </tr>
16251
16252           <tr class="entries_header">
16253             <th class="th_details" colspan="5">HAL Implementation Details</th>
16254           </tr>
16255           <tr class="entry_cont">
16256             <td class="entry_details" colspan="5">
16257               <p>ISO 12232:2006 REI method is acceptable.<wbr/></p>
16258             </td>
16259           </tr>
16260
16261           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16262            <!-- end of entry -->
16263
16264
16265           <tr class="entry" id="controls_android.sensor.testPatternData">
16266             <td class="entry_name
16267              " rowspan="5">
16268               android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Data
16269             </td>
16270             <td class="entry_type">
16271                 <span class="entry_type_name">int32</span>
16272                 <span class="entry_type_container">x</span>
16273
16274                 <span class="entry_type_array">
16275                   4
16276                 </span>
16277               <span class="entry_type_visibility"> [public]</span>
16278
16279
16280
16281
16282
16283
16284             </td> <!-- entry_type -->
16285
16286             <td class="entry_description">
16287               <p>A pixel <code>[R,<wbr/> G_<wbr/>even,<wbr/> G_<wbr/>odd,<wbr/> B]</code> that supplies the test pattern
16288 when <a href="#controls_android.sensor.testPatternMode">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode</a> is SOLID_<wbr/>COLOR.<wbr/></p>
16289             </td>
16290
16291             <td class="entry_units">
16292             </td>
16293
16294             <td class="entry_range">
16295             </td>
16296
16297             <td class="entry_tags">
16298             </td>
16299
16300           </tr>
16301           <tr class="entries_header">
16302             <th class="th_details" colspan="5">Details</th>
16303           </tr>
16304           <tr class="entry_cont">
16305             <td class="entry_details" colspan="5">
16306               <p>Each color channel is treated as an unsigned 32-bit integer.<wbr/>
16307 The camera device then uses the most significant X bits
16308 that correspond to how many bits are in its Bayer raw sensor
16309 output.<wbr/></p>
16310 <p>For example,<wbr/> a sensor with RAW10 Bayer output would use the
16311 10 most significant bits from each color channel.<wbr/></p>
16312             </td>
16313           </tr>
16314
16315           <tr class="entries_header">
16316             <th class="th_details" colspan="5">HAL Implementation Details</th>
16317           </tr>
16318           <tr class="entry_cont">
16319             <td class="entry_details" colspan="5">
16320
16321             </td>
16322           </tr>
16323
16324           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16325            <!-- end of entry -->
16326
16327
16328           <tr class="entry" id="controls_android.sensor.testPatternMode">
16329             <td class="entry_name
16330              " rowspan="5">
16331               android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode
16332             </td>
16333             <td class="entry_type">
16334                 <span class="entry_type_name entry_type_name_enum">int32</span>
16335
16336               <span class="entry_type_visibility"> [public]</span>
16337
16338
16339
16340
16341
16342                 <ul class="entry_type_enum">
16343                   <li>
16344                     <span class="entry_type_enum_name">OFF</span>
16345                     <span class="entry_type_enum_notes"><p>No test pattern mode is used,<wbr/> and the camera
16346 device returns captures from the image sensor.<wbr/></p>
16347 <p>This is the default if the key is not set.<wbr/></p></span>
16348                   </li>
16349                   <li>
16350                     <span class="entry_type_enum_name">SOLID_COLOR</span>
16351                     <span class="entry_type_enum_notes"><p>Each pixel in <code>[R,<wbr/> G_<wbr/>even,<wbr/> G_<wbr/>odd,<wbr/> B]</code> is replaced by its
16352 respective color channel provided in
16353 <a href="#controls_android.sensor.testPatternData">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Data</a>.<wbr/></p>
16354 <p>For example:</p>
16355 <pre><code>android.<wbr/>testPatternData = [0,<wbr/> 0xFFFFFFFF,<wbr/> 0xFFFFFFFF,<wbr/> 0]
16356 </code></pre>
16357 <p>All green pixels are 100% green.<wbr/> All red/<wbr/>blue pixels are black.<wbr/></p>
16358 <pre><code>android.<wbr/>testPatternData = [0xFFFFFFFF,<wbr/> 0,<wbr/> 0xFFFFFFFF,<wbr/> 0]
16359 </code></pre>
16360 <p>All red pixels are 100% red.<wbr/> Only the odd green pixels
16361 are 100% green.<wbr/> All blue pixels are 100% black.<wbr/></p></span>
16362                   </li>
16363                   <li>
16364                     <span class="entry_type_enum_name">COLOR_BARS</span>
16365                     <span class="entry_type_enum_notes"><p>All pixel data is replaced with an 8-bar color pattern.<wbr/></p>
16366 <p>The vertical bars (left-to-right) are as follows:</p>
16367 <ul>
16368 <li>100% white</li>
16369 <li>yellow</li>
16370 <li>cyan</li>
16371 <li>green</li>
16372 <li>magenta</li>
16373 <li>red</li>
16374 <li>blue</li>
16375 <li>black</li>
16376 </ul>
16377 <p>In general the image would look like the following:</p>
16378 <pre><code>W Y C G M R B K
16379 W Y C G M R B K
16380 W Y C G M R B K
16381 W Y C G M R B K
16382 W Y C G M R B K
16383 .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
16384 .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
16385 .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
16386
16387 (B = Blue,<wbr/> K = Black)
16388 </code></pre>
16389 <p>Each bar should take up 1/<wbr/>8 of the sensor pixel array width.<wbr/>
16390 When this is not possible,<wbr/> the bar size should be rounded
16391 down to the nearest integer and the pattern can repeat
16392 on the right side.<wbr/></p>
16393 <p>Each bar's height must always take up the full sensor
16394 pixel array height.<wbr/></p>
16395 <p>Each pixel in this test pattern must be set to either
16396 0% intensity or 100% intensity.<wbr/></p></span>
16397                   </li>
16398                   <li>
16399                     <span class="entry_type_enum_name">COLOR_BARS_FADE_TO_GRAY</span>
16400                     <span class="entry_type_enum_notes"><p>The test pattern is similar to COLOR_<wbr/>BARS,<wbr/> except that
16401 each bar should start at its specified color at the top,<wbr/>
16402 and fade to gray at the bottom.<wbr/></p>
16403 <p>Furthermore each bar is further subdivided into a left and
16404 right half.<wbr/> The left half should have a smooth gradient,<wbr/>
16405 and the right half should have a quantized gradient.<wbr/></p>
16406 <p>In particular,<wbr/> the right half's should consist of blocks of the
16407 same color for 1/<wbr/>16th active sensor pixel array width.<wbr/></p>
16408 <p>The least significant bits in the quantized gradient should
16409 be copied from the most significant bits of the smooth gradient.<wbr/></p>
16410 <p>The height of each bar should always be a multiple of 128.<wbr/>
16411 When this is not the case,<wbr/> the pattern should repeat at the bottom
16412 of the image.<wbr/></p></span>
16413                   </li>
16414                   <li>
16415                     <span class="entry_type_enum_name">PN9</span>
16416                     <span class="entry_type_enum_notes"><p>All pixel data is replaced by a pseudo-random sequence
16417 generated from a PN9 512-bit sequence (typically implemented
16418 in hardware with a linear feedback shift register).<wbr/></p>
16419 <p>The generator should be reset at the beginning of each frame,<wbr/>
16420 and thus each subsequent raw frame with this test pattern should
16421 be exactly the same as the last.<wbr/></p></span>
16422                   </li>
16423                   <li>
16424                     <span class="entry_type_enum_name">CUSTOM1</span>
16425                     <span class="entry_type_enum_value">256</span>
16426                     <span class="entry_type_enum_notes"><p>The first custom test pattern.<wbr/> All custom patterns that are
16427 available only on this camera device are at least this numeric
16428 value.<wbr/></p>
16429 <p>All of the custom test patterns will be static
16430 (that is the raw image must not vary from frame to frame).<wbr/></p></span>
16431                   </li>
16432                 </ul>
16433
16434             </td> <!-- entry_type -->
16435
16436             <td class="entry_description">
16437               <p>When enabled,<wbr/> the sensor sends a test pattern instead of
16438 doing a real exposure from the camera.<wbr/></p>
16439             </td>
16440
16441             <td class="entry_units">
16442             </td>
16443
16444             <td class="entry_range">
16445               <p><a href="#static_android.sensor.availableTestPatternModes">android.<wbr/>sensor.<wbr/>available<wbr/>Test<wbr/>Pattern<wbr/>Modes</a></p>
16446             </td>
16447
16448             <td class="entry_tags">
16449             </td>
16450
16451           </tr>
16452           <tr class="entries_header">
16453             <th class="th_details" colspan="5">Details</th>
16454           </tr>
16455           <tr class="entry_cont">
16456             <td class="entry_details" colspan="5">
16457               <p>When a test pattern is enabled,<wbr/> all manual sensor controls specified
16458 by android.<wbr/>sensor.<wbr/>* will be ignored.<wbr/> All other controls should
16459 work as normal.<wbr/></p>
16460 <p>For example,<wbr/> if manual flash is enabled,<wbr/> flash firing should still
16461 occur (and that the test pattern remain unmodified,<wbr/> since the flash
16462 would not actually affect it).<wbr/></p>
16463 <p>Defaults to OFF.<wbr/></p>
16464             </td>
16465           </tr>
16466
16467           <tr class="entries_header">
16468             <th class="th_details" colspan="5">HAL Implementation Details</th>
16469           </tr>
16470           <tr class="entry_cont">
16471             <td class="entry_details" colspan="5">
16472               <p>All test patterns are specified in the Bayer domain.<wbr/></p>
16473 <p>The HAL may choose to substitute test patterns from the sensor
16474 with test patterns from on-device memory.<wbr/> In that case,<wbr/> it should be
16475 indistinguishable to the ISP whether the data came from the
16476 sensor interconnect bus (such as CSI2) or memory.<wbr/></p>
16477             </td>
16478           </tr>
16479
16480           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16481            <!-- end of entry -->
16482
16483
16484
16485       <!-- end of kind -->
16486       </tbody>
16487       <tr><td colspan="6" class="kind">static</td></tr>
16488
16489       <thead class="entries_header">
16490         <tr>
16491           <th class="th_name">Property Name</th>
16492           <th class="th_type">Type</th>
16493           <th class="th_description">Description</th>
16494           <th class="th_units">Units</th>
16495           <th class="th_range">Range</th>
16496           <th class="th_tags">Tags</th>
16497         </tr>
16498       </thead>
16499
16500       <tbody>
16501
16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513           <tr class="entry" id="static_android.sensor.info.activeArraySize">
16514             <td class="entry_name
16515              " rowspan="5">
16516               android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
16517             </td>
16518             <td class="entry_type">
16519                 <span class="entry_type_name">int32</span>
16520                 <span class="entry_type_container">x</span>
16521
16522                 <span class="entry_type_array">
16523                   4
16524                 </span>
16525               <span class="entry_type_visibility"> [public as rectangle]</span>
16526
16527
16528               <span class="entry_type_hwlevel">[legacy] </span>
16529
16530
16531                 <div class="entry_type_notes">Four ints defining the active pixel rectangle</div>
16532
16533
16534             </td> <!-- entry_type -->
16535
16536             <td class="entry_description">
16537               <p>The area of the image sensor which corresponds to
16538 active pixels.<wbr/></p>
16539             </td>
16540
16541             <td class="entry_units">
16542               Pixel coordinates on the image sensor
16543             </td>
16544
16545             <td class="entry_range">
16546
16547             </td>
16548
16549             <td class="entry_tags">
16550               <ul class="entry_tags">
16551                   <li><a href="#tag_RAW">RAW</a></li>
16552               </ul>
16553             </td>
16554
16555           </tr>
16556           <tr class="entries_header">
16557             <th class="th_details" colspan="5">Details</th>
16558           </tr>
16559           <tr class="entry_cont">
16560             <td class="entry_details" colspan="5">
16561               <p>This is the region of the sensor that actually receives light from the scene.<wbr/>
16562 Therefore,<wbr/> the size of this region determines the maximum field of view and the maximum
16563 number of pixels that an image from this sensor can contain.<wbr/></p>
16564 <p>The rectangle is defined in terms of the full pixel array; (0,<wbr/>0) is the top-left of the
16565 full pixel array,<wbr/> and the size of the full pixel array is given by
16566 <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/></p>
16567 <p>Most other keys listing pixel coordinates have their coordinate systems based on the
16568 active array,<wbr/> with <code>(0,<wbr/> 0)</code> being the top-left of the active array rectangle.<wbr/></p>
16569 <p>The active array may be smaller than the full pixel array,<wbr/> since the full array may
16570 include black calibration pixels or other inactive regions.<wbr/></p>
16571             </td>
16572           </tr>
16573
16574           <tr class="entries_header">
16575             <th class="th_details" colspan="5">HAL Implementation Details</th>
16576           </tr>
16577           <tr class="entry_cont">
16578             <td class="entry_details" colspan="5">
16579               <p>This array contains <code>(xmin,<wbr/> ymin,<wbr/> width,<wbr/> height)</code>.<wbr/> The <code>(xmin,<wbr/> ymin)</code> must be
16580 &gt;= <code>(0,<wbr/>0)</code>.<wbr/>
16581 The <code>(width,<wbr/> height)</code> must be &lt;= <code><a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a></code>.<wbr/></p>
16582             </td>
16583           </tr>
16584
16585           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16586            <!-- end of entry -->
16587
16588
16589           <tr class="entry" id="static_android.sensor.info.sensitivityRange">
16590             <td class="entry_name
16591              " rowspan="3">
16592               android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range
16593             </td>
16594             <td class="entry_type">
16595                 <span class="entry_type_name">int32</span>
16596                 <span class="entry_type_container">x</span>
16597
16598                 <span class="entry_type_array">
16599                   2
16600                 </span>
16601               <span class="entry_type_visibility"> [public as rangeInt]</span>
16602
16603
16604               <span class="entry_type_hwlevel">[full] </span>
16605
16606
16607                 <div class="entry_type_notes">Range of supported sensitivities</div>
16608
16609
16610             </td> <!-- entry_type -->
16611
16612             <td class="entry_description">
16613               <p>Range of sensitivities for <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a> supported by this
16614 camera device.<wbr/></p>
16615             </td>
16616
16617             <td class="entry_units">
16618             </td>
16619
16620             <td class="entry_range">
16621               <p>Min &lt;= 100,<wbr/> Max &gt;= 800</p>
16622             </td>
16623
16624             <td class="entry_tags">
16625               <ul class="entry_tags">
16626                   <li><a href="#tag_BC">BC</a></li>
16627                   <li><a href="#tag_V1">V1</a></li>
16628               </ul>
16629             </td>
16630
16631           </tr>
16632           <tr class="entries_header">
16633             <th class="th_details" colspan="5">Details</th>
16634           </tr>
16635           <tr class="entry_cont">
16636             <td class="entry_details" colspan="5">
16637               <p>The values are the standard ISO sensitivity values,<wbr/>
16638 as defined in ISO 12232:2006.<wbr/></p>
16639             </td>
16640           </tr>
16641
16642
16643           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16644            <!-- end of entry -->
16645
16646
16647           <tr class="entry" id="static_android.sensor.info.colorFilterArrangement">
16648             <td class="entry_name
16649              " rowspan="1">
16650               android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement
16651             </td>
16652             <td class="entry_type">
16653                 <span class="entry_type_name entry_type_name_enum">byte</span>
16654
16655               <span class="entry_type_visibility"> [public]</span>
16656
16657
16658               <span class="entry_type_hwlevel">[full] </span>
16659
16660
16661
16662                 <ul class="entry_type_enum">
16663                   <li>
16664                     <span class="entry_type_enum_name">RGGB</span>
16665                   </li>
16666                   <li>
16667                     <span class="entry_type_enum_name">GRBG</span>
16668                   </li>
16669                   <li>
16670                     <span class="entry_type_enum_name">GBRG</span>
16671                   </li>
16672                   <li>
16673                     <span class="entry_type_enum_name">BGGR</span>
16674                   </li>
16675                   <li>
16676                     <span class="entry_type_enum_name">RGB</span>
16677                     <span class="entry_type_enum_notes"><p>Sensor is not Bayer; output has 3 16-bit
16678 values for each pixel,<wbr/> instead of just 1 16-bit value
16679 per pixel.<wbr/></p></span>
16680                   </li>
16681                 </ul>
16682
16683             </td> <!-- entry_type -->
16684
16685             <td class="entry_description">
16686               <p>The arrangement of color filters on sensor;
16687 represents the colors in the top-left 2x2 section of
16688 the sensor,<wbr/> in reading order.<wbr/></p>
16689             </td>
16690
16691             <td class="entry_units">
16692             </td>
16693
16694             <td class="entry_range">
16695             </td>
16696
16697             <td class="entry_tags">
16698               <ul class="entry_tags">
16699                   <li><a href="#tag_RAW">RAW</a></li>
16700               </ul>
16701             </td>
16702
16703           </tr>
16704
16705
16706           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16707            <!-- end of entry -->
16708
16709
16710           <tr class="entry" id="static_android.sensor.info.exposureTimeRange">
16711             <td class="entry_name
16712              " rowspan="3">
16713               android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range
16714             </td>
16715             <td class="entry_type">
16716                 <span class="entry_type_name">int64</span>
16717                 <span class="entry_type_container">x</span>
16718
16719                 <span class="entry_type_array">
16720                   2
16721                 </span>
16722               <span class="entry_type_visibility"> [public as rangeLong]</span>
16723
16724
16725               <span class="entry_type_hwlevel">[full] </span>
16726
16727
16728                 <div class="entry_type_notes">nanoseconds</div>
16729
16730
16731             </td> <!-- entry_type -->
16732
16733             <td class="entry_description">
16734               <p>The range of image exposure times for <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a> supported
16735 by this camera device.<wbr/></p>
16736             </td>
16737
16738             <td class="entry_units">
16739               Nanoseconds
16740             </td>
16741
16742             <td class="entry_range">
16743               <p>The minimum exposure time will be less than 100 us.<wbr/> For FULL
16744 capability devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL),<wbr/>
16745 the maximum exposure time will be greater than 100ms.<wbr/></p>
16746             </td>
16747
16748             <td class="entry_tags">
16749               <ul class="entry_tags">
16750                   <li><a href="#tag_V1">V1</a></li>
16751               </ul>
16752             </td>
16753
16754           </tr>
16755
16756           <tr class="entries_header">
16757             <th class="th_details" colspan="5">HAL Implementation Details</th>
16758           </tr>
16759           <tr class="entry_cont">
16760             <td class="entry_details" colspan="5">
16761               <p>For FULL capability devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL),<wbr/>
16762 The maximum of the range SHOULD be at least 1 second (1e9),<wbr/> MUST be at least
16763 100ms.<wbr/></p>
16764             </td>
16765           </tr>
16766
16767           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16768            <!-- end of entry -->
16769
16770
16771           <tr class="entry" id="static_android.sensor.info.maxFrameDuration">
16772             <td class="entry_name
16773              " rowspan="5">
16774               android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration
16775             </td>
16776             <td class="entry_type">
16777                 <span class="entry_type_name">int64</span>
16778
16779               <span class="entry_type_visibility"> [public]</span>
16780
16781
16782               <span class="entry_type_hwlevel">[full] </span>
16783
16784
16785
16786
16787             </td> <!-- entry_type -->
16788
16789             <td class="entry_description">
16790               <p>The maximum possible frame duration (minimum frame rate) for
16791 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> that is supported this camera device.<wbr/></p>
16792             </td>
16793
16794             <td class="entry_units">
16795               Nanoseconds
16796             </td>
16797
16798             <td class="entry_range">
16799               <p>For FULL capability devices
16800 (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL),<wbr/> at least 100ms.<wbr/></p>
16801             </td>
16802
16803             <td class="entry_tags">
16804               <ul class="entry_tags">
16805                   <li><a href="#tag_V1">V1</a></li>
16806               </ul>
16807             </td>
16808
16809           </tr>
16810           <tr class="entries_header">
16811             <th class="th_details" colspan="5">Details</th>
16812           </tr>
16813           <tr class="entry_cont">
16814             <td class="entry_details" colspan="5">
16815               <p>Attempting to use frame durations beyond the maximum will result in the frame
16816 duration being clipped to the maximum.<wbr/> See that control for a full definition of frame
16817 durations.<wbr/></p>
16818 <p>Refer to StreamConfigurationMap#getOutputMinFrameDuration(int,<wbr/>Size) for the minimum
16819 frame duration values.<wbr/></p>
16820             </td>
16821           </tr>
16822
16823           <tr class="entries_header">
16824             <th class="th_details" colspan="5">HAL Implementation Details</th>
16825           </tr>
16826           <tr class="entry_cont">
16827             <td class="entry_details" colspan="5">
16828               <p>For FULL capability devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL),<wbr/>
16829 The maximum of the range SHOULD be at least
16830 1 second (1e9),<wbr/> MUST be at least 100ms (100e6).<wbr/></p>
16831 <p><a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a> must be greater or
16832 equal to the <a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a> max
16833 value (since exposure time overrides frame duration).<wbr/></p>
16834 <p>Available minimum frame durations for JPEG must be no greater
16835 than that of the YUV_<wbr/>420_<wbr/>888/<wbr/>IMPLEMENTATION_<wbr/>DEFINED
16836 minimum frame durations (for that respective size).<wbr/></p>
16837 <p>Since JPEG processing is considered offline and can take longer than
16838 a single uncompressed capture,<wbr/> refer to
16839 <a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a>
16840 for details about encoding this scenario.<wbr/></p>
16841             </td>
16842           </tr>
16843
16844           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16845            <!-- end of entry -->
16846
16847
16848           <tr class="entry" id="static_android.sensor.info.physicalSize">
16849             <td class="entry_name
16850              " rowspan="5">
16851               android.<wbr/>sensor.<wbr/>info.<wbr/>physical<wbr/>Size
16852             </td>
16853             <td class="entry_type">
16854                 <span class="entry_type_name">float</span>
16855                 <span class="entry_type_container">x</span>
16856
16857                 <span class="entry_type_array">
16858                   2
16859                 </span>
16860               <span class="entry_type_visibility"> [public as sizeF]</span>
16861
16862
16863               <span class="entry_type_hwlevel">[legacy] </span>
16864
16865
16866                 <div class="entry_type_notes">width x height</div>
16867
16868
16869             </td> <!-- entry_type -->
16870
16871             <td class="entry_description">
16872               <p>The physical dimensions of the full pixel
16873 array.<wbr/></p>
16874             </td>
16875
16876             <td class="entry_units">
16877               Millimeters
16878             </td>
16879
16880             <td class="entry_range">
16881             </td>
16882
16883             <td class="entry_tags">
16884               <ul class="entry_tags">
16885                   <li><a href="#tag_V1">V1</a></li>
16886                   <li><a href="#tag_BC">BC</a></li>
16887               </ul>
16888             </td>
16889
16890           </tr>
16891           <tr class="entries_header">
16892             <th class="th_details" colspan="5">Details</th>
16893           </tr>
16894           <tr class="entry_cont">
16895             <td class="entry_details" colspan="5">
16896               <p>This is the physical size of the sensor pixel
16897 array defined by <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/></p>
16898             </td>
16899           </tr>
16900
16901           <tr class="entries_header">
16902             <th class="th_details" colspan="5">HAL Implementation Details</th>
16903           </tr>
16904           <tr class="entry_cont">
16905             <td class="entry_details" colspan="5">
16906               <p>Needed for FOV calculation for old API</p>
16907             </td>
16908           </tr>
16909
16910           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16911            <!-- end of entry -->
16912
16913
16914           <tr class="entry" id="static_android.sensor.info.pixelArraySize">
16915             <td class="entry_name
16916              " rowspan="3">
16917               android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size
16918             </td>
16919             <td class="entry_type">
16920                 <span class="entry_type_name">int32</span>
16921                 <span class="entry_type_container">x</span>
16922
16923                 <span class="entry_type_array">
16924                   2
16925                 </span>
16926               <span class="entry_type_visibility"> [public as size]</span>
16927
16928
16929               <span class="entry_type_hwlevel">[legacy] </span>
16930
16931
16932
16933
16934             </td> <!-- entry_type -->
16935
16936             <td class="entry_description">
16937               <p>Dimensions of the full pixel array,<wbr/> possibly
16938 including black calibration pixels.<wbr/></p>
16939             </td>
16940
16941             <td class="entry_units">
16942               Pixels
16943             </td>
16944
16945             <td class="entry_range">
16946             </td>
16947
16948             <td class="entry_tags">
16949               <ul class="entry_tags">
16950                   <li><a href="#tag_RAW">RAW</a></li>
16951                   <li><a href="#tag_BC">BC</a></li>
16952               </ul>
16953             </td>
16954
16955           </tr>
16956           <tr class="entries_header">
16957             <th class="th_details" colspan="5">Details</th>
16958           </tr>
16959           <tr class="entry_cont">
16960             <td class="entry_details" colspan="5">
16961               <p>The pixel count of the full pixel array,<wbr/>
16962 which covers <a href="#static_android.sensor.info.physicalSize">android.<wbr/>sensor.<wbr/>info.<wbr/>physical<wbr/>Size</a> area.<wbr/></p>
16963 <p>If a camera device supports raw sensor formats,<wbr/> either this
16964 or <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a> is the maximum output
16965 raw size listed in <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/>
16966 If a size corresponding to pixelArraySize is listed,<wbr/> the resulting
16967 raw sensor image will include black pixels.<wbr/></p>
16968 <p>Some parts of the full pixel array may not receive light from the scene,<wbr/>
16969 or are otherwise inactive.<wbr/>  The <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a> key
16970 defines the rectangle of active pixels that actually forms an image.<wbr/></p>
16971             </td>
16972           </tr>
16973
16974
16975           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16976            <!-- end of entry -->
16977
16978
16979           <tr class="entry" id="static_android.sensor.info.whiteLevel">
16980             <td class="entry_name
16981              " rowspan="5">
16982               android.<wbr/>sensor.<wbr/>info.<wbr/>white<wbr/>Level
16983             </td>
16984             <td class="entry_type">
16985                 <span class="entry_type_name">int32</span>
16986
16987               <span class="entry_type_visibility"> [public]</span>
16988
16989
16990
16991
16992
16993
16994             </td> <!-- entry_type -->
16995
16996             <td class="entry_description">
16997               <p>Maximum raw value output by sensor.<wbr/></p>
16998             </td>
16999
17000             <td class="entry_units">
17001             </td>
17002
17003             <td class="entry_range">
17004               <p>&gt; 255 (8-bit output)</p>
17005             </td>
17006
17007             <td class="entry_tags">
17008               <ul class="entry_tags">
17009                   <li><a href="#tag_RAW">RAW</a></li>
17010               </ul>
17011             </td>
17012
17013           </tr>
17014           <tr class="entries_header">
17015             <th class="th_details" colspan="5">Details</th>
17016           </tr>
17017           <tr class="entry_cont">
17018             <td class="entry_details" colspan="5">
17019               <p>This specifies the fully-saturated encoding level for the raw
17020 sample values from the sensor.<wbr/>  This is typically caused by the
17021 sensor becoming highly non-linear or clipping.<wbr/> The minimum for
17022 each channel is specified by the offset in the
17023 <a href="#static_android.sensor.blackLevelPattern">android.<wbr/>sensor.<wbr/>black<wbr/>Level<wbr/>Pattern</a> key.<wbr/></p>
17024 <p>The white level is typically determined either by sensor bit depth
17025 (8-14 bits is expected),<wbr/> or by the point where the sensor response
17026 becomes too non-linear to be useful.<wbr/>  The default value for this is
17027 maximum representable value for a 16-bit raw sample (2^16 - 1).<wbr/></p>
17028             </td>
17029           </tr>
17030
17031           <tr class="entries_header">
17032             <th class="th_details" colspan="5">HAL Implementation Details</th>
17033           </tr>
17034           <tr class="entry_cont">
17035             <td class="entry_details" colspan="5">
17036               <p>The full bit depth of the sensor must be available in the raw data,<wbr/>
17037 so the value for linear sensors should not be significantly lower
17038 than maximum raw value supported,<wbr/> i.<wbr/>e.<wbr/> 2^(sensor bits per pixel).<wbr/></p>
17039             </td>
17040           </tr>
17041
17042           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17043            <!-- end of entry -->
17044
17045
17046           <tr class="entry" id="static_android.sensor.info.timestampSource">
17047             <td class="entry_name
17048              " rowspan="3">
17049               android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source
17050             </td>
17051             <td class="entry_type">
17052                 <span class="entry_type_name entry_type_name_enum">byte</span>
17053
17054               <span class="entry_type_visibility"> [public]</span>
17055
17056
17057               <span class="entry_type_hwlevel">[legacy] </span>
17058
17059
17060
17061                 <ul class="entry_type_enum">
17062                   <li>
17063                     <span class="entry_type_enum_name">UNKNOWN</span>
17064                     <span class="entry_type_enum_notes"><p>Timestamps from <a href="#dynamic_android.sensor.timestamp">android.<wbr/>sensor.<wbr/>timestamp</a> are in nanoseconds and monotonic,<wbr/>
17065 but can not be compared to timestamps from other subsystems
17066 (e.<wbr/>g.<wbr/> accelerometer,<wbr/> gyro etc.<wbr/>),<wbr/> or other instances of the same or different
17067 camera devices in the same system.<wbr/> Timestamps between streams and results for
17068 a single camera instance are comparable,<wbr/> and the timestamps for all buffers
17069 and the result metadata generated by a single capture are identical.<wbr/></p></span>
17070                   </li>
17071                   <li>
17072                     <span class="entry_type_enum_name">REALTIME</span>
17073                     <span class="entry_type_enum_notes"><p>Timestamps from <a href="#dynamic_android.sensor.timestamp">android.<wbr/>sensor.<wbr/>timestamp</a> are in the same timebase as
17074 android.<wbr/>os.<wbr/>System<wbr/>Clock#elapsed<wbr/>Realtime<wbr/>Nanos(),<wbr/>
17075 and they can be compared to other timestamps using that base.<wbr/></p></span>
17076                   </li>
17077                 </ul>
17078
17079             </td> <!-- entry_type -->
17080
17081             <td class="entry_description">
17082               <p>The time base source for sensor capture start timestamps.<wbr/></p>
17083             </td>
17084
17085             <td class="entry_units">
17086             </td>
17087
17088             <td class="entry_range">
17089             </td>
17090
17091             <td class="entry_tags">
17092               <ul class="entry_tags">
17093                   <li><a href="#tag_V1">V1</a></li>
17094               </ul>
17095             </td>
17096
17097           </tr>
17098           <tr class="entries_header">
17099             <th class="th_details" colspan="5">Details</th>
17100           </tr>
17101           <tr class="entry_cont">
17102             <td class="entry_details" colspan="5">
17103               <p>The timestamps provided for captures are always in nanoseconds and monotonic,<wbr/> but
17104 may not based on a time source that can be compared to other system time sources.<wbr/></p>
17105 <p>This characteristic defines the source for the timestamps,<wbr/> and therefore whether they
17106 can be compared against other system time sources/<wbr/>timestamps.<wbr/></p>
17107             </td>
17108           </tr>
17109
17110
17111           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17112            <!-- end of entry -->
17113
17114
17115
17116
17117
17118           <tr class="entry" id="static_android.sensor.referenceIlluminant1">
17119             <td class="entry_name
17120              " rowspan="5">
17121               android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1
17122             </td>
17123             <td class="entry_type">
17124                 <span class="entry_type_name entry_type_name_enum">byte</span>
17125
17126               <span class="entry_type_visibility"> [public]</span>
17127
17128
17129
17130
17131
17132                 <ul class="entry_type_enum">
17133                   <li>
17134                     <span class="entry_type_enum_name">DAYLIGHT</span>
17135                     <span class="entry_type_enum_value">1</span>
17136                   </li>
17137                   <li>
17138                     <span class="entry_type_enum_name">FLUORESCENT</span>
17139                     <span class="entry_type_enum_value">2</span>
17140                   </li>
17141                   <li>
17142                     <span class="entry_type_enum_name">TUNGSTEN</span>
17143                     <span class="entry_type_enum_value">3</span>
17144                     <span class="entry_type_enum_notes"><p>Incandescent light</p></span>
17145                   </li>
17146                   <li>
17147                     <span class="entry_type_enum_name">FLASH</span>
17148                     <span class="entry_type_enum_value">4</span>
17149                   </li>
17150                   <li>
17151                     <span class="entry_type_enum_name">FINE_WEATHER</span>
17152                     <span class="entry_type_enum_value">9</span>
17153                   </li>
17154                   <li>
17155                     <span class="entry_type_enum_name">CLOUDY_WEATHER</span>
17156                     <span class="entry_type_enum_value">10</span>
17157                   </li>
17158                   <li>
17159                     <span class="entry_type_enum_name">SHADE</span>
17160                     <span class="entry_type_enum_value">11</span>
17161                   </li>
17162                   <li>
17163                     <span class="entry_type_enum_name">DAYLIGHT_FLUORESCENT</span>
17164                     <span class="entry_type_enum_value">12</span>
17165                     <span class="entry_type_enum_notes"><p>D 5700 - 7100K</p></span>
17166                   </li>
17167                   <li>
17168                     <span class="entry_type_enum_name">DAY_WHITE_FLUORESCENT</span>
17169                     <span class="entry_type_enum_value">13</span>
17170                     <span class="entry_type_enum_notes"><p>N 4600 - 5400K</p></span>
17171                   </li>
17172                   <li>
17173                     <span class="entry_type_enum_name">COOL_WHITE_FLUORESCENT</span>
17174                     <span class="entry_type_enum_value">14</span>
17175                     <span class="entry_type_enum_notes"><p>W 3900 - 4500K</p></span>
17176                   </li>
17177                   <li>
17178                     <span class="entry_type_enum_name">WHITE_FLUORESCENT</span>
17179                     <span class="entry_type_enum_value">15</span>
17180                     <span class="entry_type_enum_notes"><p>WW 3200 - 3700K</p></span>
17181                   </li>
17182                   <li>
17183                     <span class="entry_type_enum_name">STANDARD_A</span>
17184                     <span class="entry_type_enum_value">17</span>
17185                   </li>
17186                   <li>
17187                     <span class="entry_type_enum_name">STANDARD_B</span>
17188                     <span class="entry_type_enum_value">18</span>
17189                   </li>
17190                   <li>
17191                     <span class="entry_type_enum_name">STANDARD_C</span>
17192                     <span class="entry_type_enum_value">19</span>
17193                   </li>
17194                   <li>
17195                     <span class="entry_type_enum_name">D55</span>
17196                     <span class="entry_type_enum_value">20</span>
17197                   </li>
17198                   <li>
17199                     <span class="entry_type_enum_name">D65</span>
17200                     <span class="entry_type_enum_value">21</span>
17201                   </li>
17202                   <li>
17203                     <span class="entry_type_enum_name">D75</span>
17204                     <span class="entry_type_enum_value">22</span>
17205                   </li>
17206                   <li>
17207                     <span class="entry_type_enum_name">D50</span>
17208                     <span class="entry_type_enum_value">23</span>
17209                   </li>
17210                   <li>
17211                     <span class="entry_type_enum_name">ISO_STUDIO_TUNGSTEN</span>
17212                     <span class="entry_type_enum_value">24</span>
17213                   </li>
17214                 </ul>
17215
17216             </td> <!-- entry_type -->
17217
17218             <td class="entry_description">
17219               <p>The standard reference illuminant used as the scene light source when
17220 calculating the <a href="#static_android.sensor.colorTransform1">android.<wbr/>sensor.<wbr/>color<wbr/>Transform1</a>,<wbr/>
17221 <a href="#static_android.sensor.calibrationTransform1">android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform1</a>,<wbr/> and
17222 <a href="#static_android.sensor.forwardMatrix1">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix1</a> matrices.<wbr/></p>
17223             </td>
17224
17225             <td class="entry_units">
17226             </td>
17227
17228             <td class="entry_range">
17229             </td>
17230
17231             <td class="entry_tags">
17232               <ul class="entry_tags">
17233                   <li><a href="#tag_RAW">RAW</a></li>
17234               </ul>
17235             </td>
17236
17237           </tr>
17238           <tr class="entries_header">
17239             <th class="th_details" colspan="5">Details</th>
17240           </tr>
17241           <tr class="entry_cont">
17242             <td class="entry_details" colspan="5">
17243               <p>The values in this key correspond to the values defined for the
17244 EXIF LightSource tag.<wbr/> These illuminants are standard light sources
17245 that are often used calibrating camera devices.<wbr/></p>
17246 <p>If this key is present,<wbr/> then <a href="#static_android.sensor.colorTransform1">android.<wbr/>sensor.<wbr/>color<wbr/>Transform1</a>,<wbr/>
17247 <a href="#static_android.sensor.calibrationTransform1">android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform1</a>,<wbr/> and
17248 <a href="#static_android.sensor.forwardMatrix1">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix1</a> will also be present.<wbr/></p>
17249 <p>Some devices may choose to provide a second set of calibration
17250 information for improved quality,<wbr/> including
17251 <a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a> and its corresponding matrices.<wbr/></p>
17252             </td>
17253           </tr>
17254
17255           <tr class="entries_header">
17256             <th class="th_details" colspan="5">HAL Implementation Details</th>
17257           </tr>
17258           <tr class="entry_cont">
17259             <td class="entry_details" colspan="5">
17260               <p>The first reference illuminant (<a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a>)
17261 and corresponding matrices must be present to support the RAW capability
17262 and DNG output.<wbr/></p>
17263 <p>When producing raw images with a color profile that has only been
17264 calibrated against a single light source,<wbr/> it is valid to omit
17265 <a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a> along with the
17266 <a href="#static_android.sensor.colorTransform2">android.<wbr/>sensor.<wbr/>color<wbr/>Transform2</a>,<wbr/> <a href="#static_android.sensor.calibrationTransform2">android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform2</a>,<wbr/>
17267 and <a href="#static_android.sensor.forwardMatrix2">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix2</a> matrices.<wbr/></p>
17268 <p>If only <a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a> is included,<wbr/> it should be
17269 chosen so that it is representative of typical scene lighting.<wbr/>  In
17270 general,<wbr/> D50 or DAYLIGHT will be chosen for this case.<wbr/></p>
17271 <p>If both <a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a> and
17272 <a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a> are included,<wbr/> they should be
17273 chosen to represent the typical range of scene lighting conditions.<wbr/>
17274 In general,<wbr/> low color temperature illuminant such as Standard-A will
17275 be chosen for the first reference illuminant and a higher color
17276 temperature illuminant such as D65 will be chosen for the second
17277 reference illuminant.<wbr/></p>
17278             </td>
17279           </tr>
17280
17281           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17282            <!-- end of entry -->
17283
17284
17285           <tr class="entry" id="static_android.sensor.referenceIlluminant2">
17286             <td class="entry_name
17287              " rowspan="3">
17288               android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2
17289             </td>
17290             <td class="entry_type">
17291                 <span class="entry_type_name">byte</span>
17292
17293               <span class="entry_type_visibility"> [public]</span>
17294
17295
17296
17297
17298
17299
17300             </td> <!-- entry_type -->
17301
17302             <td class="entry_description">
17303               <p>The standard reference illuminant used as the scene light source when
17304 calculating the <a href="#static_android.sensor.colorTransform2">android.<wbr/>sensor.<wbr/>color<wbr/>Transform2</a>,<wbr/>
17305 <a href="#static_android.sensor.calibrationTransform2">android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform2</a>,<wbr/> and
17306 <a href="#static_android.sensor.forwardMatrix2">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix2</a> matrices.<wbr/></p>
17307             </td>
17308
17309             <td class="entry_units">
17310             </td>
17311
17312             <td class="entry_range">
17313               <p>Any value listed in <a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a></p>
17314             </td>
17315
17316             <td class="entry_tags">
17317               <ul class="entry_tags">
17318                   <li><a href="#tag_RAW">RAW</a></li>
17319               </ul>
17320             </td>
17321
17322           </tr>
17323           <tr class="entries_header">
17324             <th class="th_details" colspan="5">Details</th>
17325           </tr>
17326           <tr class="entry_cont">
17327             <td class="entry_details" colspan="5">
17328               <p>See <a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a> for more details.<wbr/></p>
17329 <p>If this key is present,<wbr/> then <a href="#static_android.sensor.colorTransform2">android.<wbr/>sensor.<wbr/>color<wbr/>Transform2</a>,<wbr/>
17330 <a href="#static_android.sensor.calibrationTransform2">android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform2</a>,<wbr/> and
17331 <a href="#static_android.sensor.forwardMatrix2">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix2</a> will also be present.<wbr/></p>
17332             </td>
17333           </tr>
17334
17335
17336           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17337            <!-- end of entry -->
17338
17339
17340           <tr class="entry" id="static_android.sensor.calibrationTransform1">
17341             <td class="entry_name
17342              " rowspan="3">
17343               android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform1
17344             </td>
17345             <td class="entry_type">
17346                 <span class="entry_type_name">rational</span>
17347                 <span class="entry_type_container">x</span>
17348
17349                 <span class="entry_type_array">
17350                   3 x 3
17351                 </span>
17352               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
17353
17354
17355
17356
17357                 <div class="entry_type_notes">3x3 matrix in row-major-order</div>
17358
17359
17360             </td> <!-- entry_type -->
17361
17362             <td class="entry_description">
17363               <p>A per-device calibration transform matrix that maps from the
17364 reference sensor colorspace to the actual device sensor colorspace.<wbr/></p>
17365             </td>
17366
17367             <td class="entry_units">
17368             </td>
17369
17370             <td class="entry_range">
17371             </td>
17372
17373             <td class="entry_tags">
17374               <ul class="entry_tags">
17375                   <li><a href="#tag_RAW">RAW</a></li>
17376               </ul>
17377             </td>
17378
17379           </tr>
17380           <tr class="entries_header">
17381             <th class="th_details" colspan="5">Details</th>
17382           </tr>
17383           <tr class="entry_cont">
17384             <td class="entry_details" colspan="5">
17385               <p>This matrix is used to correct for per-device variations in the
17386 sensor colorspace,<wbr/> and is used for processing raw buffer data.<wbr/></p>
17387 <p>The matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and
17388 contains a per-device calibration transform that maps colors
17389 from reference sensor color space (i.<wbr/>e.<wbr/> the "golden module"
17390 colorspace) into this camera device's native sensor color
17391 space under the first reference illuminant
17392 (<a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a>).<wbr/></p>
17393             </td>
17394           </tr>
17395
17396
17397           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17398            <!-- end of entry -->
17399
17400
17401           <tr class="entry" id="static_android.sensor.calibrationTransform2">
17402             <td class="entry_name
17403              " rowspan="3">
17404               android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform2
17405             </td>
17406             <td class="entry_type">
17407                 <span class="entry_type_name">rational</span>
17408                 <span class="entry_type_container">x</span>
17409
17410                 <span class="entry_type_array">
17411                   3 x 3
17412                 </span>
17413               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
17414
17415
17416
17417
17418                 <div class="entry_type_notes">3x3 matrix in row-major-order</div>
17419
17420
17421             </td> <!-- entry_type -->
17422
17423             <td class="entry_description">
17424               <p>A per-device calibration transform matrix that maps from the
17425 reference sensor colorspace to the actual device sensor colorspace
17426 (this is the colorspace of the raw buffer data).<wbr/></p>
17427             </td>
17428
17429             <td class="entry_units">
17430             </td>
17431
17432             <td class="entry_range">
17433             </td>
17434
17435             <td class="entry_tags">
17436               <ul class="entry_tags">
17437                   <li><a href="#tag_RAW">RAW</a></li>
17438               </ul>
17439             </td>
17440
17441           </tr>
17442           <tr class="entries_header">
17443             <th class="th_details" colspan="5">Details</th>
17444           </tr>
17445           <tr class="entry_cont">
17446             <td class="entry_details" colspan="5">
17447               <p>This matrix is used to correct for per-device variations in the
17448 sensor colorspace,<wbr/> and is used for processing raw buffer data.<wbr/></p>
17449 <p>The matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and
17450 contains a per-device calibration transform that maps colors
17451 from reference sensor color space (i.<wbr/>e.<wbr/> the "golden module"
17452 colorspace) into this camera device's native sensor color
17453 space under the second reference illuminant
17454 (<a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a>).<wbr/></p>
17455 <p>This matrix will only be present if the second reference
17456 illuminant is present.<wbr/></p>
17457             </td>
17458           </tr>
17459
17460
17461           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17462            <!-- end of entry -->
17463
17464
17465           <tr class="entry" id="static_android.sensor.colorTransform1">
17466             <td class="entry_name
17467              " rowspan="3">
17468               android.<wbr/>sensor.<wbr/>color<wbr/>Transform1
17469             </td>
17470             <td class="entry_type">
17471                 <span class="entry_type_name">rational</span>
17472                 <span class="entry_type_container">x</span>
17473
17474                 <span class="entry_type_array">
17475                   3 x 3
17476                 </span>
17477               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
17478
17479
17480
17481
17482                 <div class="entry_type_notes">3x3 matrix in row-major-order</div>
17483
17484
17485             </td> <!-- entry_type -->
17486
17487             <td class="entry_description">
17488               <p>A matrix that transforms color values from CIE XYZ color space to
17489 reference sensor color space.<wbr/></p>
17490             </td>
17491
17492             <td class="entry_units">
17493             </td>
17494
17495             <td class="entry_range">
17496             </td>
17497
17498             <td class="entry_tags">
17499               <ul class="entry_tags">
17500                   <li><a href="#tag_RAW">RAW</a></li>
17501               </ul>
17502             </td>
17503
17504           </tr>
17505           <tr class="entries_header">
17506             <th class="th_details" colspan="5">Details</th>
17507           </tr>
17508           <tr class="entry_cont">
17509             <td class="entry_details" colspan="5">
17510               <p>This matrix is used to convert from the standard CIE XYZ color
17511 space to the reference sensor colorspace,<wbr/> and is used when processing
17512 raw buffer data.<wbr/></p>
17513 <p>The matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and
17514 contains a color transform matrix that maps colors from the CIE
17515 XYZ color space to the reference sensor color space (i.<wbr/>e.<wbr/> the
17516 "golden module" colorspace) under the first reference illuminant
17517 (<a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a>).<wbr/></p>
17518 <p>The white points chosen in both the reference sensor color space
17519 and the CIE XYZ colorspace when calculating this transform will
17520 match the standard white point for the first reference illuminant
17521 (i.<wbr/>e.<wbr/> no chromatic adaptation will be applied by this transform).<wbr/></p>
17522             </td>
17523           </tr>
17524
17525
17526           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17527            <!-- end of entry -->
17528
17529
17530           <tr class="entry" id="static_android.sensor.colorTransform2">
17531             <td class="entry_name
17532              " rowspan="3">
17533               android.<wbr/>sensor.<wbr/>color<wbr/>Transform2
17534             </td>
17535             <td class="entry_type">
17536                 <span class="entry_type_name">rational</span>
17537                 <span class="entry_type_container">x</span>
17538
17539                 <span class="entry_type_array">
17540                   3 x 3
17541                 </span>
17542               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
17543
17544
17545
17546
17547                 <div class="entry_type_notes">3x3 matrix in row-major-order</div>
17548
17549
17550             </td> <!-- entry_type -->
17551
17552             <td class="entry_description">
17553               <p>A matrix that transforms color values from CIE XYZ color space to
17554 reference sensor color space.<wbr/></p>
17555             </td>
17556
17557             <td class="entry_units">
17558             </td>
17559
17560             <td class="entry_range">
17561             </td>
17562
17563             <td class="entry_tags">
17564               <ul class="entry_tags">
17565                   <li><a href="#tag_RAW">RAW</a></li>
17566               </ul>
17567             </td>
17568
17569           </tr>
17570           <tr class="entries_header">
17571             <th class="th_details" colspan="5">Details</th>
17572           </tr>
17573           <tr class="entry_cont">
17574             <td class="entry_details" colspan="5">
17575               <p>This matrix is used to convert from the standard CIE XYZ color
17576 space to the reference sensor colorspace,<wbr/> and is used when processing
17577 raw buffer data.<wbr/></p>
17578 <p>The matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and
17579 contains a color transform matrix that maps colors from the CIE
17580 XYZ color space to the reference sensor color space (i.<wbr/>e.<wbr/> the
17581 "golden module" colorspace) under the second reference illuminant
17582 (<a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a>).<wbr/></p>
17583 <p>The white points chosen in both the reference sensor color space
17584 and the CIE XYZ colorspace when calculating this transform will
17585 match the standard white point for the second reference illuminant
17586 (i.<wbr/>e.<wbr/> no chromatic adaptation will be applied by this transform).<wbr/></p>
17587 <p>This matrix will only be present if the second reference
17588 illuminant is present.<wbr/></p>
17589             </td>
17590           </tr>
17591
17592
17593           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17594            <!-- end of entry -->
17595
17596
17597           <tr class="entry" id="static_android.sensor.forwardMatrix1">
17598             <td class="entry_name
17599              " rowspan="3">
17600               android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix1
17601             </td>
17602             <td class="entry_type">
17603                 <span class="entry_type_name">rational</span>
17604                 <span class="entry_type_container">x</span>
17605
17606                 <span class="entry_type_array">
17607                   3 x 3
17608                 </span>
17609               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
17610
17611
17612
17613
17614                 <div class="entry_type_notes">3x3 matrix in row-major-order</div>
17615
17616
17617             </td> <!-- entry_type -->
17618
17619             <td class="entry_description">
17620               <p>A matrix that transforms white balanced camera colors from the reference
17621 sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.<wbr/></p>
17622             </td>
17623
17624             <td class="entry_units">
17625             </td>
17626
17627             <td class="entry_range">
17628             </td>
17629
17630             <td class="entry_tags">
17631               <ul class="entry_tags">
17632                   <li><a href="#tag_RAW">RAW</a></li>
17633               </ul>
17634             </td>
17635
17636           </tr>
17637           <tr class="entries_header">
17638             <th class="th_details" colspan="5">Details</th>
17639           </tr>
17640           <tr class="entry_cont">
17641             <td class="entry_details" colspan="5">
17642               <p>This matrix is used to convert to the standard CIE XYZ colorspace,<wbr/> and
17643 is used when processing raw buffer data.<wbr/></p>
17644 <p>This matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and contains
17645 a color transform matrix that maps white balanced colors from the
17646 reference sensor color space to the CIE XYZ color space with a D50 white
17647 point.<wbr/></p>
17648 <p>Under the first reference illuminant (<a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a>)
17649 this matrix is chosen so that the standard white point for this reference
17650 illuminant in the reference sensor colorspace is mapped to D50 in the
17651 CIE XYZ colorspace.<wbr/></p>
17652             </td>
17653           </tr>
17654
17655
17656           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17657            <!-- end of entry -->
17658
17659
17660           <tr class="entry" id="static_android.sensor.forwardMatrix2">
17661             <td class="entry_name
17662              " rowspan="3">
17663               android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix2
17664             </td>
17665             <td class="entry_type">
17666                 <span class="entry_type_name">rational</span>
17667                 <span class="entry_type_container">x</span>
17668
17669                 <span class="entry_type_array">
17670                   3 x 3
17671                 </span>
17672               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
17673
17674
17675
17676
17677                 <div class="entry_type_notes">3x3 matrix in row-major-order</div>
17678
17679
17680             </td> <!-- entry_type -->
17681
17682             <td class="entry_description">
17683               <p>A matrix that transforms white balanced camera colors from the reference
17684 sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.<wbr/></p>
17685             </td>
17686
17687             <td class="entry_units">
17688             </td>
17689
17690             <td class="entry_range">
17691             </td>
17692
17693             <td class="entry_tags">
17694               <ul class="entry_tags">
17695                   <li><a href="#tag_RAW">RAW</a></li>
17696               </ul>
17697             </td>
17698
17699           </tr>
17700           <tr class="entries_header">
17701             <th class="th_details" colspan="5">Details</th>
17702           </tr>
17703           <tr class="entry_cont">
17704             <td class="entry_details" colspan="5">
17705               <p>This matrix is used to convert to the standard CIE XYZ colorspace,<wbr/> and
17706 is used when processing raw buffer data.<wbr/></p>
17707 <p>This matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and contains
17708 a color transform matrix that maps white balanced colors from the
17709 reference sensor color space to the CIE XYZ color space with a D50 white
17710 point.<wbr/></p>
17711 <p>Under the second reference illuminant (<a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a>)
17712 this matrix is chosen so that the standard white point for this reference
17713 illuminant in the reference sensor colorspace is mapped to D50 in the
17714 CIE XYZ colorspace.<wbr/></p>
17715 <p>This matrix will only be present if the second reference
17716 illuminant is present.<wbr/></p>
17717             </td>
17718           </tr>
17719
17720
17721           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17722            <!-- end of entry -->
17723
17724
17725           <tr class="entry" id="static_android.sensor.baseGainFactor">
17726             <td class="entry_name
17727              " rowspan="1">
17728               android.<wbr/>sensor.<wbr/>base<wbr/>Gain<wbr/>Factor
17729             </td>
17730             <td class="entry_type">
17731                 <span class="entry_type_name">rational</span>
17732
17733               <span class="entry_type_visibility"> [system]</span>
17734
17735
17736
17737
17738
17739
17740             </td> <!-- entry_type -->
17741
17742             <td class="entry_description">
17743               <p>Gain factor from electrons to raw units when
17744 ISO=100</p>
17745             </td>
17746
17747             <td class="entry_units">
17748             </td>
17749
17750             <td class="entry_range">
17751             </td>
17752
17753             <td class="entry_tags">
17754               <ul class="entry_tags">
17755                   <li><a href="#tag_FUTURE">FUTURE</a></li>
17756               </ul>
17757             </td>
17758
17759           </tr>
17760
17761
17762           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17763            <!-- end of entry -->
17764
17765
17766           <tr class="entry" id="static_android.sensor.blackLevelPattern">
17767             <td class="entry_name
17768              " rowspan="5">
17769               android.<wbr/>sensor.<wbr/>black<wbr/>Level<wbr/>Pattern
17770             </td>
17771             <td class="entry_type">
17772                 <span class="entry_type_name">int32</span>
17773                 <span class="entry_type_container">x</span>
17774
17775                 <span class="entry_type_array">
17776                   4
17777                 </span>
17778               <span class="entry_type_visibility"> [public as blackLevelPattern]</span>
17779
17780
17781
17782
17783                 <div class="entry_type_notes">2x2 raw count block</div>
17784
17785
17786             </td> <!-- entry_type -->
17787
17788             <td class="entry_description">
17789               <p>A fixed black level offset for each of the color filter arrangement
17790 (CFA) mosaic channels.<wbr/></p>
17791             </td>
17792
17793             <td class="entry_units">
17794             </td>
17795
17796             <td class="entry_range">
17797               <p>&gt;= 0 for each.<wbr/></p>
17798             </td>
17799
17800             <td class="entry_tags">
17801               <ul class="entry_tags">
17802                   <li><a href="#tag_RAW">RAW</a></li>
17803               </ul>
17804             </td>
17805
17806           </tr>
17807           <tr class="entries_header">
17808             <th class="th_details" colspan="5">Details</th>
17809           </tr>
17810           <tr class="entry_cont">
17811             <td class="entry_details" colspan="5">
17812               <p>This key specifies the zero light value for each of the CFA mosaic
17813 channels in the camera sensor.<wbr/>  The maximal value output by the
17814 sensor is represented by the value in <a href="#static_android.sensor.info.whiteLevel">android.<wbr/>sensor.<wbr/>info.<wbr/>white<wbr/>Level</a>.<wbr/></p>
17815 <p>The values are given in the same order as channels listed for the CFA
17816 layout key (see <a href="#static_android.sensor.info.colorFilterArrangement">android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement</a>),<wbr/> i.<wbr/>e.<wbr/> the
17817 nth value given corresponds to the black level offset for the nth
17818 color channel listed in the CFA.<wbr/></p>
17819             </td>
17820           </tr>
17821
17822           <tr class="entries_header">
17823             <th class="th_details" colspan="5">HAL Implementation Details</th>
17824           </tr>
17825           <tr class="entry_cont">
17826             <td class="entry_details" colspan="5">
17827               <p>The values are given in row-column scan order,<wbr/> with the first value
17828 corresponding to the element of the CFA in row=0,<wbr/> column=0.<wbr/></p>
17829             </td>
17830           </tr>
17831
17832           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17833            <!-- end of entry -->
17834
17835
17836           <tr class="entry" id="static_android.sensor.maxAnalogSensitivity">
17837             <td class="entry_name
17838              " rowspan="3">
17839               android.<wbr/>sensor.<wbr/>max<wbr/>Analog<wbr/>Sensitivity
17840             </td>
17841             <td class="entry_type">
17842                 <span class="entry_type_name">int32</span>
17843
17844               <span class="entry_type_visibility"> [public]</span>
17845
17846
17847               <span class="entry_type_hwlevel">[full] </span>
17848
17849
17850
17851
17852             </td> <!-- entry_type -->
17853
17854             <td class="entry_description">
17855               <p>Maximum sensitivity that is implemented
17856 purely through analog gain.<wbr/></p>
17857             </td>
17858
17859             <td class="entry_units">
17860             </td>
17861
17862             <td class="entry_range">
17863             </td>
17864
17865             <td class="entry_tags">
17866               <ul class="entry_tags">
17867                   <li><a href="#tag_V1">V1</a></li>
17868                   <li><a href="#tag_FULL">FULL</a></li>
17869               </ul>
17870             </td>
17871
17872           </tr>
17873           <tr class="entries_header">
17874             <th class="th_details" colspan="5">Details</th>
17875           </tr>
17876           <tr class="entry_cont">
17877             <td class="entry_details" colspan="5">
17878               <p>For <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a> values less than or
17879 equal to this,<wbr/> all applied gain must be analog.<wbr/> For
17880 values above this,<wbr/> the gain applied can be a mix of analog and
17881 digital.<wbr/></p>
17882             </td>
17883           </tr>
17884
17885
17886           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17887            <!-- end of entry -->
17888
17889
17890           <tr class="entry" id="static_android.sensor.orientation">
17891             <td class="entry_name
17892              " rowspan="3">
17893               android.<wbr/>sensor.<wbr/>orientation
17894             </td>
17895             <td class="entry_type">
17896                 <span class="entry_type_name">int32</span>
17897
17898               <span class="entry_type_visibility"> [public]</span>
17899
17900
17901               <span class="entry_type_hwlevel">[legacy] </span>
17902
17903
17904
17905
17906             </td> <!-- entry_type -->
17907
17908             <td class="entry_description">
17909               <p>Clockwise angle through which the output image needs to be rotated to be
17910 upright on the device screen in its native orientation.<wbr/></p>
17911             </td>
17912
17913             <td class="entry_units">
17914               Degrees of clockwise rotation; always a multiple of
17915           90
17916             </td>
17917
17918             <td class="entry_range">
17919               <p>0,<wbr/> 90,<wbr/> 180,<wbr/> 270</p>
17920             </td>
17921
17922             <td class="entry_tags">
17923               <ul class="entry_tags">
17924                   <li><a href="#tag_BC">BC</a></li>
17925               </ul>
17926             </td>
17927
17928           </tr>
17929           <tr class="entries_header">
17930             <th class="th_details" colspan="5">Details</th>
17931           </tr>
17932           <tr class="entry_cont">
17933             <td class="entry_details" colspan="5">
17934               <p>Also defines the direction of rolling shutter readout,<wbr/> which is from top to bottom in
17935 the sensor's coordinate system.<wbr/></p>
17936             </td>
17937           </tr>
17938
17939
17940           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17941            <!-- end of entry -->
17942
17943
17944           <tr class="entry" id="static_android.sensor.profileHueSatMapDimensions">
17945             <td class="entry_name
17946              " rowspan="3">
17947               android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map<wbr/>Dimensions
17948             </td>
17949             <td class="entry_type">
17950                 <span class="entry_type_name">int32</span>
17951                 <span class="entry_type_container">x</span>
17952
17953                 <span class="entry_type_array">
17954                   3
17955                 </span>
17956               <span class="entry_type_visibility"> [system]</span>
17957
17958
17959
17960
17961                 <div class="entry_type_notes">Number of samples for hue,<wbr/> saturation,<wbr/> and value</div>
17962
17963
17964             </td> <!-- entry_type -->
17965
17966             <td class="entry_description">
17967               <p>The number of input samples for each dimension of
17968 <a href="#dynamic_android.sensor.profileHueSatMap">android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map</a>.<wbr/></p>
17969             </td>
17970
17971             <td class="entry_units">
17972             </td>
17973
17974             <td class="entry_range">
17975               <p>Hue &gt;= 1,<wbr/>
17976 Saturation &gt;= 2,<wbr/>
17977 Value &gt;= 1</p>
17978             </td>
17979
17980             <td class="entry_tags">
17981               <ul class="entry_tags">
17982                   <li><a href="#tag_RAW">RAW</a></li>
17983               </ul>
17984             </td>
17985
17986           </tr>
17987           <tr class="entries_header">
17988             <th class="th_details" colspan="5">Details</th>
17989           </tr>
17990           <tr class="entry_cont">
17991             <td class="entry_details" colspan="5">
17992               <p>The number of input samples for the hue,<wbr/> saturation,<wbr/> and value
17993 dimension of <a href="#dynamic_android.sensor.profileHueSatMap">android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map</a>.<wbr/> The order of the
17994 dimensions given is hue,<wbr/> saturation,<wbr/> value; where hue is the 0th
17995 element.<wbr/></p>
17996             </td>
17997           </tr>
17998
17999
18000           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18001            <!-- end of entry -->
18002
18003
18004           <tr class="entry" id="static_android.sensor.availableTestPatternModes">
18005             <td class="entry_name
18006              " rowspan="5">
18007               android.<wbr/>sensor.<wbr/>available<wbr/>Test<wbr/>Pattern<wbr/>Modes
18008             </td>
18009             <td class="entry_type">
18010                 <span class="entry_type_name">int32</span>
18011                 <span class="entry_type_container">x</span>
18012
18013                 <span class="entry_type_array">
18014                   n
18015                 </span>
18016               <span class="entry_type_visibility"> [public]</span>
18017
18018
18019
18020
18021                 <div class="entry_type_notes">list of enums</div>
18022
18023
18024             </td> <!-- entry_type -->
18025
18026             <td class="entry_description">
18027               <p>List of sensor test pattern modes for <a href="#controls_android.sensor.testPatternMode">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode</a>
18028 supported by this camera device.<wbr/></p>
18029             </td>
18030
18031             <td class="entry_units">
18032             </td>
18033
18034             <td class="entry_range">
18035               <p>Any value listed in <a href="#controls_android.sensor.testPatternMode">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode</a></p>
18036             </td>
18037
18038             <td class="entry_tags">
18039             </td>
18040
18041           </tr>
18042           <tr class="entries_header">
18043             <th class="th_details" colspan="5">Details</th>
18044           </tr>
18045           <tr class="entry_cont">
18046             <td class="entry_details" colspan="5">
18047               <p>Defaults to OFF,<wbr/> and always includes OFF if defined.<wbr/></p>
18048             </td>
18049           </tr>
18050
18051           <tr class="entries_header">
18052             <th class="th_details" colspan="5">HAL Implementation Details</th>
18053           </tr>
18054           <tr class="entry_cont">
18055             <td class="entry_details" colspan="5">
18056               <p>All custom modes must be &gt;= CUSTOM1.<wbr/></p>
18057             </td>
18058           </tr>
18059
18060           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18061            <!-- end of entry -->
18062
18063
18064
18065       <!-- end of kind -->
18066       </tbody>
18067       <tr><td colspan="6" class="kind">dynamic</td></tr>
18068
18069       <thead class="entries_header">
18070         <tr>
18071           <th class="th_name">Property Name</th>
18072           <th class="th_type">Type</th>
18073           <th class="th_description">Description</th>
18074           <th class="th_units">Units</th>
18075           <th class="th_range">Range</th>
18076           <th class="th_tags">Tags</th>
18077         </tr>
18078       </thead>
18079
18080       <tbody>
18081
18082
18083
18084
18085
18086
18087
18088
18089
18090
18091           <tr class="entry" id="dynamic_android.sensor.exposureTime">
18092             <td class="entry_name
18093              " rowspan="3">
18094               android.<wbr/>sensor.<wbr/>exposure<wbr/>Time
18095             </td>
18096             <td class="entry_type">
18097                 <span class="entry_type_name">int64</span>
18098
18099               <span class="entry_type_visibility"> [public]</span>
18100
18101
18102               <span class="entry_type_hwlevel">[full] </span>
18103
18104
18105
18106
18107             </td> <!-- entry_type -->
18108
18109             <td class="entry_description">
18110               <p>Duration each pixel is exposed to
18111 light.<wbr/></p>
18112             </td>
18113
18114             <td class="entry_units">
18115               Nanoseconds
18116             </td>
18117
18118             <td class="entry_range">
18119               <p><a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a></p>
18120             </td>
18121
18122             <td class="entry_tags">
18123               <ul class="entry_tags">
18124                   <li><a href="#tag_V1">V1</a></li>
18125               </ul>
18126             </td>
18127
18128           </tr>
18129           <tr class="entries_header">
18130             <th class="th_details" colspan="5">Details</th>
18131           </tr>
18132           <tr class="entry_cont">
18133             <td class="entry_details" colspan="5">
18134               <p>If the sensor can't expose this exact duration,<wbr/> it will shorten the
18135 duration exposed to the nearest possible value (rather than expose longer).<wbr/>
18136 The final exposure time used will be available in the output capture result.<wbr/></p>
18137 <p>This control is only effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is set to
18138 OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
18139             </td>
18140           </tr>
18141
18142
18143           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18144            <!-- end of entry -->
18145
18146
18147           <tr class="entry" id="dynamic_android.sensor.frameDuration">
18148             <td class="entry_name
18149              " rowspan="5">
18150               android.<wbr/>sensor.<wbr/>frame<wbr/>Duration
18151             </td>
18152             <td class="entry_type">
18153                 <span class="entry_type_name">int64</span>
18154
18155               <span class="entry_type_visibility"> [public]</span>
18156
18157
18158               <span class="entry_type_hwlevel">[full] </span>
18159
18160
18161
18162
18163             </td> <!-- entry_type -->
18164
18165             <td class="entry_description">
18166               <p>Duration from start of frame exposure to
18167 start of next frame exposure.<wbr/></p>
18168             </td>
18169
18170             <td class="entry_units">
18171               Nanoseconds
18172             </td>
18173
18174             <td class="entry_range">
18175               <p>See <a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a>,<wbr/>
18176 <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/> The duration
18177 is capped to <code>max(duration,<wbr/> exposureTime + overhead)</code>.<wbr/></p>
18178             </td>
18179
18180             <td class="entry_tags">
18181               <ul class="entry_tags">
18182                   <li><a href="#tag_V1">V1</a></li>
18183               </ul>
18184             </td>
18185
18186           </tr>
18187           <tr class="entries_header">
18188             <th class="th_details" colspan="5">Details</th>
18189           </tr>
18190           <tr class="entry_cont">
18191             <td class="entry_details" colspan="5">
18192               <p>The maximum frame rate that can be supported by a camera subsystem is
18193 a function of many factors:</p>
18194 <ul>
18195 <li>Requested resolutions of output image streams</li>
18196 <li>Availability of binning /<wbr/> skipping modes on the imager</li>
18197 <li>The bandwidth of the imager interface</li>
18198 <li>The bandwidth of the various ISP processing blocks</li>
18199 </ul>
18200 <p>Since these factors can vary greatly between different ISPs and
18201 sensors,<wbr/> the camera abstraction tries to represent the bandwidth
18202 restrictions with as simple a model as possible.<wbr/></p>
18203 <p>The model presented has the following characteristics:</p>
18204 <ul>
18205 <li>The image sensor is always configured to output the smallest
18206 resolution possible given the application's requested output stream
18207 sizes.<wbr/>  The smallest resolution is defined as being at least as large
18208 as the largest requested output stream size; the camera pipeline must
18209 never digitally upsample sensor data when the crop region covers the
18210 whole sensor.<wbr/> In general,<wbr/> this means that if only small output stream
18211 resolutions are configured,<wbr/> the sensor can provide a higher frame
18212 rate.<wbr/></li>
18213 <li>Since any request may use any or all the currently configured
18214 output streams,<wbr/> the sensor and ISP must be configured to support
18215 scaling a single capture to all the streams at the same time.<wbr/>  This
18216 means the camera pipeline must be ready to produce the largest
18217 requested output size without any delay.<wbr/>  Therefore,<wbr/> the overall
18218 frame rate of a given configured stream set is governed only by the
18219 largest requested stream resolution.<wbr/></li>
18220 <li>Using more than one output stream in a request does not affect the
18221 frame duration.<wbr/></li>
18222 <li>Certain format-streams may need to do additional background processing
18223 before data is consumed/<wbr/>produced by that stream.<wbr/> These processors
18224 can run concurrently to the rest of the camera pipeline,<wbr/> but
18225 cannot process more than 1 capture at a time.<wbr/></li>
18226 </ul>
18227 <p>The necessary information for the application,<wbr/> given the model above,<wbr/>
18228 is provided via the <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> field
18229 using StreamConfigurationMap#getOutputMinFrameDuration(int,<wbr/> Size).<wbr/>
18230 These are used to determine the maximum frame rate /<wbr/> minimum frame
18231 duration that is possible for a given stream configuration.<wbr/></p>
18232 <p>Specifically,<wbr/> the application can use the following rules to
18233 determine the minimum frame duration it can request from the camera
18234 device:</p>
18235 <ol>
18236 <li>Let the set of currently configured input/<wbr/>output streams
18237 be called <code>S</code>.<wbr/></li>
18238 <li>Find the minimum frame durations for each stream in <code>S</code>,<wbr/> by
18239 looking it up in <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> using
18240 StreamConfigurationMap#getOutputMinFrameDuration(int,<wbr/> Size) (with
18241 its respective size/<wbr/>format).<wbr/> Let this set of frame durations be called
18242 <code>F</code>.<wbr/></li>
18243 <li>For any given request <code>R</code>,<wbr/> the minimum frame duration allowed
18244 for <code>R</code> is the maximum out of all values in <code>F</code>.<wbr/> Let the streams
18245 used in <code>R</code> be called <code>S_<wbr/>r</code>.<wbr/></li>
18246 </ol>
18247 <p>If none of the streams in <code>S_<wbr/>r</code> have a stall time (listed in
18248 StreamConfigurationMap#getOutputStallDuration(int,<wbr/>Size) using its
18249 respective size/<wbr/>format),<wbr/> then the frame duration in
18250 <code>F</code> determines the steady state frame rate that the application will
18251 get if it uses <code>R</code> as a repeating request.<wbr/> Let this special kind
18252 of request be called <code>Rsimple</code>.<wbr/></p>
18253 <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved
18254 by a single capture of a new request <code>Rstall</code> (which has at least
18255 one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the
18256 same minimum frame duration this will not cause a frame rate loss
18257 if all buffers from the previous <code>Rstall</code> have already been
18258 delivered.<wbr/></p>
18259 <p>For more details about stalling,<wbr/> see
18260 StreamConfigurationMap#getOutputStallDuration(int,<wbr/>Size).<wbr/></p>
18261 <p>This control is only effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is set to
18262 OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
18263             </td>
18264           </tr>
18265
18266           <tr class="entries_header">
18267             <th class="th_details" colspan="5">HAL Implementation Details</th>
18268           </tr>
18269           <tr class="entry_cont">
18270             <td class="entry_details" colspan="5">
18271               <p>For more details about stalling,<wbr/> see
18272 <a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a>.<wbr/></p>
18273             </td>
18274           </tr>
18275
18276           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18277            <!-- end of entry -->
18278
18279
18280           <tr class="entry" id="dynamic_android.sensor.sensitivity">
18281             <td class="entry_name
18282              " rowspan="5">
18283               android.<wbr/>sensor.<wbr/>sensitivity
18284             </td>
18285             <td class="entry_type">
18286                 <span class="entry_type_name">int32</span>
18287
18288               <span class="entry_type_visibility"> [public]</span>
18289
18290
18291               <span class="entry_type_hwlevel">[full] </span>
18292
18293
18294
18295
18296             </td> <!-- entry_type -->
18297
18298             <td class="entry_description">
18299               <p>The amount of gain applied to sensor data
18300 before processing.<wbr/></p>
18301             </td>
18302
18303             <td class="entry_units">
18304               ISO arithmetic units
18305             </td>
18306
18307             <td class="entry_range">
18308               <p><a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a></p>
18309             </td>
18310
18311             <td class="entry_tags">
18312               <ul class="entry_tags">
18313                   <li><a href="#tag_V1">V1</a></li>
18314               </ul>
18315             </td>
18316
18317           </tr>
18318           <tr class="entries_header">
18319             <th class="th_details" colspan="5">Details</th>
18320           </tr>
18321           <tr class="entry_cont">
18322             <td class="entry_details" colspan="5">
18323               <p>The sensitivity is the standard ISO sensitivity value,<wbr/>
18324 as defined in ISO 12232:2006.<wbr/></p>
18325 <p>The sensitivity must be within <a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a>,<wbr/> and
18326 if if it less than <a href="#static_android.sensor.maxAnalogSensitivity">android.<wbr/>sensor.<wbr/>max<wbr/>Analog<wbr/>Sensitivity</a>,<wbr/> the camera device
18327 is guaranteed to use only analog amplification for applying the gain.<wbr/></p>
18328 <p>If the camera device cannot apply the exact sensitivity
18329 requested,<wbr/> it will reduce the gain to the nearest supported
18330 value.<wbr/> The final sensitivity used will be available in the
18331 output capture result.<wbr/></p>
18332             </td>
18333           </tr>
18334
18335           <tr class="entries_header">
18336             <th class="th_details" colspan="5">HAL Implementation Details</th>
18337           </tr>
18338           <tr class="entry_cont">
18339             <td class="entry_details" colspan="5">
18340               <p>ISO 12232:2006 REI method is acceptable.<wbr/></p>
18341             </td>
18342           </tr>
18343
18344           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18345            <!-- end of entry -->
18346
18347
18348           <tr class="entry" id="dynamic_android.sensor.timestamp">
18349             <td class="entry_name
18350              " rowspan="5">
18351               android.<wbr/>sensor.<wbr/>timestamp
18352             </td>
18353             <td class="entry_type">
18354                 <span class="entry_type_name">int64</span>
18355
18356               <span class="entry_type_visibility"> [public]</span>
18357
18358
18359               <span class="entry_type_hwlevel">[legacy] </span>
18360
18361
18362
18363
18364             </td> <!-- entry_type -->
18365
18366             <td class="entry_description">
18367               <p>Time at start of exposure of first
18368 row of the image sensor active array,<wbr/> in nanoseconds.<wbr/></p>
18369             </td>
18370
18371             <td class="entry_units">
18372               Nanoseconds
18373             </td>
18374
18375             <td class="entry_range">
18376               <p>&gt; 0</p>
18377             </td>
18378
18379             <td class="entry_tags">
18380               <ul class="entry_tags">
18381                   <li><a href="#tag_BC">BC</a></li>
18382               </ul>
18383             </td>
18384
18385           </tr>
18386           <tr class="entries_header">
18387             <th class="th_details" colspan="5">Details</th>
18388           </tr>
18389           <tr class="entry_cont">
18390             <td class="entry_details" colspan="5">
18391               <p>The timestamps are also included in all image
18392 buffers produced for the same capture,<wbr/> and will be identical
18393 on all the outputs.<wbr/></p>
18394 <p>When <a href="#static_android.sensor.info.timestampSource">android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source</a> <code>==</code> UNKNOWN,<wbr/>
18395 the timestamps measure time since an unspecified starting point,<wbr/>
18396 and are monotonically increasing.<wbr/> They can be compared with the
18397 timestamps for other captures from the same camera device,<wbr/> but are
18398 not guaranteed to be comparable to any other time source.<wbr/></p>
18399 <p>When <a href="#static_android.sensor.info.timestampSource">android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source</a> <code>==</code> REALTIME,<wbr/>
18400 the timestamps measure time in the same timebase as
18401 android.<wbr/>os.<wbr/>System<wbr/>Clock#elapsed<wbr/>Realtime<wbr/>Nanos(),<wbr/> and they can be
18402 compared to other timestamps from other subsystems that are using
18403 that base.<wbr/></p>
18404             </td>
18405           </tr>
18406
18407           <tr class="entries_header">
18408             <th class="th_details" colspan="5">HAL Implementation Details</th>
18409           </tr>
18410           <tr class="entry_cont">
18411             <td class="entry_details" colspan="5">
18412               <p>All timestamps must be in reference to the kernel's
18413 CLOCK_<wbr/>BOOTTIME monotonic clock,<wbr/> which properly accounts for
18414 time spent asleep.<wbr/> This allows for synchronization with
18415 sensors that continue to operate while the system is
18416 otherwise asleep.<wbr/></p>
18417 <p>If <a href="#static_android.sensor.info.timestampSource">android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source</a> <code>==</code> REALTIME,<wbr/>
18418 The timestamp must be synchronized with the timestamps from other
18419 sensor subsystems that are using the same timebase.<wbr/></p>
18420             </td>
18421           </tr>
18422
18423           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18424            <!-- end of entry -->
18425
18426
18427           <tr class="entry" id="dynamic_android.sensor.temperature">
18428             <td class="entry_name
18429              " rowspan="1">
18430               android.<wbr/>sensor.<wbr/>temperature
18431             </td>
18432             <td class="entry_type">
18433                 <span class="entry_type_name">float</span>
18434
18435               <span class="entry_type_visibility"> [system]</span>
18436
18437
18438
18439
18440
18441
18442             </td> <!-- entry_type -->
18443
18444             <td class="entry_description">
18445               <p>The temperature of the sensor,<wbr/> sampled at the time
18446 exposure began for this frame.<wbr/></p>
18447 <p>The thermal diode being queried should be inside the sensor PCB,<wbr/> or
18448 somewhere close to it.<wbr/></p>
18449             </td>
18450
18451             <td class="entry_units">
18452               Celsius
18453             </td>
18454
18455             <td class="entry_range">
18456               <p>Optional.<wbr/> This value is missing if no temperature is available.<wbr/></p>
18457             </td>
18458
18459             <td class="entry_tags">
18460               <ul class="entry_tags">
18461                   <li><a href="#tag_FUTURE">FUTURE</a></li>
18462               </ul>
18463             </td>
18464
18465           </tr>
18466
18467
18468           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18469            <!-- end of entry -->
18470
18471
18472           <tr class="entry" id="dynamic_android.sensor.neutralColorPoint">
18473             <td class="entry_name
18474              " rowspan="3">
18475               android.<wbr/>sensor.<wbr/>neutral<wbr/>Color<wbr/>Point
18476             </td>
18477             <td class="entry_type">
18478                 <span class="entry_type_name">rational</span>
18479                 <span class="entry_type_container">x</span>
18480
18481                 <span class="entry_type_array">
18482                   3
18483                 </span>
18484               <span class="entry_type_visibility"> [public]</span>
18485
18486
18487
18488
18489
18490
18491             </td> <!-- entry_type -->
18492
18493             <td class="entry_description">
18494               <p>The estimated camera neutral color in the native sensor colorspace at
18495 the time of capture.<wbr/></p>
18496             </td>
18497
18498             <td class="entry_units">
18499             </td>
18500
18501             <td class="entry_range">
18502             </td>
18503
18504             <td class="entry_tags">
18505               <ul class="entry_tags">
18506                   <li><a href="#tag_RAW">RAW</a></li>
18507               </ul>
18508             </td>
18509
18510           </tr>
18511           <tr class="entries_header">
18512             <th class="th_details" colspan="5">Details</th>
18513           </tr>
18514           <tr class="entry_cont">
18515             <td class="entry_details" colspan="5">
18516               <p>This value gives the neutral color point encoded as an RGB value in the
18517 native sensor color space.<wbr/>  The neutral color point indicates the
18518 currently estimated white point of the scene illumination.<wbr/>  It can be
18519 used to interpolate between the provided color transforms when
18520 processing raw sensor data.<wbr/></p>
18521 <p>The order of the values is R,<wbr/> G,<wbr/> B; where R is in the lowest index.<wbr/></p>
18522             </td>
18523           </tr>
18524
18525
18526           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18527            <!-- end of entry -->
18528
18529
18530           <tr class="entry" id="dynamic_android.sensor.noiseProfile">
18531             <td class="entry_name
18532              " rowspan="5">
18533               android.<wbr/>sensor.<wbr/>noise<wbr/>Profile
18534             </td>
18535             <td class="entry_type">
18536                 <span class="entry_type_name">double</span>
18537                 <span class="entry_type_container">x</span>
18538
18539                 <span class="entry_type_array">
18540                   2 x CFA Channels
18541                 </span>
18542               <span class="entry_type_visibility"> [public as pairDoubleDouble]</span>
18543
18544
18545
18546
18547                 <div class="entry_type_notes">Pairs of noise model coefficients</div>
18548
18549
18550             </td> <!-- entry_type -->
18551
18552             <td class="entry_description">
18553               <p>Noise model coefficients for each CFA mosaic channel.<wbr/></p>
18554             </td>
18555
18556             <td class="entry_units">
18557             </td>
18558
18559             <td class="entry_range">
18560             </td>
18561
18562             <td class="entry_tags">
18563               <ul class="entry_tags">
18564                   <li><a href="#tag_RAW">RAW</a></li>
18565               </ul>
18566             </td>
18567
18568           </tr>
18569           <tr class="entries_header">
18570             <th class="th_details" colspan="5">Details</th>
18571           </tr>
18572           <tr class="entry_cont">
18573             <td class="entry_details" colspan="5">
18574               <p>This key contains two noise model coefficients for each CFA channel
18575 corresponding to the sensor amplification (S) and sensor readout
18576 noise (O).<wbr/>  These are given as pairs of coefficients for each channel
18577 in the same order as channels listed for the CFA layout key
18578 (see <a href="#static_android.sensor.info.colorFilterArrangement">android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement</a>).<wbr/>  This is
18579 represented as an array of Pair&lt;Double,<wbr/> Double&gt;,<wbr/> where
18580 the first member of the Pair at index n is the S coefficient and the
18581 second member is the O coefficient for the nth color channel in the CFA.<wbr/></p>
18582 <p>These coefficients are used in a two parameter noise model to describe
18583 the amount of noise present in the image for each CFA channel.<wbr/>  The
18584 noise model used here is:</p>
18585 <p>N(x) = sqrt(Sx + O)</p>
18586 <p>Where x represents the recorded signal of a CFA channel normalized to
18587 the range [0,<wbr/> 1],<wbr/> and S and O are the noise model coeffiecients for
18588 that channel.<wbr/></p>
18589 <p>A more detailed description of the noise model can be found in the
18590 Adobe DNG specification for the NoiseProfile tag.<wbr/></p>
18591             </td>
18592           </tr>
18593
18594           <tr class="entries_header">
18595             <th class="th_details" colspan="5">HAL Implementation Details</th>
18596           </tr>
18597           <tr class="entry_cont">
18598             <td class="entry_details" colspan="5">
18599               <p>For a CFA layout of RGGB,<wbr/> the list of coefficients would be given as
18600 an array of doubles S0,<wbr/>O0,<wbr/>S1,<wbr/>O1,...,<wbr/> where S0 and O0 are the coefficients
18601 for the red channel,<wbr/> S1 and O1 are the coefficients for the first green
18602 channel,<wbr/> etc.<wbr/></p>
18603             </td>
18604           </tr>
18605
18606           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18607            <!-- end of entry -->
18608
18609
18610           <tr class="entry" id="dynamic_android.sensor.profileHueSatMap">
18611             <td class="entry_name
18612              " rowspan="3">
18613               android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map
18614             </td>
18615             <td class="entry_type">
18616                 <span class="entry_type_name">float</span>
18617                 <span class="entry_type_container">x</span>
18618
18619                 <span class="entry_type_array">
18620                   hue_samples x saturation_samples x value_samples x 3
18621                 </span>
18622               <span class="entry_type_visibility"> [system]</span>
18623
18624
18625
18626
18627                 <div class="entry_type_notes">Mapping for hue,<wbr/> saturation,<wbr/> and value</div>
18628
18629
18630             </td> <!-- entry_type -->
18631
18632             <td class="entry_description">
18633               <p>A mapping containing a hue shift,<wbr/> saturation scale,<wbr/> and value scale
18634 for each pixel.<wbr/></p>
18635             </td>
18636
18637             <td class="entry_units">
18638
18639           The hue shift is given in degrees; saturation and value scale factors are
18640           unitless and are between 0 and 1 inclusive
18641
18642             </td>
18643
18644             <td class="entry_range">
18645             </td>
18646
18647             <td class="entry_tags">
18648               <ul class="entry_tags">
18649                   <li><a href="#tag_RAW">RAW</a></li>
18650               </ul>
18651             </td>
18652
18653           </tr>
18654           <tr class="entries_header">
18655             <th class="th_details" colspan="5">Details</th>
18656           </tr>
18657           <tr class="entry_cont">
18658             <td class="entry_details" colspan="5">
18659               <p>hue_<wbr/>samples,<wbr/> saturation_<wbr/>samples,<wbr/> and value_<wbr/>samples are given in
18660 <a href="#static_android.sensor.profileHueSatMapDimensions">android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map<wbr/>Dimensions</a>.<wbr/></p>
18661 <p>Each entry of this map contains three floats corresponding to the
18662 hue shift,<wbr/> saturation scale,<wbr/> and value scale,<wbr/> respectively; where the
18663 hue shift has the lowest index.<wbr/> The map entries are stored in the key
18664 in nested loop order,<wbr/> with the value divisions in the outer loop,<wbr/> the
18665 hue divisions in the middle loop,<wbr/> and the saturation divisions in the
18666 inner loop.<wbr/> All zero input saturation entries are required to have a
18667 value scale factor of 1.<wbr/>0.<wbr/></p>
18668             </td>
18669           </tr>
18670
18671
18672           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18673            <!-- end of entry -->
18674
18675
18676           <tr class="entry" id="dynamic_android.sensor.profileToneCurve">
18677             <td class="entry_name
18678              " rowspan="3">
18679               android.<wbr/>sensor.<wbr/>profile<wbr/>Tone<wbr/>Curve
18680             </td>
18681             <td class="entry_type">
18682                 <span class="entry_type_name">float</span>
18683                 <span class="entry_type_container">x</span>
18684
18685                 <span class="entry_type_array">
18686                   samples x 2
18687                 </span>
18688               <span class="entry_type_visibility"> [system]</span>
18689
18690
18691
18692
18693                 <div class="entry_type_notes">Samples defining a spline for a tone-mapping curve</div>
18694
18695
18696             </td> <!-- entry_type -->
18697
18698             <td class="entry_description">
18699               <p>A list of x,<wbr/>y samples defining a tone-mapping curve for gamma adjustment.<wbr/></p>
18700             </td>
18701
18702             <td class="entry_units">
18703             </td>
18704
18705             <td class="entry_range">
18706               <p>Each sample has an input range of <code>[0,<wbr/> 1]</code> and an output range of
18707 <code>[0,<wbr/> 1]</code>.<wbr/>  The first sample is required to be <code>(0,<wbr/> 0)</code>,<wbr/> and the last
18708 sample is required to be <code>(1,<wbr/> 1)</code>.<wbr/></p>
18709             </td>
18710
18711             <td class="entry_tags">
18712               <ul class="entry_tags">
18713                   <li><a href="#tag_RAW">RAW</a></li>
18714               </ul>
18715             </td>
18716
18717           </tr>
18718           <tr class="entries_header">
18719             <th class="th_details" colspan="5">Details</th>
18720           </tr>
18721           <tr class="entry_cont">
18722             <td class="entry_details" colspan="5">
18723               <p>This key contains a default tone curve that can be applied while
18724 processing the image as a starting point for user adjustments.<wbr/>
18725 The curve is specified as a list of value pairs in linear gamma.<wbr/>
18726 The curve is interpolated using a cubic spline.<wbr/></p>
18727             </td>
18728           </tr>
18729
18730
18731           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18732            <!-- end of entry -->
18733
18734
18735           <tr class="entry" id="dynamic_android.sensor.greenSplit">
18736             <td class="entry_name
18737              " rowspan="5">
18738               android.<wbr/>sensor.<wbr/>green<wbr/>Split
18739             </td>
18740             <td class="entry_type">
18741                 <span class="entry_type_name">float</span>
18742
18743               <span class="entry_type_visibility"> [public]</span>
18744
18745
18746
18747
18748
18749
18750             </td> <!-- entry_type -->
18751
18752             <td class="entry_description">
18753               <p>The worst-case divergence between Bayer green channels.<wbr/></p>
18754             </td>
18755
18756             <td class="entry_units">
18757             </td>
18758
18759             <td class="entry_range">
18760               <p>&gt;= 0</p>
18761             </td>
18762
18763             <td class="entry_tags">
18764               <ul class="entry_tags">
18765                   <li><a href="#tag_RAW">RAW</a></li>
18766               </ul>
18767             </td>
18768
18769           </tr>
18770           <tr class="entries_header">
18771             <th class="th_details" colspan="5">Details</th>
18772           </tr>
18773           <tr class="entry_cont">
18774             <td class="entry_details" colspan="5">
18775               <p>This value is an estimate of the worst case split between the
18776 Bayer green channels in the red and blue rows in the sensor color
18777 filter array.<wbr/></p>
18778 <p>The green split is calculated as follows:</p>
18779 <ol>
18780 <li>A 5x5 pixel (or larger) window W within the active sensor array is
18781 chosen.<wbr/> The term 'pixel' here is taken to mean a group of 4 Bayer
18782 mosaic channels (R,<wbr/> Gr,<wbr/> Gb,<wbr/> B).<wbr/>  The location and size of the window
18783 chosen is implementation defined,<wbr/> and should be chosen to provide a
18784 green split estimate that is both representative of the entire image
18785 for this camera sensor,<wbr/> and can be calculated quickly.<wbr/></li>
18786 <li>The arithmetic mean of the green channels from the red
18787 rows (mean_<wbr/>Gr) within W is computed.<wbr/></li>
18788 <li>The arithmetic mean of the green channels from the blue
18789 rows (mean_<wbr/>Gb) within W is computed.<wbr/></li>
18790 <li>The maximum ratio R of the two means is computed as follows:
18791 <code>R = max((mean_<wbr/>Gr + 1)/<wbr/>(mean_<wbr/>Gb + 1),<wbr/> (mean_<wbr/>Gb + 1)/<wbr/>(mean_<wbr/>Gr + 1))</code></li>
18792 </ol>
18793 <p>The ratio R is the green split divergence reported for this property,<wbr/>
18794 which represents how much the green channels differ in the mosaic
18795 pattern.<wbr/>  This value is typically used to determine the treatment of
18796 the green mosaic channels when demosaicing.<wbr/></p>
18797 <p>The green split value can be roughly interpreted as follows:</p>
18798 <ul>
18799 <li>R &lt; 1.<wbr/>03 is a negligible split (&lt;3% divergence).<wbr/></li>
18800 <li>1.<wbr/>20 &lt;= R &gt;= 1.<wbr/>03 will require some software
18801 correction to avoid demosaic errors (3-20% divergence).<wbr/></li>
18802 <li>R &gt; 1.<wbr/>20 will require strong software correction to produce
18803 a usuable image (&gt;20% divergence).<wbr/></li>
18804 </ul>
18805             </td>
18806           </tr>
18807
18808           <tr class="entries_header">
18809             <th class="th_details" colspan="5">HAL Implementation Details</th>
18810           </tr>
18811           <tr class="entry_cont">
18812             <td class="entry_details" colspan="5">
18813               <p>The green split given may be a static value based on prior
18814 characterization of the camera sensor using the green split
18815 calculation method given here over a large,<wbr/> representative,<wbr/> sample
18816 set of images.<wbr/>  Other methods of calculation that produce equivalent
18817 results,<wbr/> and can be interpreted in the same manner,<wbr/> may be used.<wbr/></p>
18818             </td>
18819           </tr>
18820
18821           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18822            <!-- end of entry -->
18823
18824
18825           <tr class="entry" id="dynamic_android.sensor.testPatternData">
18826             <td class="entry_name
18827              " rowspan="5">
18828               android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Data
18829             </td>
18830             <td class="entry_type">
18831                 <span class="entry_type_name">int32</span>
18832                 <span class="entry_type_container">x</span>
18833
18834                 <span class="entry_type_array">
18835                   4
18836                 </span>
18837               <span class="entry_type_visibility"> [public]</span>
18838
18839
18840
18841
18842
18843
18844             </td> <!-- entry_type -->
18845
18846             <td class="entry_description">
18847               <p>A pixel <code>[R,<wbr/> G_<wbr/>even,<wbr/> G_<wbr/>odd,<wbr/> B]</code> that supplies the test pattern
18848 when <a href="#controls_android.sensor.testPatternMode">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode</a> is SOLID_<wbr/>COLOR.<wbr/></p>
18849             </td>
18850
18851             <td class="entry_units">
18852             </td>
18853
18854             <td class="entry_range">
18855             </td>
18856
18857             <td class="entry_tags">
18858             </td>
18859
18860           </tr>
18861           <tr class="entries_header">
18862             <th class="th_details" colspan="5">Details</th>
18863           </tr>
18864           <tr class="entry_cont">
18865             <td class="entry_details" colspan="5">
18866               <p>Each color channel is treated as an unsigned 32-bit integer.<wbr/>
18867 The camera device then uses the most significant X bits
18868 that correspond to how many bits are in its Bayer raw sensor
18869 output.<wbr/></p>
18870 <p>For example,<wbr/> a sensor with RAW10 Bayer output would use the
18871 10 most significant bits from each color channel.<wbr/></p>
18872             </td>
18873           </tr>
18874
18875           <tr class="entries_header">
18876             <th class="th_details" colspan="5">HAL Implementation Details</th>
18877           </tr>
18878           <tr class="entry_cont">
18879             <td class="entry_details" colspan="5">
18880
18881             </td>
18882           </tr>
18883
18884           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18885            <!-- end of entry -->
18886
18887
18888           <tr class="entry" id="dynamic_android.sensor.testPatternMode">
18889             <td class="entry_name
18890              " rowspan="5">
18891               android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode
18892             </td>
18893             <td class="entry_type">
18894                 <span class="entry_type_name entry_type_name_enum">int32</span>
18895
18896               <span class="entry_type_visibility"> [public]</span>
18897
18898
18899
18900
18901
18902                 <ul class="entry_type_enum">
18903                   <li>
18904                     <span class="entry_type_enum_name">OFF</span>
18905                     <span class="entry_type_enum_notes"><p>No test pattern mode is used,<wbr/> and the camera
18906 device returns captures from the image sensor.<wbr/></p>
18907 <p>This is the default if the key is not set.<wbr/></p></span>
18908                   </li>
18909                   <li>
18910                     <span class="entry_type_enum_name">SOLID_COLOR</span>
18911                     <span class="entry_type_enum_notes"><p>Each pixel in <code>[R,<wbr/> G_<wbr/>even,<wbr/> G_<wbr/>odd,<wbr/> B]</code> is replaced by its
18912 respective color channel provided in
18913 <a href="#controls_android.sensor.testPatternData">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Data</a>.<wbr/></p>
18914 <p>For example:</p>
18915 <pre><code>android.<wbr/>testPatternData = [0,<wbr/> 0xFFFFFFFF,<wbr/> 0xFFFFFFFF,<wbr/> 0]
18916 </code></pre>
18917 <p>All green pixels are 100% green.<wbr/> All red/<wbr/>blue pixels are black.<wbr/></p>
18918 <pre><code>android.<wbr/>testPatternData = [0xFFFFFFFF,<wbr/> 0,<wbr/> 0xFFFFFFFF,<wbr/> 0]
18919 </code></pre>
18920 <p>All red pixels are 100% red.<wbr/> Only the odd green pixels
18921 are 100% green.<wbr/> All blue pixels are 100% black.<wbr/></p></span>
18922                   </li>
18923                   <li>
18924                     <span class="entry_type_enum_name">COLOR_BARS</span>
18925                     <span class="entry_type_enum_notes"><p>All pixel data is replaced with an 8-bar color pattern.<wbr/></p>
18926 <p>The vertical bars (left-to-right) are as follows:</p>
18927 <ul>
18928 <li>100% white</li>
18929 <li>yellow</li>
18930 <li>cyan</li>
18931 <li>green</li>
18932 <li>magenta</li>
18933 <li>red</li>
18934 <li>blue</li>
18935 <li>black</li>
18936 </ul>
18937 <p>In general the image would look like the following:</p>
18938 <pre><code>W Y C G M R B K
18939 W Y C G M R B K
18940 W Y C G M R B K
18941 W Y C G M R B K
18942 W Y C G M R B K
18943 .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
18944 .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
18945 .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
18946
18947 (B = Blue,<wbr/> K = Black)
18948 </code></pre>
18949 <p>Each bar should take up 1/<wbr/>8 of the sensor pixel array width.<wbr/>
18950 When this is not possible,<wbr/> the bar size should be rounded
18951 down to the nearest integer and the pattern can repeat
18952 on the right side.<wbr/></p>
18953 <p>Each bar's height must always take up the full sensor
18954 pixel array height.<wbr/></p>
18955 <p>Each pixel in this test pattern must be set to either
18956 0% intensity or 100% intensity.<wbr/></p></span>
18957                   </li>
18958                   <li>
18959                     <span class="entry_type_enum_name">COLOR_BARS_FADE_TO_GRAY</span>
18960                     <span class="entry_type_enum_notes"><p>The test pattern is similar to COLOR_<wbr/>BARS,<wbr/> except that
18961 each bar should start at its specified color at the top,<wbr/>
18962 and fade to gray at the bottom.<wbr/></p>
18963 <p>Furthermore each bar is further subdivided into a left and
18964 right half.<wbr/> The left half should have a smooth gradient,<wbr/>
18965 and the right half should have a quantized gradient.<wbr/></p>
18966 <p>In particular,<wbr/> the right half's should consist of blocks of the
18967 same color for 1/<wbr/>16th active sensor pixel array width.<wbr/></p>
18968 <p>The least significant bits in the quantized gradient should
18969 be copied from the most significant bits of the smooth gradient.<wbr/></p>
18970 <p>The height of each bar should always be a multiple of 128.<wbr/>
18971 When this is not the case,<wbr/> the pattern should repeat at the bottom
18972 of the image.<wbr/></p></span>
18973                   </li>
18974                   <li>
18975                     <span class="entry_type_enum_name">PN9</span>
18976                     <span class="entry_type_enum_notes"><p>All pixel data is replaced by a pseudo-random sequence
18977 generated from a PN9 512-bit sequence (typically implemented
18978 in hardware with a linear feedback shift register).<wbr/></p>
18979 <p>The generator should be reset at the beginning of each frame,<wbr/>
18980 and thus each subsequent raw frame with this test pattern should
18981 be exactly the same as the last.<wbr/></p></span>
18982                   </li>
18983                   <li>
18984                     <span class="entry_type_enum_name">CUSTOM1</span>
18985                     <span class="entry_type_enum_value">256</span>
18986                     <span class="entry_type_enum_notes"><p>The first custom test pattern.<wbr/> All custom patterns that are
18987 available only on this camera device are at least this numeric
18988 value.<wbr/></p>
18989 <p>All of the custom test patterns will be static
18990 (that is the raw image must not vary from frame to frame).<wbr/></p></span>
18991                   </li>
18992                 </ul>
18993
18994             </td> <!-- entry_type -->
18995
18996             <td class="entry_description">
18997               <p>When enabled,<wbr/> the sensor sends a test pattern instead of
18998 doing a real exposure from the camera.<wbr/></p>
18999             </td>
19000
19001             <td class="entry_units">
19002             </td>
19003
19004             <td class="entry_range">
19005               <p><a href="#static_android.sensor.availableTestPatternModes">android.<wbr/>sensor.<wbr/>available<wbr/>Test<wbr/>Pattern<wbr/>Modes</a></p>
19006             </td>
19007
19008             <td class="entry_tags">
19009             </td>
19010
19011           </tr>
19012           <tr class="entries_header">
19013             <th class="th_details" colspan="5">Details</th>
19014           </tr>
19015           <tr class="entry_cont">
19016             <td class="entry_details" colspan="5">
19017               <p>When a test pattern is enabled,<wbr/> all manual sensor controls specified
19018 by android.<wbr/>sensor.<wbr/>* will be ignored.<wbr/> All other controls should
19019 work as normal.<wbr/></p>
19020 <p>For example,<wbr/> if manual flash is enabled,<wbr/> flash firing should still
19021 occur (and that the test pattern remain unmodified,<wbr/> since the flash
19022 would not actually affect it).<wbr/></p>
19023 <p>Defaults to OFF.<wbr/></p>
19024             </td>
19025           </tr>
19026
19027           <tr class="entries_header">
19028             <th class="th_details" colspan="5">HAL Implementation Details</th>
19029           </tr>
19030           <tr class="entry_cont">
19031             <td class="entry_details" colspan="5">
19032               <p>All test patterns are specified in the Bayer domain.<wbr/></p>
19033 <p>The HAL may choose to substitute test patterns from the sensor
19034 with test patterns from on-device memory.<wbr/> In that case,<wbr/> it should be
19035 indistinguishable to the ISP whether the data came from the
19036 sensor interconnect bus (such as CSI2) or memory.<wbr/></p>
19037             </td>
19038           </tr>
19039
19040           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19041            <!-- end of entry -->
19042
19043
19044           <tr class="entry" id="dynamic_android.sensor.rollingShutterSkew">
19045             <td class="entry_name
19046              " rowspan="5">
19047               android.<wbr/>sensor.<wbr/>rolling<wbr/>Shutter<wbr/>Skew
19048             </td>
19049             <td class="entry_type">
19050                 <span class="entry_type_name">int64</span>
19051
19052               <span class="entry_type_visibility"> [public]</span>
19053
19054
19055               <span class="entry_type_hwlevel">[limited] </span>
19056
19057
19058
19059
19060             </td> <!-- entry_type -->
19061
19062             <td class="entry_description">
19063               <p>Duration between the start of first row exposure
19064 and the start of last row exposure.<wbr/></p>
19065             </td>
19066
19067             <td class="entry_units">
19068               Nanoseconds
19069             </td>
19070
19071             <td class="entry_range">
19072               <p>&gt;= 0 and &lt;
19073 StreamConfigurationMap#getOutputMinFrameDuration(int,<wbr/> Size).<wbr/></p>
19074             </td>
19075
19076             <td class="entry_tags">
19077               <ul class="entry_tags">
19078                   <li><a href="#tag_V1">V1</a></li>
19079               </ul>
19080             </td>
19081
19082           </tr>
19083           <tr class="entries_header">
19084             <th class="th_details" colspan="5">Details</th>
19085           </tr>
19086           <tr class="entry_cont">
19087             <td class="entry_details" colspan="5">
19088               <p>This is the exposure time skew between the first and last
19089 row exposure start times.<wbr/> The first row and the last row are
19090 the first and last rows inside of the
19091 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></p>
19092 <p>For typical camera sensors that use rolling shutters,<wbr/> this is also equivalent
19093 to the frame readout time.<wbr/></p>
19094             </td>
19095           </tr>
19096
19097           <tr class="entries_header">
19098             <th class="th_details" colspan="5">HAL Implementation Details</th>
19099           </tr>
19100           <tr class="entry_cont">
19101             <td class="entry_details" colspan="5">
19102               <p>The HAL must report <code>0</code> if the sensor is using global shutter,<wbr/> where all pixels begin
19103 exposure at the same time.<wbr/></p>
19104             </td>
19105           </tr>
19106
19107           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19108            <!-- end of entry -->
19109
19110
19111
19112       <!-- end of kind -->
19113       </tbody>
19114
19115   <!-- end of section -->
19116   <tr><td colspan="6" id="section_shading" class="section">shading</td></tr>
19117
19118
19119       <tr><td colspan="6" class="kind">controls</td></tr>
19120
19121       <thead class="entries_header">
19122         <tr>
19123           <th class="th_name">Property Name</th>
19124           <th class="th_type">Type</th>
19125           <th class="th_description">Description</th>
19126           <th class="th_units">Units</th>
19127           <th class="th_range">Range</th>
19128           <th class="th_tags">Tags</th>
19129         </tr>
19130       </thead>
19131
19132       <tbody>
19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143           <tr class="entry" id="controls_android.shading.mode">
19144             <td class="entry_name
19145              " rowspan="3">
19146               android.<wbr/>shading.<wbr/>mode
19147             </td>
19148             <td class="entry_type">
19149                 <span class="entry_type_name entry_type_name_enum">byte</span>
19150
19151               <span class="entry_type_visibility"> [public]</span>
19152
19153
19154               <span class="entry_type_hwlevel">[full] </span>
19155
19156
19157
19158                 <ul class="entry_type_enum">
19159                   <li>
19160                     <span class="entry_type_enum_name">OFF</span>
19161                     <span class="entry_type_enum_notes"><p>No lens shading correction is applied.<wbr/></p></span>
19162                   </li>
19163                   <li>
19164                     <span class="entry_type_enum_name">FAST</span>
19165                     <span class="entry_type_enum_notes"><p>Apply lens shading corrections,<wbr/> without slowing
19166 frame rate relative to sensor raw output</p></span>
19167                   </li>
19168                   <li>
19169                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
19170                     <span class="entry_type_enum_notes"><p>Apply high-quality lens shading correction,<wbr/> at the
19171 cost of reduced frame rate.<wbr/></p></span>
19172                   </li>
19173                 </ul>
19174
19175             </td> <!-- entry_type -->
19176
19177             <td class="entry_description">
19178               <p>Quality of lens shading correction applied
19179 to the image data.<wbr/></p>
19180             </td>
19181
19182             <td class="entry_units">
19183             </td>
19184
19185             <td class="entry_range">
19186             </td>
19187
19188             <td class="entry_tags">
19189             </td>
19190
19191           </tr>
19192           <tr class="entries_header">
19193             <th class="th_details" colspan="5">Details</th>
19194           </tr>
19195           <tr class="entry_cont">
19196             <td class="entry_details" colspan="5">
19197               <p>When set to OFF mode,<wbr/> no lens shading correction will be applied by the
19198 camera device,<wbr/> and an identity lens shading map data will be provided
19199 if <code><a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a> == ON</code>.<wbr/> For example,<wbr/> for lens
19200 shading map with size of <code>[ 4,<wbr/> 3 ]</code>,<wbr/>
19201 the output <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Correction<wbr/>Map</a> for this case will be an identity
19202 map shown below:</p>
19203 <pre><code>[ 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
19204  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
19205  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
19206  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
19207  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
19208  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0 ]
19209 </code></pre>
19210 <p>When set to other modes,<wbr/> lens shading correction will be applied by the camera
19211 device.<wbr/> Applications can request lens shading map data by setting
19212 <a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a> to ON,<wbr/> and then the camera device will provide lens
19213 shading map data in <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Correction<wbr/>Map</a>; the returned shading map
19214 data will be the one applied by the camera device for this capture request.<wbr/></p>
19215 <p>The shading map data may depend on the auto-exposure (AE) and AWB statistics,<wbr/> therefore
19216 the reliability of the map data may be affected by the AE and AWB algorithms.<wbr/> When AE and
19217 AWB are in AUTO modes(<a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>!=</code> OFF and <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> <code>!=</code>
19218 OFF),<wbr/> to get best results,<wbr/> it is recommended that the applications wait for the AE and AWB
19219 to be converged before using the returned shading map data.<wbr/></p>
19220             </td>
19221           </tr>
19222
19223
19224           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19225            <!-- end of entry -->
19226
19227
19228           <tr class="entry" id="controls_android.shading.strength">
19229             <td class="entry_name
19230              " rowspan="1">
19231               android.<wbr/>shading.<wbr/>strength
19232             </td>
19233             <td class="entry_type">
19234                 <span class="entry_type_name">byte</span>
19235
19236               <span class="entry_type_visibility"> [system]</span>
19237
19238
19239
19240
19241
19242
19243             </td> <!-- entry_type -->
19244
19245             <td class="entry_description">
19246               <p>Control the amount of shading correction
19247 applied to the images</p>
19248             </td>
19249
19250             <td class="entry_units">
19251               unitless: 1-10; 10 is full shading
19252           compensation
19253             </td>
19254
19255             <td class="entry_range">
19256             </td>
19257
19258             <td class="entry_tags">
19259               <ul class="entry_tags">
19260                   <li><a href="#tag_FUTURE">FUTURE</a></li>
19261               </ul>
19262             </td>
19263
19264           </tr>
19265
19266
19267           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19268            <!-- end of entry -->
19269
19270
19271
19272       <!-- end of kind -->
19273       </tbody>
19274       <tr><td colspan="6" class="kind">dynamic</td></tr>
19275
19276       <thead class="entries_header">
19277         <tr>
19278           <th class="th_name">Property Name</th>
19279           <th class="th_type">Type</th>
19280           <th class="th_description">Description</th>
19281           <th class="th_units">Units</th>
19282           <th class="th_range">Range</th>
19283           <th class="th_tags">Tags</th>
19284         </tr>
19285       </thead>
19286
19287       <tbody>
19288
19289
19290
19291
19292
19293
19294
19295
19296
19297
19298           <tr class="entry" id="dynamic_android.shading.mode">
19299             <td class="entry_name
19300              " rowspan="3">
19301               android.<wbr/>shading.<wbr/>mode
19302             </td>
19303             <td class="entry_type">
19304                 <span class="entry_type_name entry_type_name_enum">byte</span>
19305
19306               <span class="entry_type_visibility"> [public]</span>
19307
19308
19309               <span class="entry_type_hwlevel">[full] </span>
19310
19311
19312
19313                 <ul class="entry_type_enum">
19314                   <li>
19315                     <span class="entry_type_enum_name">OFF</span>
19316                     <span class="entry_type_enum_notes"><p>No lens shading correction is applied.<wbr/></p></span>
19317                   </li>
19318                   <li>
19319                     <span class="entry_type_enum_name">FAST</span>
19320                     <span class="entry_type_enum_notes"><p>Apply lens shading corrections,<wbr/> without slowing
19321 frame rate relative to sensor raw output</p></span>
19322                   </li>
19323                   <li>
19324                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
19325                     <span class="entry_type_enum_notes"><p>Apply high-quality lens shading correction,<wbr/> at the
19326 cost of reduced frame rate.<wbr/></p></span>
19327                   </li>
19328                 </ul>
19329
19330             </td> <!-- entry_type -->
19331
19332             <td class="entry_description">
19333               <p>Quality of lens shading correction applied
19334 to the image data.<wbr/></p>
19335             </td>
19336
19337             <td class="entry_units">
19338             </td>
19339
19340             <td class="entry_range">
19341             </td>
19342
19343             <td class="entry_tags">
19344             </td>
19345
19346           </tr>
19347           <tr class="entries_header">
19348             <th class="th_details" colspan="5">Details</th>
19349           </tr>
19350           <tr class="entry_cont">
19351             <td class="entry_details" colspan="5">
19352               <p>When set to OFF mode,<wbr/> no lens shading correction will be applied by the
19353 camera device,<wbr/> and an identity lens shading map data will be provided
19354 if <code><a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a> == ON</code>.<wbr/> For example,<wbr/> for lens
19355 shading map with size of <code>[ 4,<wbr/> 3 ]</code>,<wbr/>
19356 the output <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Correction<wbr/>Map</a> for this case will be an identity
19357 map shown below:</p>
19358 <pre><code>[ 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
19359  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
19360  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
19361  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
19362  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
19363  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0 ]
19364 </code></pre>
19365 <p>When set to other modes,<wbr/> lens shading correction will be applied by the camera
19366 device.<wbr/> Applications can request lens shading map data by setting
19367 <a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a> to ON,<wbr/> and then the camera device will provide lens
19368 shading map data in <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Correction<wbr/>Map</a>; the returned shading map
19369 data will be the one applied by the camera device for this capture request.<wbr/></p>
19370 <p>The shading map data may depend on the auto-exposure (AE) and AWB statistics,<wbr/> therefore
19371 the reliability of the map data may be affected by the AE and AWB algorithms.<wbr/> When AE and
19372 AWB are in AUTO modes(<a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>!=</code> OFF and <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> <code>!=</code>
19373 OFF),<wbr/> to get best results,<wbr/> it is recommended that the applications wait for the AE and AWB
19374 to be converged before using the returned shading map data.<wbr/></p>
19375             </td>
19376           </tr>
19377
19378
19379           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19380            <!-- end of entry -->
19381
19382
19383
19384       <!-- end of kind -->
19385       </tbody>
19386
19387   <!-- end of section -->
19388   <tr><td colspan="6" id="section_statistics" class="section">statistics</td></tr>
19389
19390
19391       <tr><td colspan="6" class="kind">controls</td></tr>
19392
19393       <thead class="entries_header">
19394         <tr>
19395           <th class="th_name">Property Name</th>
19396           <th class="th_type">Type</th>
19397           <th class="th_description">Description</th>
19398           <th class="th_units">Units</th>
19399           <th class="th_range">Range</th>
19400           <th class="th_tags">Tags</th>
19401         </tr>
19402       </thead>
19403
19404       <tbody>
19405
19406
19407
19408
19409
19410
19411
19412
19413
19414
19415           <tr class="entry" id="controls_android.statistics.faceDetectMode">
19416             <td class="entry_name
19417              " rowspan="5">
19418               android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode
19419             </td>
19420             <td class="entry_type">
19421                 <span class="entry_type_name entry_type_name_enum">byte</span>
19422
19423               <span class="entry_type_visibility"> [public]</span>
19424
19425
19426               <span class="entry_type_hwlevel">[legacy] </span>
19427
19428
19429
19430                 <ul class="entry_type_enum">
19431                   <li>
19432                     <span class="entry_type_enum_name">OFF</span>
19433                     <span class="entry_type_enum_notes"><p>Do not include face detection statistics in capture
19434 results.<wbr/></p></span>
19435                   </li>
19436                   <li>
19437                     <span class="entry_type_enum_name">SIMPLE</span>
19438                     <span class="entry_type_enum_optional">[optional]</span>
19439                     <span class="entry_type_enum_notes"><p>Return face rectangle and confidence values only.<wbr/></p></span>
19440                   </li>
19441                   <li>
19442                     <span class="entry_type_enum_name">FULL</span>
19443                     <span class="entry_type_enum_optional">[optional]</span>
19444                     <span class="entry_type_enum_notes"><p>Return all face
19445 metadata.<wbr/></p>
19446 <p>In this mode,<wbr/> face rectangles,<wbr/> scores,<wbr/> landmarks,<wbr/> and face IDs are all valid.<wbr/></p></span>
19447                   </li>
19448                 </ul>
19449
19450             </td> <!-- entry_type -->
19451
19452             <td class="entry_description">
19453               <p>Operating mode for the face detector
19454 unit.<wbr/></p>
19455             </td>
19456
19457             <td class="entry_units">
19458             </td>
19459
19460             <td class="entry_range">
19461               <p><a href="#static_android.statistics.info.availableFaceDetectModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Face<wbr/>Detect<wbr/>Modes</a></p>
19462             </td>
19463
19464             <td class="entry_tags">
19465               <ul class="entry_tags">
19466                   <li><a href="#tag_BC">BC</a></li>
19467               </ul>
19468             </td>
19469
19470           </tr>
19471           <tr class="entries_header">
19472             <th class="th_details" colspan="5">Details</th>
19473           </tr>
19474           <tr class="entry_cont">
19475             <td class="entry_details" colspan="5">
19476               <p>Whether face detection is enabled,<wbr/> and whether it
19477 should output just the basic fields or the full set of
19478 fields.<wbr/></p>
19479             </td>
19480           </tr>
19481
19482           <tr class="entries_header">
19483             <th class="th_details" colspan="5">HAL Implementation Details</th>
19484           </tr>
19485           <tr class="entry_cont">
19486             <td class="entry_details" colspan="5">
19487               <p>SIMPLE mode must fill in <a href="#dynamic_android.statistics.faceRectangles">android.<wbr/>statistics.<wbr/>face<wbr/>Rectangles</a> and
19488 <a href="#dynamic_android.statistics.faceScores">android.<wbr/>statistics.<wbr/>face<wbr/>Scores</a>.<wbr/>
19489 FULL mode must also fill in <a href="#dynamic_android.statistics.faceIds">android.<wbr/>statistics.<wbr/>face<wbr/>Ids</a>,<wbr/> and
19490 <a href="#dynamic_android.statistics.faceLandmarks">android.<wbr/>statistics.<wbr/>face<wbr/>Landmarks</a>.<wbr/></p>
19491             </td>
19492           </tr>
19493
19494           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19495            <!-- end of entry -->
19496
19497
19498           <tr class="entry" id="controls_android.statistics.histogramMode">
19499             <td class="entry_name
19500              " rowspan="1">
19501               android.<wbr/>statistics.<wbr/>histogram<wbr/>Mode
19502             </td>
19503             <td class="entry_type">
19504                 <span class="entry_type_name entry_type_name_enum">byte</span>
19505
19506               <span class="entry_type_visibility"> [system as boolean]</span>
19507
19508
19509
19510
19511
19512                 <ul class="entry_type_enum">
19513                   <li>
19514                     <span class="entry_type_enum_name">OFF</span>
19515                   </li>
19516                   <li>
19517                     <span class="entry_type_enum_name">ON</span>
19518                   </li>
19519                 </ul>
19520
19521             </td> <!-- entry_type -->
19522
19523             <td class="entry_description">
19524               <p>Operating mode for histogram
19525 generation</p>
19526             </td>
19527
19528             <td class="entry_units">
19529             </td>
19530
19531             <td class="entry_range">
19532             </td>
19533
19534             <td class="entry_tags">
19535               <ul class="entry_tags">
19536                   <li><a href="#tag_FUTURE">FUTURE</a></li>
19537               </ul>
19538             </td>
19539
19540           </tr>
19541
19542
19543           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19544            <!-- end of entry -->
19545
19546
19547           <tr class="entry" id="controls_android.statistics.sharpnessMapMode">
19548             <td class="entry_name
19549              " rowspan="1">
19550               android.<wbr/>statistics.<wbr/>sharpness<wbr/>Map<wbr/>Mode
19551             </td>
19552             <td class="entry_type">
19553                 <span class="entry_type_name entry_type_name_enum">byte</span>
19554
19555               <span class="entry_type_visibility"> [system as boolean]</span>
19556
19557
19558
19559
19560
19561                 <ul class="entry_type_enum">
19562                   <li>
19563                     <span class="entry_type_enum_name">OFF</span>
19564                   </li>
19565                   <li>
19566                     <span class="entry_type_enum_name">ON</span>
19567                   </li>
19568                 </ul>
19569
19570             </td> <!-- entry_type -->
19571
19572             <td class="entry_description">
19573               <p>Operating mode for sharpness map
19574 generation</p>
19575             </td>
19576
19577             <td class="entry_units">
19578             </td>
19579
19580             <td class="entry_range">
19581             </td>
19582
19583             <td class="entry_tags">
19584               <ul class="entry_tags">
19585                   <li><a href="#tag_FUTURE">FUTURE</a></li>
19586               </ul>
19587             </td>
19588
19589           </tr>
19590
19591
19592           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19593            <!-- end of entry -->
19594
19595
19596           <tr class="entry" id="controls_android.statistics.hotPixelMapMode">
19597             <td class="entry_name
19598              " rowspan="3">
19599               android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map<wbr/>Mode
19600             </td>
19601             <td class="entry_type">
19602                 <span class="entry_type_name entry_type_name_enum">byte</span>
19603
19604               <span class="entry_type_visibility"> [public as boolean]</span>
19605
19606
19607
19608
19609
19610                 <ul class="entry_type_enum">
19611                   <li>
19612                     <span class="entry_type_enum_name">OFF</span>
19613                     <span class="entry_type_enum_notes"><p>Hot pixel map production is disabled.<wbr/></p></span>
19614                   </li>
19615                   <li>
19616                     <span class="entry_type_enum_name">ON</span>
19617                     <span class="entry_type_enum_notes"><p>Hot pixel map production is enabled.<wbr/></p></span>
19618                   </li>
19619                 </ul>
19620
19621             </td> <!-- entry_type -->
19622
19623             <td class="entry_description">
19624               <p>Operating mode for hot pixel map generation.<wbr/></p>
19625             </td>
19626
19627             <td class="entry_units">
19628             </td>
19629
19630             <td class="entry_range">
19631               <p><a href="#static_android.statistics.info.availableHotPixelMapModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Map<wbr/>Modes</a></p>
19632             </td>
19633
19634             <td class="entry_tags">
19635               <ul class="entry_tags">
19636                   <li><a href="#tag_V1">V1</a></li>
19637                   <li><a href="#tag_RAW">RAW</a></li>
19638               </ul>
19639             </td>
19640
19641           </tr>
19642           <tr class="entries_header">
19643             <th class="th_details" colspan="5">Details</th>
19644           </tr>
19645           <tr class="entry_cont">
19646             <td class="entry_details" colspan="5">
19647               <p>If set to <code>true</code>,<wbr/> a hot pixel map is returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/>
19648 If set to <code>false</code>,<wbr/> no hot pixel map will be returned.<wbr/></p>
19649             </td>
19650           </tr>
19651
19652
19653           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19654            <!-- end of entry -->
19655
19656
19657           <tr class="entry" id="controls_android.statistics.lensShadingMapMode">
19658             <td class="entry_name
19659              " rowspan="3">
19660               android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode
19661             </td>
19662             <td class="entry_type">
19663                 <span class="entry_type_name entry_type_name_enum">byte</span>
19664
19665               <span class="entry_type_visibility"> [public]</span>
19666
19667
19668               <span class="entry_type_hwlevel">[full] </span>
19669
19670
19671
19672                 <ul class="entry_type_enum">
19673                   <li>
19674                     <span class="entry_type_enum_name">OFF</span>
19675                     <span class="entry_type_enum_notes"><p>Do not include a lens shading map in the capture result.<wbr/></p></span>
19676                   </li>
19677                   <li>
19678                     <span class="entry_type_enum_name">ON</span>
19679                     <span class="entry_type_enum_notes"><p>Include a lens shading map in the capture result.<wbr/></p></span>
19680                   </li>
19681                 </ul>
19682
19683             </td> <!-- entry_type -->
19684
19685             <td class="entry_description">
19686               <p>Whether the camera device will output the lens
19687 shading map in output result metadata.<wbr/></p>
19688             </td>
19689
19690             <td class="entry_units">
19691             </td>
19692
19693             <td class="entry_range">
19694             </td>
19695
19696             <td class="entry_tags">
19697               <ul class="entry_tags">
19698                   <li><a href="#tag_RAW">RAW</a></li>
19699               </ul>
19700             </td>
19701
19702           </tr>
19703           <tr class="entries_header">
19704             <th class="th_details" colspan="5">Details</th>
19705           </tr>
19706           <tr class="entry_cont">
19707             <td class="entry_details" colspan="5">
19708               <p>When set to ON,<wbr/>
19709 <a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a> will be provided in
19710 the output result metadata.<wbr/></p>
19711 <p>ON is always supported on devices with the RAW capability.<wbr/></p>
19712             </td>
19713           </tr>
19714
19715
19716           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19717            <!-- end of entry -->
19718
19719
19720
19721       <!-- end of kind -->
19722       </tbody>
19723       <tr><td colspan="6" class="kind">static</td></tr>
19724
19725       <thead class="entries_header">
19726         <tr>
19727           <th class="th_name">Property Name</th>
19728           <th class="th_type">Type</th>
19729           <th class="th_description">Description</th>
19730           <th class="th_units">Units</th>
19731           <th class="th_range">Range</th>
19732           <th class="th_tags">Tags</th>
19733         </tr>
19734       </thead>
19735
19736       <tbody>
19737
19738
19739
19740
19741
19742
19743
19744
19745
19746
19747
19748
19749           <tr class="entry" id="static_android.statistics.info.availableFaceDetectModes">
19750             <td class="entry_name
19751              " rowspan="3">
19752               android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Face<wbr/>Detect<wbr/>Modes
19753             </td>
19754             <td class="entry_type">
19755                 <span class="entry_type_name">byte</span>
19756                 <span class="entry_type_container">x</span>
19757
19758                 <span class="entry_type_array">
19759                   n
19760                 </span>
19761               <span class="entry_type_visibility"> [public as enumList]</span>
19762
19763
19764               <span class="entry_type_hwlevel">[legacy] </span>
19765
19766
19767                 <div class="entry_type_notes">List of enums from android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</div>
19768
19769
19770             </td> <!-- entry_type -->
19771
19772             <td class="entry_description">
19773               <p>List of face detection modes for <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> that are
19774 supported by this camera device.<wbr/></p>
19775             </td>
19776
19777             <td class="entry_units">
19778             </td>
19779
19780             <td class="entry_range">
19781               <p>Any value listed in <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a></p>
19782             </td>
19783
19784             <td class="entry_tags">
19785             </td>
19786
19787           </tr>
19788           <tr class="entries_header">
19789             <th class="th_details" colspan="5">Details</th>
19790           </tr>
19791           <tr class="entry_cont">
19792             <td class="entry_details" colspan="5">
19793               <p>OFF is always supported.<wbr/></p>
19794             </td>
19795           </tr>
19796
19797
19798           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19799            <!-- end of entry -->
19800
19801
19802           <tr class="entry" id="static_android.statistics.info.histogramBucketCount">
19803             <td class="entry_name
19804              " rowspan="1">
19805               android.<wbr/>statistics.<wbr/>info.<wbr/>histogram<wbr/>Bucket<wbr/>Count
19806             </td>
19807             <td class="entry_type">
19808                 <span class="entry_type_name">int32</span>
19809
19810               <span class="entry_type_visibility"> [system]</span>
19811
19812
19813
19814
19815
19816
19817             </td> <!-- entry_type -->
19818
19819             <td class="entry_description">
19820               <p>Number of histogram buckets
19821 supported</p>
19822             </td>
19823
19824             <td class="entry_units">
19825             </td>
19826
19827             <td class="entry_range">
19828               <p>&gt;= 64</p>
19829             </td>
19830
19831             <td class="entry_tags">
19832               <ul class="entry_tags">
19833                   <li><a href="#tag_FUTURE">FUTURE</a></li>
19834               </ul>
19835             </td>
19836
19837           </tr>
19838
19839
19840           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19841            <!-- end of entry -->
19842
19843
19844           <tr class="entry" id="static_android.statistics.info.maxFaceCount">
19845             <td class="entry_name
19846              " rowspan="1">
19847               android.<wbr/>statistics.<wbr/>info.<wbr/>max<wbr/>Face<wbr/>Count
19848             </td>
19849             <td class="entry_type">
19850                 <span class="entry_type_name">int32</span>
19851
19852               <span class="entry_type_visibility"> [public]</span>
19853
19854
19855               <span class="entry_type_hwlevel">[legacy] </span>
19856
19857
19858
19859
19860             </td> <!-- entry_type -->
19861
19862             <td class="entry_description">
19863               <p>The maximum number of simultaneously detectable
19864 faces.<wbr/></p>
19865             </td>
19866
19867             <td class="entry_units">
19868             </td>
19869
19870             <td class="entry_range">
19871               <p>0 for cameras without available face detection; otherwise:
19872 <code>&gt;=4</code> for LIMITED or FULL hwlevel devices or
19873 <code>&gt;0</code> for LEGACY devices.<wbr/></p>
19874             </td>
19875
19876             <td class="entry_tags">
19877               <ul class="entry_tags">
19878                   <li><a href="#tag_BC">BC</a></li>
19879               </ul>
19880             </td>
19881
19882           </tr>
19883
19884
19885           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19886            <!-- end of entry -->
19887
19888
19889           <tr class="entry" id="static_android.statistics.info.maxHistogramCount">
19890             <td class="entry_name
19891              " rowspan="1">
19892               android.<wbr/>statistics.<wbr/>info.<wbr/>max<wbr/>Histogram<wbr/>Count
19893             </td>
19894             <td class="entry_type">
19895                 <span class="entry_type_name">int32</span>
19896
19897               <span class="entry_type_visibility"> [system]</span>
19898
19899
19900
19901
19902
19903
19904             </td> <!-- entry_type -->
19905
19906             <td class="entry_description">
19907               <p>Maximum value possible for a histogram
19908 bucket</p>
19909             </td>
19910
19911             <td class="entry_units">
19912             </td>
19913
19914             <td class="entry_range">
19915             </td>
19916
19917             <td class="entry_tags">
19918               <ul class="entry_tags">
19919                   <li><a href="#tag_FUTURE">FUTURE</a></li>
19920               </ul>
19921             </td>
19922
19923           </tr>
19924
19925
19926           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19927            <!-- end of entry -->
19928
19929
19930           <tr class="entry" id="static_android.statistics.info.maxSharpnessMapValue">
19931             <td class="entry_name
19932              " rowspan="1">
19933               android.<wbr/>statistics.<wbr/>info.<wbr/>max<wbr/>Sharpness<wbr/>Map<wbr/>Value
19934             </td>
19935             <td class="entry_type">
19936                 <span class="entry_type_name">int32</span>
19937
19938               <span class="entry_type_visibility"> [system]</span>
19939
19940
19941
19942
19943
19944
19945             </td> <!-- entry_type -->
19946
19947             <td class="entry_description">
19948               <p>Maximum value possible for a sharpness map
19949 region.<wbr/></p>
19950             </td>
19951
19952             <td class="entry_units">
19953             </td>
19954
19955             <td class="entry_range">
19956             </td>
19957
19958             <td class="entry_tags">
19959               <ul class="entry_tags">
19960                   <li><a href="#tag_FUTURE">FUTURE</a></li>
19961               </ul>
19962             </td>
19963
19964           </tr>
19965
19966
19967           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19968            <!-- end of entry -->
19969
19970
19971           <tr class="entry" id="static_android.statistics.info.sharpnessMapSize">
19972             <td class="entry_name
19973              " rowspan="1">
19974               android.<wbr/>statistics.<wbr/>info.<wbr/>sharpness<wbr/>Map<wbr/>Size
19975             </td>
19976             <td class="entry_type">
19977                 <span class="entry_type_name">int32</span>
19978                 <span class="entry_type_container">x</span>
19979
19980                 <span class="entry_type_array">
19981                   2
19982                 </span>
19983               <span class="entry_type_visibility"> [system as size]</span>
19984
19985
19986
19987
19988                 <div class="entry_type_notes">width x height</div>
19989
19990
19991             </td> <!-- entry_type -->
19992
19993             <td class="entry_description">
19994               <p>Dimensions of the sharpness
19995 map</p>
19996             </td>
19997
19998             <td class="entry_units">
19999             </td>
20000
20001             <td class="entry_range">
20002               <p>Must be at least 32 x 32</p>
20003             </td>
20004
20005             <td class="entry_tags">
20006               <ul class="entry_tags">
20007                   <li><a href="#tag_FUTURE">FUTURE</a></li>
20008               </ul>
20009             </td>
20010
20011           </tr>
20012
20013
20014           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20015            <!-- end of entry -->
20016
20017
20018           <tr class="entry" id="static_android.statistics.info.availableHotPixelMapModes">
20019             <td class="entry_name
20020              " rowspan="3">
20021               android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Map<wbr/>Modes
20022             </td>
20023             <td class="entry_type">
20024                 <span class="entry_type_name">byte</span>
20025                 <span class="entry_type_container">x</span>
20026
20027                 <span class="entry_type_array">
20028                   n
20029                 </span>
20030               <span class="entry_type_visibility"> [public as boolean]</span>
20031
20032
20033
20034
20035                 <div class="entry_type_notes">list of enums</div>
20036
20037
20038             </td> <!-- entry_type -->
20039
20040             <td class="entry_description">
20041               <p>List of hot pixel map output modes for <a href="#controls_android.statistics.hotPixelMapMode">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map<wbr/>Mode</a> that are
20042 supported by this camera device.<wbr/></p>
20043             </td>
20044
20045             <td class="entry_units">
20046             </td>
20047
20048             <td class="entry_range">
20049               <p>Any value listed in <a href="#controls_android.statistics.hotPixelMapMode">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map<wbr/>Mode</a></p>
20050             </td>
20051
20052             <td class="entry_tags">
20053               <ul class="entry_tags">
20054                   <li><a href="#tag_V1">V1</a></li>
20055                   <li><a href="#tag_RAW">RAW</a></li>
20056               </ul>
20057             </td>
20058
20059           </tr>
20060           <tr class="entries_header">
20061             <th class="th_details" colspan="5">Details</th>
20062           </tr>
20063           <tr class="entry_cont">
20064             <td class="entry_details" colspan="5">
20065               <p>If no hotpixel map output is available for this camera device,<wbr/> this will contain only
20066 <code>false</code>.<wbr/></p>
20067 <p>ON is always supported on devices with the RAW capability.<wbr/></p>
20068             </td>
20069           </tr>
20070
20071
20072           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20073            <!-- end of entry -->
20074
20075
20076
20077
20078
20079
20080       <!-- end of kind -->
20081       </tbody>
20082       <tr><td colspan="6" class="kind">dynamic</td></tr>
20083
20084       <thead class="entries_header">
20085         <tr>
20086           <th class="th_name">Property Name</th>
20087           <th class="th_type">Type</th>
20088           <th class="th_description">Description</th>
20089           <th class="th_units">Units</th>
20090           <th class="th_range">Range</th>
20091           <th class="th_tags">Tags</th>
20092         </tr>
20093       </thead>
20094
20095       <tbody>
20096
20097
20098
20099
20100
20101
20102
20103
20104
20105
20106           <tr class="entry" id="dynamic_android.statistics.faceDetectMode">
20107             <td class="entry_name
20108              " rowspan="5">
20109               android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode
20110             </td>
20111             <td class="entry_type">
20112                 <span class="entry_type_name entry_type_name_enum">byte</span>
20113
20114               <span class="entry_type_visibility"> [public]</span>
20115
20116
20117               <span class="entry_type_hwlevel">[legacy] </span>
20118
20119
20120
20121                 <ul class="entry_type_enum">
20122                   <li>
20123                     <span class="entry_type_enum_name">OFF</span>
20124                     <span class="entry_type_enum_notes"><p>Do not include face detection statistics in capture
20125 results.<wbr/></p></span>
20126                   </li>
20127                   <li>
20128                     <span class="entry_type_enum_name">SIMPLE</span>
20129                     <span class="entry_type_enum_optional">[optional]</span>
20130                     <span class="entry_type_enum_notes"><p>Return face rectangle and confidence values only.<wbr/></p></span>
20131                   </li>
20132                   <li>
20133                     <span class="entry_type_enum_name">FULL</span>
20134                     <span class="entry_type_enum_optional">[optional]</span>
20135                     <span class="entry_type_enum_notes"><p>Return all face
20136 metadata.<wbr/></p>
20137 <p>In this mode,<wbr/> face rectangles,<wbr/> scores,<wbr/> landmarks,<wbr/> and face IDs are all valid.<wbr/></p></span>
20138                   </li>
20139                 </ul>
20140
20141             </td> <!-- entry_type -->
20142
20143             <td class="entry_description">
20144               <p>Operating mode for the face detector
20145 unit.<wbr/></p>
20146             </td>
20147
20148             <td class="entry_units">
20149             </td>
20150
20151             <td class="entry_range">
20152               <p><a href="#static_android.statistics.info.availableFaceDetectModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Face<wbr/>Detect<wbr/>Modes</a></p>
20153             </td>
20154
20155             <td class="entry_tags">
20156               <ul class="entry_tags">
20157                   <li><a href="#tag_BC">BC</a></li>
20158               </ul>
20159             </td>
20160
20161           </tr>
20162           <tr class="entries_header">
20163             <th class="th_details" colspan="5">Details</th>
20164           </tr>
20165           <tr class="entry_cont">
20166             <td class="entry_details" colspan="5">
20167               <p>Whether face detection is enabled,<wbr/> and whether it
20168 should output just the basic fields or the full set of
20169 fields.<wbr/></p>
20170             </td>
20171           </tr>
20172
20173           <tr class="entries_header">
20174             <th class="th_details" colspan="5">HAL Implementation Details</th>
20175           </tr>
20176           <tr class="entry_cont">
20177             <td class="entry_details" colspan="5">
20178               <p>SIMPLE mode must fill in <a href="#dynamic_android.statistics.faceRectangles">android.<wbr/>statistics.<wbr/>face<wbr/>Rectangles</a> and
20179 <a href="#dynamic_android.statistics.faceScores">android.<wbr/>statistics.<wbr/>face<wbr/>Scores</a>.<wbr/>
20180 FULL mode must also fill in <a href="#dynamic_android.statistics.faceIds">android.<wbr/>statistics.<wbr/>face<wbr/>Ids</a>,<wbr/> and
20181 <a href="#dynamic_android.statistics.faceLandmarks">android.<wbr/>statistics.<wbr/>face<wbr/>Landmarks</a>.<wbr/></p>
20182             </td>
20183           </tr>
20184
20185           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20186            <!-- end of entry -->
20187
20188
20189           <tr class="entry" id="dynamic_android.statistics.faceIds">
20190             <td class="entry_name
20191              " rowspan="3">
20192               android.<wbr/>statistics.<wbr/>face<wbr/>Ids
20193             </td>
20194             <td class="entry_type">
20195                 <span class="entry_type_name">int32</span>
20196                 <span class="entry_type_container">x</span>
20197
20198                 <span class="entry_type_array">
20199                   n
20200                 </span>
20201               <span class="entry_type_visibility"> [hidden]</span>
20202
20203
20204               <span class="entry_type_hwlevel">[legacy] </span>
20205
20206
20207
20208
20209             </td> <!-- entry_type -->
20210
20211             <td class="entry_description">
20212               <p>List of unique IDs for detected faces.<wbr/></p>
20213             </td>
20214
20215             <td class="entry_units">
20216             </td>
20217
20218             <td class="entry_range">
20219             </td>
20220
20221             <td class="entry_tags">
20222               <ul class="entry_tags">
20223                   <li><a href="#tag_BC">BC</a></li>
20224               </ul>
20225             </td>
20226
20227           </tr>
20228           <tr class="entries_header">
20229             <th class="th_details" colspan="5">Details</th>
20230           </tr>
20231           <tr class="entry_cont">
20232             <td class="entry_details" colspan="5">
20233               <p>Each detected face is given a unique ID that is valid for as long as the face is visible
20234 to the camera device.<wbr/>  A face that leaves the field of view and later returns may be
20235 assigned a new ID.<wbr/></p>
20236 <p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> == FULL</p>
20237             </td>
20238           </tr>
20239
20240
20241           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20242            <!-- end of entry -->
20243
20244
20245           <tr class="entry" id="dynamic_android.statistics.faceLandmarks">
20246             <td class="entry_name
20247              " rowspan="3">
20248               android.<wbr/>statistics.<wbr/>face<wbr/>Landmarks
20249             </td>
20250             <td class="entry_type">
20251                 <span class="entry_type_name">int32</span>
20252                 <span class="entry_type_container">x</span>
20253
20254                 <span class="entry_type_array">
20255                   n x 6
20256                 </span>
20257               <span class="entry_type_visibility"> [hidden]</span>
20258
20259
20260               <span class="entry_type_hwlevel">[legacy] </span>
20261
20262
20263                 <div class="entry_type_notes">(leftEyeX,<wbr/> leftEyeY,<wbr/> rightEyeX,<wbr/> rightEyeY,<wbr/> mouthX,<wbr/> mouthY)</div>
20264
20265
20266             </td> <!-- entry_type -->
20267
20268             <td class="entry_description">
20269               <p>List of landmarks for detected
20270 faces.<wbr/></p>
20271             </td>
20272
20273             <td class="entry_units">
20274             </td>
20275
20276             <td class="entry_range">
20277             </td>
20278
20279             <td class="entry_tags">
20280               <ul class="entry_tags">
20281                   <li><a href="#tag_BC">BC</a></li>
20282               </ul>
20283             </td>
20284
20285           </tr>
20286           <tr class="entries_header">
20287             <th class="th_details" colspan="5">Details</th>
20288           </tr>
20289           <tr class="entry_cont">
20290             <td class="entry_details" colspan="5">
20291               <p>The coordinate system is that of <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>,<wbr/> with
20292 <code>(0,<wbr/> 0)</code> being the top-left pixel of the active array.<wbr/></p>
20293 <p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> == FULL</p>
20294             </td>
20295           </tr>
20296
20297
20298           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20299            <!-- end of entry -->
20300
20301
20302           <tr class="entry" id="dynamic_android.statistics.faceRectangles">
20303             <td class="entry_name
20304              " rowspan="3">
20305               android.<wbr/>statistics.<wbr/>face<wbr/>Rectangles
20306             </td>
20307             <td class="entry_type">
20308                 <span class="entry_type_name">int32</span>
20309                 <span class="entry_type_container">x</span>
20310
20311                 <span class="entry_type_array">
20312                   n x 4
20313                 </span>
20314               <span class="entry_type_visibility"> [hidden as rectangle]</span>
20315
20316
20317               <span class="entry_type_hwlevel">[legacy] </span>
20318
20319
20320                 <div class="entry_type_notes">(xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax).<wbr/> (0,<wbr/>0) is top-left of active pixel area</div>
20321
20322
20323             </td> <!-- entry_type -->
20324
20325             <td class="entry_description">
20326               <p>List of the bounding rectangles for detected
20327 faces.<wbr/></p>
20328             </td>
20329
20330             <td class="entry_units">
20331             </td>
20332
20333             <td class="entry_range">
20334             </td>
20335
20336             <td class="entry_tags">
20337               <ul class="entry_tags">
20338                   <li><a href="#tag_BC">BC</a></li>
20339               </ul>
20340             </td>
20341
20342           </tr>
20343           <tr class="entries_header">
20344             <th class="th_details" colspan="5">Details</th>
20345           </tr>
20346           <tr class="entry_cont">
20347             <td class="entry_details" colspan="5">
20348               <p>The coordinate system is that of <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>,<wbr/> with
20349 <code>(0,<wbr/> 0)</code> being the top-left pixel of the active array.<wbr/></p>
20350 <p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> != OFF</p>
20351             </td>
20352           </tr>
20353
20354
20355           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20356            <!-- end of entry -->
20357
20358
20359           <tr class="entry" id="dynamic_android.statistics.faceScores">
20360             <td class="entry_name
20361              " rowspan="5">
20362               android.<wbr/>statistics.<wbr/>face<wbr/>Scores
20363             </td>
20364             <td class="entry_type">
20365                 <span class="entry_type_name">byte</span>
20366                 <span class="entry_type_container">x</span>
20367
20368                 <span class="entry_type_array">
20369                   n
20370                 </span>
20371               <span class="entry_type_visibility"> [hidden]</span>
20372
20373
20374               <span class="entry_type_hwlevel">[legacy] </span>
20375
20376
20377
20378
20379             </td> <!-- entry_type -->
20380
20381             <td class="entry_description">
20382               <p>List of the face confidence scores for
20383 detected faces</p>
20384             </td>
20385
20386             <td class="entry_units">
20387             </td>
20388
20389             <td class="entry_range">
20390               <p>1-100</p>
20391             </td>
20392
20393             <td class="entry_tags">
20394               <ul class="entry_tags">
20395                   <li><a href="#tag_BC">BC</a></li>
20396               </ul>
20397             </td>
20398
20399           </tr>
20400           <tr class="entries_header">
20401             <th class="th_details" colspan="5">Details</th>
20402           </tr>
20403           <tr class="entry_cont">
20404             <td class="entry_details" colspan="5">
20405               <p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> != OFF.<wbr/></p>
20406             </td>
20407           </tr>
20408
20409           <tr class="entries_header">
20410             <th class="th_details" colspan="5">HAL Implementation Details</th>
20411           </tr>
20412           <tr class="entry_cont">
20413             <td class="entry_details" colspan="5">
20414               <p>The value should be meaningful (for example,<wbr/> setting 100 at
20415 all times is illegal).<wbr/></p>
20416             </td>
20417           </tr>
20418
20419           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20420            <!-- end of entry -->
20421
20422
20423           <tr class="entry" id="dynamic_android.statistics.faces">
20424             <td class="entry_name
20425              " rowspan="3">
20426               android.<wbr/>statistics.<wbr/>faces
20427             </td>
20428             <td class="entry_type">
20429                 <span class="entry_type_name">int32</span>
20430                 <span class="entry_type_container">x</span>
20431
20432                 <span class="entry_type_array">
20433                   n
20434                 </span>
20435               <span class="entry_type_visibility"> [public as face]</span>
20436
20437               <span class="entry_type_synthetic">[synthetic] </span>
20438
20439               <span class="entry_type_hwlevel">[legacy] </span>
20440
20441
20442
20443
20444             </td> <!-- entry_type -->
20445
20446             <td class="entry_description">
20447               <p>List of the faces detected through camera face detection
20448 in this capture.<wbr/></p>
20449             </td>
20450
20451             <td class="entry_units">
20452             </td>
20453
20454             <td class="entry_range">
20455             </td>
20456
20457             <td class="entry_tags">
20458             </td>
20459
20460           </tr>
20461           <tr class="entries_header">
20462             <th class="th_details" colspan="5">Details</th>
20463           </tr>
20464           <tr class="entry_cont">
20465             <td class="entry_details" colspan="5">
20466               <p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> <code>!=</code> OFF.<wbr/></p>
20467             </td>
20468           </tr>
20469
20470
20471           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20472            <!-- end of entry -->
20473
20474
20475           <tr class="entry" id="dynamic_android.statistics.histogram">
20476             <td class="entry_name
20477              " rowspan="3">
20478               android.<wbr/>statistics.<wbr/>histogram
20479             </td>
20480             <td class="entry_type">
20481                 <span class="entry_type_name">int32</span>
20482                 <span class="entry_type_container">x</span>
20483
20484                 <span class="entry_type_array">
20485                   n x 3
20486                 </span>
20487               <span class="entry_type_visibility"> [system]</span>
20488
20489
20490
20491
20492                 <div class="entry_type_notes">count of pixels for each color channel that fall into each histogram bucket,<wbr/> scaled to be between 0 and maxHistogramCount</div>
20493
20494
20495             </td> <!-- entry_type -->
20496
20497             <td class="entry_description">
20498               <p>A 3-channel histogram based on the raw
20499 sensor data</p>
20500             </td>
20501
20502             <td class="entry_units">
20503             </td>
20504
20505             <td class="entry_range">
20506             </td>
20507
20508             <td class="entry_tags">
20509               <ul class="entry_tags">
20510                   <li><a href="#tag_FUTURE">FUTURE</a></li>
20511               </ul>
20512             </td>
20513
20514           </tr>
20515           <tr class="entries_header">
20516             <th class="th_details" colspan="5">Details</th>
20517           </tr>
20518           <tr class="entry_cont">
20519             <td class="entry_details" colspan="5">
20520               <p>The k'th bucket (0-based) covers the input range
20521 (with w = <a href="#static_android.sensor.info.whiteLevel">android.<wbr/>sensor.<wbr/>info.<wbr/>white<wbr/>Level</a>) of [ k * w/<wbr/>N,<wbr/>
20522 (k + 1) * w /<wbr/> N ).<wbr/> If only a monochrome sharpness map is
20523 supported,<wbr/> all channels should have the same data</p>
20524             </td>
20525           </tr>
20526
20527
20528           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20529            <!-- end of entry -->
20530
20531
20532           <tr class="entry" id="dynamic_android.statistics.histogramMode">
20533             <td class="entry_name
20534              " rowspan="1">
20535               android.<wbr/>statistics.<wbr/>histogram<wbr/>Mode
20536             </td>
20537             <td class="entry_type">
20538                 <span class="entry_type_name entry_type_name_enum">byte</span>
20539
20540               <span class="entry_type_visibility"> [system as boolean]</span>
20541
20542
20543
20544
20545
20546                 <ul class="entry_type_enum">
20547                   <li>
20548                     <span class="entry_type_enum_name">OFF</span>
20549                   </li>
20550                   <li>
20551                     <span class="entry_type_enum_name">ON</span>
20552                   </li>
20553                 </ul>
20554
20555             </td> <!-- entry_type -->
20556
20557             <td class="entry_description">
20558               <p>Operating mode for histogram
20559 generation</p>
20560             </td>
20561
20562             <td class="entry_units">
20563             </td>
20564
20565             <td class="entry_range">
20566             </td>
20567
20568             <td class="entry_tags">
20569               <ul class="entry_tags">
20570                   <li><a href="#tag_FUTURE">FUTURE</a></li>
20571               </ul>
20572             </td>
20573
20574           </tr>
20575
20576
20577           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20578            <!-- end of entry -->
20579
20580
20581           <tr class="entry" id="dynamic_android.statistics.sharpnessMap">
20582             <td class="entry_name
20583              " rowspan="3">
20584               android.<wbr/>statistics.<wbr/>sharpness<wbr/>Map
20585             </td>
20586             <td class="entry_type">
20587                 <span class="entry_type_name">int32</span>
20588                 <span class="entry_type_container">x</span>
20589
20590                 <span class="entry_type_array">
20591                   n x m x 3
20592                 </span>
20593               <span class="entry_type_visibility"> [system]</span>
20594
20595
20596
20597
20598                 <div class="entry_type_notes">estimated sharpness for each region of the input image.<wbr/> Normalized to be between 0 and maxSharpnessMapValue.<wbr/> Higher values mean sharper (better focused)</div>
20599
20600
20601             </td> <!-- entry_type -->
20602
20603             <td class="entry_description">
20604               <p>A 3-channel sharpness map,<wbr/> based on the raw
20605 sensor data</p>
20606             </td>
20607
20608             <td class="entry_units">
20609             </td>
20610
20611             <td class="entry_range">
20612             </td>
20613
20614             <td class="entry_tags">
20615               <ul class="entry_tags">
20616                   <li><a href="#tag_FUTURE">FUTURE</a></li>
20617               </ul>
20618             </td>
20619
20620           </tr>
20621           <tr class="entries_header">
20622             <th class="th_details" colspan="5">Details</th>
20623           </tr>
20624           <tr class="entry_cont">
20625             <td class="entry_details" colspan="5">
20626               <p>If only a monochrome sharpness map is supported,<wbr/>
20627 all channels should have the same data</p>
20628             </td>
20629           </tr>
20630
20631
20632           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20633            <!-- end of entry -->
20634
20635
20636           <tr class="entry" id="dynamic_android.statistics.sharpnessMapMode">
20637             <td class="entry_name
20638              " rowspan="1">
20639               android.<wbr/>statistics.<wbr/>sharpness<wbr/>Map<wbr/>Mode
20640             </td>
20641             <td class="entry_type">
20642                 <span class="entry_type_name entry_type_name_enum">byte</span>
20643
20644               <span class="entry_type_visibility"> [system as boolean]</span>
20645
20646
20647
20648
20649
20650                 <ul class="entry_type_enum">
20651                   <li>
20652                     <span class="entry_type_enum_name">OFF</span>
20653                   </li>
20654                   <li>
20655                     <span class="entry_type_enum_name">ON</span>
20656                   </li>
20657                 </ul>
20658
20659             </td> <!-- entry_type -->
20660
20661             <td class="entry_description">
20662               <p>Operating mode for sharpness map
20663 generation</p>
20664             </td>
20665
20666             <td class="entry_units">
20667             </td>
20668
20669             <td class="entry_range">
20670             </td>
20671
20672             <td class="entry_tags">
20673               <ul class="entry_tags">
20674                   <li><a href="#tag_FUTURE">FUTURE</a></li>
20675               </ul>
20676             </td>
20677
20678           </tr>
20679
20680
20681           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20682            <!-- end of entry -->
20683
20684
20685           <tr class="entry" id="dynamic_android.statistics.lensShadingCorrectionMap">
20686             <td class="entry_name
20687              " rowspan="3">
20688               android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Correction<wbr/>Map
20689             </td>
20690             <td class="entry_type">
20691                 <span class="entry_type_name">byte</span>
20692
20693               <span class="entry_type_visibility"> [public as lensShadingMap]</span>
20694
20695
20696               <span class="entry_type_hwlevel">[full] </span>
20697
20698
20699
20700
20701             </td> <!-- entry_type -->
20702
20703             <td class="entry_description">
20704               <p>The shading map is a low-resolution floating-point map
20705 that lists the coefficients used to correct for vignetting,<wbr/> for each
20706 Bayer color channel.<wbr/></p>
20707             </td>
20708
20709             <td class="entry_units">
20710             </td>
20711
20712             <td class="entry_range">
20713               <p>Each gain factor is &gt;= 1</p>
20714             </td>
20715
20716             <td class="entry_tags">
20717             </td>
20718
20719           </tr>
20720           <tr class="entries_header">
20721             <th class="th_details" colspan="5">Details</th>
20722           </tr>
20723           <tr class="entry_cont">
20724             <td class="entry_details" colspan="5">
20725               <p>The least shaded section of the image should have a gain factor
20726 of 1; all other sections should have gains above 1.<wbr/></p>
20727 <p>When <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> = TRANSFORM_<wbr/>MATRIX,<wbr/> the map
20728 must take into account the colorCorrection settings.<wbr/></p>
20729 <p>The shading map is for the entire active pixel array,<wbr/> and is not
20730 affected by the crop region specified in the request.<wbr/> Each shading map
20731 entry is the value of the shading compensation map over a specific
20732 pixel on the sensor.<wbr/>  Specifically,<wbr/> with a (N x M) resolution shading
20733 map,<wbr/> and an active pixel array size (W x H),<wbr/> shading map entry
20734 (x,<wbr/>y) ϵ (0 ...<wbr/> N-1,<wbr/> 0 ...<wbr/> M-1) is the value of the shading map at
20735 pixel ( ((W-1)/<wbr/>(N-1)) * x,<wbr/> ((H-1)/<wbr/>(M-1)) * y) for the four color channels.<wbr/>
20736 The map is assumed to be bilinearly interpolated between the sample points.<wbr/></p>
20737 <p>The channel order is [R,<wbr/> Geven,<wbr/> Godd,<wbr/> B],<wbr/> where Geven is the green
20738 channel for the even rows of a Bayer pattern,<wbr/> and Godd is the odd rows.<wbr/>
20739 The shading map is stored in a fully interleaved format.<wbr/></p>
20740 <p>The shading map should have on the order of 30-40 rows and columns,<wbr/>
20741 and must be smaller than 64x64.<wbr/></p>
20742 <p>As an example,<wbr/> given a very small map defined as:</p>
20743 <pre><code>width,<wbr/>height = [ 4,<wbr/> 3 ]
20744 values =
20745 [ 1.<wbr/>3,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>2,<wbr/>  1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>2,<wbr/>
20746     1.<wbr/>1,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/>  1.<wbr/>3,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>3,<wbr/> 1.<wbr/>3,<wbr/>
20747   1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>25,<wbr/> 1.<wbr/>1,<wbr/>  1.<wbr/>1,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>0,<wbr/>
20748     1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>2,<wbr/> 1.<wbr/>3,<wbr/> 1.<wbr/>25,<wbr/> 1.<wbr/>2,<wbr/>
20749   1.<wbr/>3,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>3,<wbr/>   1.<wbr/>2,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>2,<wbr/>
20750     1.<wbr/>2,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>2,<wbr/>  1.<wbr/>3,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>3 ]
20751 </code></pre>
20752 <p>The low-resolution scaling map images for each channel are
20753 (displayed using nearest-neighbor interpolation):</p>
20754 <p><img alt="Red lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png"/>
20755 <img alt="Green (even rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png"/>
20756 <img alt="Green (odd rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png"/>
20757 <img alt="Blue lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png"/></p>
20758 <p>As a visualization only,<wbr/> inverting the full-color map to recover an
20759 image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p>
20760 <p><img alt="Image of a uniform white wall (inverse shading map)" src="images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png"/></p>
20761             </td>
20762           </tr>
20763
20764
20765           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20766            <!-- end of entry -->
20767
20768
20769           <tr class="entry" id="dynamic_android.statistics.lensShadingMap">
20770             <td class="entry_name
20771              " rowspan="5">
20772               android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map
20773             </td>
20774             <td class="entry_type">
20775                 <span class="entry_type_name">float</span>
20776                 <span class="entry_type_container">x</span>
20777
20778                 <span class="entry_type_array">
20779                   4 x n x m
20780                 </span>
20781               <span class="entry_type_visibility"> [hidden]</span>
20782
20783
20784               <span class="entry_type_hwlevel">[full] </span>
20785
20786
20787                 <div class="entry_type_notes">2D array of float gain factors per channel to correct lens shading</div>
20788
20789
20790             </td> <!-- entry_type -->
20791
20792             <td class="entry_description">
20793               <p>The shading map is a low-resolution floating-point map
20794 that lists the coefficients used to correct for vignetting,<wbr/> for each
20795 Bayer color channel.<wbr/></p>
20796             </td>
20797
20798             <td class="entry_units">
20799             </td>
20800
20801             <td class="entry_range">
20802               <p>Each gain factor is &gt;= 1</p>
20803             </td>
20804
20805             <td class="entry_tags">
20806             </td>
20807
20808           </tr>
20809           <tr class="entries_header">
20810             <th class="th_details" colspan="5">Details</th>
20811           </tr>
20812           <tr class="entry_cont">
20813             <td class="entry_details" colspan="5">
20814               <p>The least shaded section of the image should have a gain factor
20815 of 1; all other sections should have gains above 1.<wbr/></p>
20816 <p>When <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> = TRANSFORM_<wbr/>MATRIX,<wbr/> the map
20817 must take into account the colorCorrection settings.<wbr/></p>
20818 <p>The shading map is for the entire active pixel array,<wbr/> and is not
20819 affected by the crop region specified in the request.<wbr/> Each shading map
20820 entry is the value of the shading compensation map over a specific
20821 pixel on the sensor.<wbr/>  Specifically,<wbr/> with a (N x M) resolution shading
20822 map,<wbr/> and an active pixel array size (W x H),<wbr/> shading map entry
20823 (x,<wbr/>y) ϵ (0 ...<wbr/> N-1,<wbr/> 0 ...<wbr/> M-1) is the value of the shading map at
20824 pixel ( ((W-1)/<wbr/>(N-1)) * x,<wbr/> ((H-1)/<wbr/>(M-1)) * y) for the four color channels.<wbr/>
20825 The map is assumed to be bilinearly interpolated between the sample points.<wbr/></p>
20826 <p>The channel order is [R,<wbr/> Geven,<wbr/> Godd,<wbr/> B],<wbr/> where Geven is the green
20827 channel for the even rows of a Bayer pattern,<wbr/> and Godd is the odd rows.<wbr/>
20828 The shading map is stored in a fully interleaved format,<wbr/> and its size
20829 is provided in the camera static metadata by <a href="#static_android.lens.info.shadingMapSize">android.<wbr/>lens.<wbr/>info.<wbr/>shading<wbr/>Map<wbr/>Size</a>.<wbr/></p>
20830 <p>The shading map should have on the order of 30-40 rows and columns,<wbr/>
20831 and must be smaller than 64x64.<wbr/></p>
20832 <p>As an example,<wbr/> given a very small map defined as:</p>
20833 <pre><code><a href="#static_android.lens.info.shadingMapSize">android.<wbr/>lens.<wbr/>info.<wbr/>shading<wbr/>Map<wbr/>Size</a> = [ 4,<wbr/> 3 ]
20834 <a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a> =
20835 [ 1.<wbr/>3,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>2,<wbr/>  1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>2,<wbr/>
20836     1.<wbr/>1,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/>  1.<wbr/>3,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>3,<wbr/> 1.<wbr/>3,<wbr/>
20837   1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>25,<wbr/> 1.<wbr/>1,<wbr/>  1.<wbr/>1,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>0,<wbr/>
20838     1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>2,<wbr/> 1.<wbr/>3,<wbr/> 1.<wbr/>25,<wbr/> 1.<wbr/>2,<wbr/>
20839   1.<wbr/>3,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>3,<wbr/>   1.<wbr/>2,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>2,<wbr/>
20840     1.<wbr/>2,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>2,<wbr/>  1.<wbr/>3,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>3 ]
20841 </code></pre>
20842 <p>The low-resolution scaling map images for each channel are
20843 (displayed using nearest-neighbor interpolation):</p>
20844 <p><img alt="Red lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png"/>
20845 <img alt="Green (even rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png"/>
20846 <img alt="Green (odd rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png"/>
20847 <img alt="Blue lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png"/></p>
20848 <p>As a visualization only,<wbr/> inverting the full-color map to recover an
20849 image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p>
20850 <p><img alt="Image of a uniform white wall (inverse shading map)" src="images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png"/></p>
20851             </td>
20852           </tr>
20853
20854           <tr class="entries_header">
20855             <th class="th_details" colspan="5">HAL Implementation Details</th>
20856           </tr>
20857           <tr class="entry_cont">
20858             <td class="entry_details" colspan="5">
20859               <p>The lens shading map calculation may depend on exposure and white balance statistics.<wbr/>
20860 When AE and AWB are in AUTO modes
20861 (<a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>!=</code> OFF and <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> <code>!=</code> OFF),<wbr/> the HAL
20862 may have all the information it need to generate most accurate lens shading map.<wbr/> When
20863 AE or AWB are in manual mode
20864 (<a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>==</code> OFF or <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> <code>==</code> OFF),<wbr/> the shading map
20865 may be adversely impacted by manual exposure or white balance parameters.<wbr/> To avoid
20866 generating unreliable shading map data,<wbr/> the HAL may choose to lock the shading map with
20867 the latest known good map generated when the AE and AWB are in AUTO modes.<wbr/></p>
20868             </td>
20869           </tr>
20870
20871           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20872            <!-- end of entry -->
20873
20874
20875           <tr class="entry" id="dynamic_android.statistics.predictedColorGains">
20876             <td class="entry_name
20877                 entry_name_deprecated
20878              " rowspan="3">
20879               android.<wbr/>statistics.<wbr/>predicted<wbr/>Color<wbr/>Gains
20880             </td>
20881             <td class="entry_type">
20882                 <span class="entry_type_name">float</span>
20883                 <span class="entry_type_container">x</span>
20884
20885                 <span class="entry_type_array">
20886                   4
20887                 </span>
20888               <span class="entry_type_visibility"> [hidden]</span>
20889
20890
20891
20892               <span class="entry_type_deprecated">[deprecated] </span>
20893
20894                 <div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>
20895
20896
20897             </td> <!-- entry_type -->
20898
20899             <td class="entry_description">
20900               <p>The best-fit color channel gains calculated
20901 by the camera device's statistics units for the current output frame.<wbr/></p>
20902             </td>
20903
20904             <td class="entry_units">
20905             </td>
20906
20907             <td class="entry_range">
20908               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
20909             </td>
20910
20911             <td class="entry_tags">
20912             </td>
20913
20914           </tr>
20915           <tr class="entries_header">
20916             <th class="th_details" colspan="5">Details</th>
20917           </tr>
20918           <tr class="entry_cont">
20919             <td class="entry_details" colspan="5">
20920               <p>This may be different than the gains used for this frame,<wbr/>
20921 since statistics processing on data from a new frame
20922 typically completes after the transform has already been
20923 applied to that frame.<wbr/></p>
20924 <p>The 4 channel gains are defined in Bayer domain,<wbr/>
20925 see <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> for details.<wbr/></p>
20926 <p>This value should always be calculated by the auto-white balance (AWB) block,<wbr/>
20927 regardless of the android.<wbr/>control.<wbr/>* current values.<wbr/></p>
20928             </td>
20929           </tr>
20930
20931
20932           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20933            <!-- end of entry -->
20934
20935
20936           <tr class="entry" id="dynamic_android.statistics.predictedColorTransform">
20937             <td class="entry_name
20938                 entry_name_deprecated
20939              " rowspan="3">
20940               android.<wbr/>statistics.<wbr/>predicted<wbr/>Color<wbr/>Transform
20941             </td>
20942             <td class="entry_type">
20943                 <span class="entry_type_name">rational</span>
20944                 <span class="entry_type_container">x</span>
20945
20946                 <span class="entry_type_array">
20947                   3 x 3
20948                 </span>
20949               <span class="entry_type_visibility"> [hidden]</span>
20950
20951
20952
20953               <span class="entry_type_deprecated">[deprecated] </span>
20954
20955                 <div class="entry_type_notes">3x3 rational matrix in row-major order</div>
20956
20957
20958             </td> <!-- entry_type -->
20959
20960             <td class="entry_description">
20961               <p>The best-fit color transform matrix estimate
20962 calculated by the camera device's statistics units for the current
20963 output frame.<wbr/></p>
20964             </td>
20965
20966             <td class="entry_units">
20967             </td>
20968
20969             <td class="entry_range">
20970               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
20971             </td>
20972
20973             <td class="entry_tags">
20974             </td>
20975
20976           </tr>
20977           <tr class="entries_header">
20978             <th class="th_details" colspan="5">Details</th>
20979           </tr>
20980           <tr class="entry_cont">
20981             <td class="entry_details" colspan="5">
20982               <p>The camera device will provide the estimate from its
20983 statistics unit on the white balance transforms to use
20984 for the next frame.<wbr/> These are the values the camera device believes
20985 are the best fit for the current output frame.<wbr/> This may
20986 be different than the transform used for this frame,<wbr/> since
20987 statistics processing on data from a new frame typically
20988 completes after the transform has already been applied to
20989 that frame.<wbr/></p>
20990 <p>These estimates must be provided for all frames,<wbr/> even if
20991 capture settings and color transforms are set by the application.<wbr/></p>
20992 <p>This value should always be calculated by the auto-white balance (AWB) block,<wbr/>
20993 regardless of the android.<wbr/>control.<wbr/>* current values.<wbr/></p>
20994             </td>
20995           </tr>
20996
20997
20998           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20999            <!-- end of entry -->
21000
21001
21002           <tr class="entry" id="dynamic_android.statistics.sceneFlicker">
21003             <td class="entry_name
21004              " rowspan="3">
21005               android.<wbr/>statistics.<wbr/>scene<wbr/>Flicker
21006             </td>
21007             <td class="entry_type">
21008                 <span class="entry_type_name entry_type_name_enum">byte</span>
21009
21010               <span class="entry_type_visibility"> [public]</span>
21011
21012
21013               <span class="entry_type_hwlevel">[full] </span>
21014
21015
21016
21017                 <ul class="entry_type_enum">
21018                   <li>
21019                     <span class="entry_type_enum_name">NONE</span>
21020                     <span class="entry_type_enum_notes"><p>The camera device does not detect any flickering illumination
21021 in the current scene.<wbr/></p></span>
21022                   </li>
21023                   <li>
21024                     <span class="entry_type_enum_name">50HZ</span>
21025                     <span class="entry_type_enum_notes"><p>The camera device detects illumination flickering at 50Hz
21026 in the current scene.<wbr/></p></span>
21027                   </li>
21028                   <li>
21029                     <span class="entry_type_enum_name">60HZ</span>
21030                     <span class="entry_type_enum_notes"><p>The camera device detects illumination flickering at 60Hz
21031 in the current scene.<wbr/></p></span>
21032                   </li>
21033                 </ul>
21034
21035             </td> <!-- entry_type -->
21036
21037             <td class="entry_description">
21038               <p>The camera device estimated scene illumination lighting
21039 frequency.<wbr/></p>
21040             </td>
21041
21042             <td class="entry_units">
21043             </td>
21044
21045             <td class="entry_range">
21046             </td>
21047
21048             <td class="entry_tags">
21049             </td>
21050
21051           </tr>
21052           <tr class="entries_header">
21053             <th class="th_details" colspan="5">Details</th>
21054           </tr>
21055           <tr class="entry_cont">
21056             <td class="entry_details" colspan="5">
21057               <p>Many light sources,<wbr/> such as most fluorescent lights,<wbr/> flicker at a rate
21058 that depends on the local utility power standards.<wbr/> This flicker must be
21059 accounted for by auto-exposure routines to avoid artifacts in captured images.<wbr/>
21060 The camera device uses this entry to tell the application what the scene
21061 illuminant frequency is.<wbr/></p>
21062 <p>When manual exposure control is enabled
21063 (<code><a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> == OFF</code> or <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> ==
21064 OFF</code>),<wbr/> the <a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a> doesn't perform
21065 antibanding,<wbr/> and the application can ensure it selects
21066 exposure times that do not cause banding issues by looking
21067 into this metadata field.<wbr/> See
21068 <a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a> for more details.<wbr/></p>
21069 <p>Reports NONE if there doesn't appear to be flickering illumination.<wbr/></p>
21070             </td>
21071           </tr>
21072
21073
21074           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21075            <!-- end of entry -->
21076
21077
21078           <tr class="entry" id="dynamic_android.statistics.hotPixelMapMode">
21079             <td class="entry_name
21080              " rowspan="3">
21081               android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map<wbr/>Mode
21082             </td>
21083             <td class="entry_type">
21084                 <span class="entry_type_name entry_type_name_enum">byte</span>
21085
21086               <span class="entry_type_visibility"> [public as boolean]</span>
21087
21088
21089
21090
21091
21092                 <ul class="entry_type_enum">
21093                   <li>
21094                     <span class="entry_type_enum_name">OFF</span>
21095                     <span class="entry_type_enum_notes"><p>Hot pixel map production is disabled.<wbr/></p></span>
21096                   </li>
21097                   <li>
21098                     <span class="entry_type_enum_name">ON</span>
21099                     <span class="entry_type_enum_notes"><p>Hot pixel map production is enabled.<wbr/></p></span>
21100                   </li>
21101                 </ul>
21102
21103             </td> <!-- entry_type -->
21104
21105             <td class="entry_description">
21106               <p>Operating mode for hot pixel map generation.<wbr/></p>
21107             </td>
21108
21109             <td class="entry_units">
21110             </td>
21111
21112             <td class="entry_range">
21113               <p><a href="#static_android.statistics.info.availableHotPixelMapModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Map<wbr/>Modes</a></p>
21114             </td>
21115
21116             <td class="entry_tags">
21117               <ul class="entry_tags">
21118                   <li><a href="#tag_V1">V1</a></li>
21119                   <li><a href="#tag_RAW">RAW</a></li>
21120               </ul>
21121             </td>
21122
21123           </tr>
21124           <tr class="entries_header">
21125             <th class="th_details" colspan="5">Details</th>
21126           </tr>
21127           <tr class="entry_cont">
21128             <td class="entry_details" colspan="5">
21129               <p>If set to <code>true</code>,<wbr/> a hot pixel map is returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/>
21130 If set to <code>false</code>,<wbr/> no hot pixel map will be returned.<wbr/></p>
21131             </td>
21132           </tr>
21133
21134
21135           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21136            <!-- end of entry -->
21137
21138
21139           <tr class="entry" id="dynamic_android.statistics.hotPixelMap">
21140             <td class="entry_name
21141              " rowspan="5">
21142               android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map
21143             </td>
21144             <td class="entry_type">
21145                 <span class="entry_type_name">int32</span>
21146                 <span class="entry_type_container">x</span>
21147
21148                 <span class="entry_type_array">
21149                   2 x n
21150                 </span>
21151               <span class="entry_type_visibility"> [public as point]</span>
21152
21153
21154
21155
21156                 <div class="entry_type_notes">list of coordinates based on android.<wbr/>sensor.<wbr/>pixel<wbr/>Array<wbr/>Size</div>
21157
21158
21159             </td> <!-- entry_type -->
21160
21161             <td class="entry_description">
21162               <p>List of <code>(x,<wbr/> y)</code> coordinates of hot/<wbr/>defective pixels on the sensor.<wbr/></p>
21163             </td>
21164
21165             <td class="entry_units">
21166             </td>
21167
21168             <td class="entry_range">
21169               <p>n &lt;= number of pixels on the sensor.<wbr/>
21170 The <code>(x,<wbr/> y)</code> coordinates must be bounded by
21171 <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/></p>
21172             </td>
21173
21174             <td class="entry_tags">
21175               <ul class="entry_tags">
21176                   <li><a href="#tag_V1">V1</a></li>
21177                   <li><a href="#tag_RAW">RAW</a></li>
21178               </ul>
21179             </td>
21180
21181           </tr>
21182           <tr class="entries_header">
21183             <th class="th_details" colspan="5">Details</th>
21184           </tr>
21185           <tr class="entry_cont">
21186             <td class="entry_details" colspan="5">
21187               <p>A coordinate <code>(x,<wbr/> y)</code> must lie between <code>(0,<wbr/> 0)</code>,<wbr/> and
21188 <code>(width - 1,<wbr/> height - 1)</code> (inclusive),<wbr/> which are the top-left and
21189 bottom-right of the pixel array,<wbr/> respectively.<wbr/> The width and
21190 height dimensions are given in <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/>
21191 This may include hot pixels that lie outside of the active array
21192 bounds given by <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></p>
21193             </td>
21194           </tr>
21195
21196           <tr class="entries_header">
21197             <th class="th_details" colspan="5">HAL Implementation Details</th>
21198           </tr>
21199           <tr class="entry_cont">
21200             <td class="entry_details" colspan="5">
21201               <p>A hotpixel map contains the coordinates of pixels on the camera
21202 sensor that do report valid values (usually due to defects in
21203 the camera sensor).<wbr/> This includes pixels that are stuck at certain
21204 values,<wbr/> or have a response that does not accuractly encode the
21205 incoming light from the scene.<wbr/></p>
21206 <p>To avoid performance issues,<wbr/> there should be significantly fewer hot
21207 pixels than actual pixels on the camera sensor.<wbr/></p>
21208             </td>
21209           </tr>
21210
21211           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21212            <!-- end of entry -->
21213
21214
21215           <tr class="entry" id="dynamic_android.statistics.lensShadingMapMode">
21216             <td class="entry_name
21217              " rowspan="3">
21218               android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode
21219             </td>
21220             <td class="entry_type">
21221                 <span class="entry_type_name entry_type_name_enum">byte</span>
21222
21223               <span class="entry_type_visibility"> [public]</span>
21224
21225
21226               <span class="entry_type_hwlevel">[full] </span>
21227
21228
21229
21230                 <ul class="entry_type_enum">
21231                   <li>
21232                     <span class="entry_type_enum_name">OFF</span>
21233                     <span class="entry_type_enum_notes"><p>Do not include a lens shading map in the capture result.<wbr/></p></span>
21234                   </li>
21235                   <li>
21236                     <span class="entry_type_enum_name">ON</span>
21237                     <span class="entry_type_enum_notes"><p>Include a lens shading map in the capture result.<wbr/></p></span>
21238                   </li>
21239                 </ul>
21240
21241             </td> <!-- entry_type -->
21242
21243             <td class="entry_description">
21244               <p>Whether the camera device will output the lens
21245 shading map in output result metadata.<wbr/></p>
21246             </td>
21247
21248             <td class="entry_units">
21249             </td>
21250
21251             <td class="entry_range">
21252             </td>
21253
21254             <td class="entry_tags">
21255               <ul class="entry_tags">
21256                   <li><a href="#tag_RAW">RAW</a></li>
21257               </ul>
21258             </td>
21259
21260           </tr>
21261           <tr class="entries_header">
21262             <th class="th_details" colspan="5">Details</th>
21263           </tr>
21264           <tr class="entry_cont">
21265             <td class="entry_details" colspan="5">
21266               <p>When set to ON,<wbr/>
21267 <a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a> will be provided in
21268 the output result metadata.<wbr/></p>
21269 <p>ON is always supported on devices with the RAW capability.<wbr/></p>
21270             </td>
21271           </tr>
21272
21273
21274           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21275            <!-- end of entry -->
21276
21277
21278
21279       <!-- end of kind -->
21280       </tbody>
21281
21282   <!-- end of section -->
21283   <tr><td colspan="6" id="section_tonemap" class="section">tonemap</td></tr>
21284
21285
21286       <tr><td colspan="6" class="kind">controls</td></tr>
21287
21288       <thead class="entries_header">
21289         <tr>
21290           <th class="th_name">Property Name</th>
21291           <th class="th_type">Type</th>
21292           <th class="th_description">Description</th>
21293           <th class="th_units">Units</th>
21294           <th class="th_range">Range</th>
21295           <th class="th_tags">Tags</th>
21296         </tr>
21297       </thead>
21298
21299       <tbody>
21300
21301
21302
21303
21304
21305
21306
21307
21308
21309
21310           <tr class="entry" id="controls_android.tonemap.curveBlue">
21311             <td class="entry_name
21312              " rowspan="3">
21313               android.<wbr/>tonemap.<wbr/>curve<wbr/>Blue
21314             </td>
21315             <td class="entry_type">
21316                 <span class="entry_type_name">float</span>
21317                 <span class="entry_type_container">x</span>
21318
21319                 <span class="entry_type_array">
21320                   n x 2
21321                 </span>
21322               <span class="entry_type_visibility"> [hidden]</span>
21323
21324
21325               <span class="entry_type_hwlevel">[full] </span>
21326
21327
21328                 <div class="entry_type_notes">1D array of float pairs (P_<wbr/>IN,<wbr/> P_<wbr/>OUT).<wbr/> The maximum number of pairs is specified by android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points.<wbr/></div>
21329
21330
21331             </td> <!-- entry_type -->
21332
21333             <td class="entry_description">
21334               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the blue
21335 channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
21336 CONTRAST_<wbr/>CURVE.<wbr/></p>
21337             </td>
21338
21339             <td class="entry_units">
21340             </td>
21341
21342             <td class="entry_range">
21343             </td>
21344
21345             <td class="entry_tags">
21346             </td>
21347
21348           </tr>
21349           <tr class="entries_header">
21350             <th class="th_details" colspan="5">Details</th>
21351           </tr>
21352           <tr class="entry_cont">
21353             <td class="entry_details" colspan="5">
21354               <p>See <a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> for more details.<wbr/></p>
21355             </td>
21356           </tr>
21357
21358
21359           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21360            <!-- end of entry -->
21361
21362
21363           <tr class="entry" id="controls_android.tonemap.curveGreen">
21364             <td class="entry_name
21365              " rowspan="3">
21366               android.<wbr/>tonemap.<wbr/>curve<wbr/>Green
21367             </td>
21368             <td class="entry_type">
21369                 <span class="entry_type_name">float</span>
21370                 <span class="entry_type_container">x</span>
21371
21372                 <span class="entry_type_array">
21373                   n x 2
21374                 </span>
21375               <span class="entry_type_visibility"> [hidden]</span>
21376
21377
21378               <span class="entry_type_hwlevel">[full] </span>
21379
21380
21381                 <div class="entry_type_notes">1D array of float pairs (P_<wbr/>IN,<wbr/> P_<wbr/>OUT).<wbr/> The maximum number of pairs is specified by android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points.<wbr/></div>
21382
21383
21384             </td> <!-- entry_type -->
21385
21386             <td class="entry_description">
21387               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the green
21388 channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
21389 CONTRAST_<wbr/>CURVE.<wbr/></p>
21390             </td>
21391
21392             <td class="entry_units">
21393             </td>
21394
21395             <td class="entry_range">
21396             </td>
21397
21398             <td class="entry_tags">
21399             </td>
21400
21401           </tr>
21402           <tr class="entries_header">
21403             <th class="th_details" colspan="5">Details</th>
21404           </tr>
21405           <tr class="entry_cont">
21406             <td class="entry_details" colspan="5">
21407               <p>See <a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> for more details.<wbr/></p>
21408             </td>
21409           </tr>
21410
21411
21412           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21413            <!-- end of entry -->
21414
21415
21416           <tr class="entry" id="controls_android.tonemap.curveRed">
21417             <td class="entry_name
21418              " rowspan="5">
21419               android.<wbr/>tonemap.<wbr/>curve<wbr/>Red
21420             </td>
21421             <td class="entry_type">
21422                 <span class="entry_type_name">float</span>
21423                 <span class="entry_type_container">x</span>
21424
21425                 <span class="entry_type_array">
21426                   n x 2
21427                 </span>
21428               <span class="entry_type_visibility"> [hidden]</span>
21429
21430
21431               <span class="entry_type_hwlevel">[full] </span>
21432
21433
21434                 <div class="entry_type_notes">1D array of float pairs (P_<wbr/>IN,<wbr/> P_<wbr/>OUT).<wbr/> The maximum number of pairs is specified by android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points.<wbr/></div>
21435
21436
21437             </td> <!-- entry_type -->
21438
21439             <td class="entry_description">
21440               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the red
21441 channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
21442 CONTRAST_<wbr/>CURVE.<wbr/></p>
21443             </td>
21444
21445             <td class="entry_units">
21446             </td>
21447
21448             <td class="entry_range">
21449               <p>0-1 on both input and output coordinates,<wbr/> normalized
21450 as a floating-point value such that 0 == black and 1 == white.<wbr/></p>
21451             </td>
21452
21453             <td class="entry_tags">
21454             </td>
21455
21456           </tr>
21457           <tr class="entries_header">
21458             <th class="th_details" colspan="5">Details</th>
21459           </tr>
21460           <tr class="entry_cont">
21461             <td class="entry_details" colspan="5">
21462               <p>Each channel's curve is defined by an array of control points:</p>
21463 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> =
21464   [ P0in,<wbr/> P0out,<wbr/> P1in,<wbr/> P1out,<wbr/> P2in,<wbr/> P2out,<wbr/> P3in,<wbr/> P3out,<wbr/> ...,<wbr/> PNin,<wbr/> PNout ]
21465 2 &lt;= N &lt;= <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></code></pre>
21466 <p>These are sorted in order of increasing <code>Pin</code>; it is
21467 required that input values 0.<wbr/>0 and 1.<wbr/>0 are included in the list to
21468 define a complete mapping.<wbr/> For input values between control points,<wbr/>
21469 the camera device must linearly interpolate between the control
21470 points.<wbr/></p>
21471 <p>Each curve can have an independent number of points,<wbr/> and the number
21472 of points can be less than max (that is,<wbr/> the request doesn't have to
21473 always provide a curve with number of points equivalent to
21474 <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a>).<wbr/></p>
21475 <p>A few examples,<wbr/> and their corresponding graphical mappings; these
21476 only specify the red channel and the precision is limited to 4
21477 digits,<wbr/> for conciseness.<wbr/></p>
21478 <p>Linear mapping:</p>
21479 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [ 0,<wbr/> 0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0 ]
21480 </code></pre>
21481 <p><img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/></p>
21482 <p>Invert mapping:</p>
21483 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [ 0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 0 ]
21484 </code></pre>
21485 <p><img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/></p>
21486 <p>Gamma 1/<wbr/>2.<wbr/>2 mapping,<wbr/> with 16 control points:</p>
21487 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [
21488   0.<wbr/>0000,<wbr/> 0.<wbr/>0000,<wbr/> 0.<wbr/>0667,<wbr/> 0.<wbr/>2920,<wbr/> 0.<wbr/>1333,<wbr/> 0.<wbr/>4002,<wbr/> 0.<wbr/>2000,<wbr/> 0.<wbr/>4812,<wbr/>
21489   0.<wbr/>2667,<wbr/> 0.<wbr/>5484,<wbr/> 0.<wbr/>3333,<wbr/> 0.<wbr/>6069,<wbr/> 0.<wbr/>4000,<wbr/> 0.<wbr/>6594,<wbr/> 0.<wbr/>4667,<wbr/> 0.<wbr/>7072,<wbr/>
21490   0.<wbr/>5333,<wbr/> 0.<wbr/>7515,<wbr/> 0.<wbr/>6000,<wbr/> 0.<wbr/>7928,<wbr/> 0.<wbr/>6667,<wbr/> 0.<wbr/>8317,<wbr/> 0.<wbr/>7333,<wbr/> 0.<wbr/>8685,<wbr/>
21491   0.<wbr/>8000,<wbr/> 0.<wbr/>9035,<wbr/> 0.<wbr/>8667,<wbr/> 0.<wbr/>9370,<wbr/> 0.<wbr/>9333,<wbr/> 0.<wbr/>9691,<wbr/> 1.<wbr/>0000,<wbr/> 1.<wbr/>0000 ]
21492 </code></pre>
21493 <p><img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/></p>
21494 <p>Standard sRGB gamma mapping,<wbr/> per IEC 61966-2-1:1999,<wbr/> with 16 control points:</p>
21495 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [
21496   0.<wbr/>0000,<wbr/> 0.<wbr/>0000,<wbr/> 0.<wbr/>0667,<wbr/> 0.<wbr/>2864,<wbr/> 0.<wbr/>1333,<wbr/> 0.<wbr/>4007,<wbr/> 0.<wbr/>2000,<wbr/> 0.<wbr/>4845,<wbr/>
21497   0.<wbr/>2667,<wbr/> 0.<wbr/>5532,<wbr/> 0.<wbr/>3333,<wbr/> 0.<wbr/>6125,<wbr/> 0.<wbr/>4000,<wbr/> 0.<wbr/>6652,<wbr/> 0.<wbr/>4667,<wbr/> 0.<wbr/>7130,<wbr/>
21498   0.<wbr/>5333,<wbr/> 0.<wbr/>7569,<wbr/> 0.<wbr/>6000,<wbr/> 0.<wbr/>7977,<wbr/> 0.<wbr/>6667,<wbr/> 0.<wbr/>8360,<wbr/> 0.<wbr/>7333,<wbr/> 0.<wbr/>8721,<wbr/>
21499   0.<wbr/>8000,<wbr/> 0.<wbr/>9063,<wbr/> 0.<wbr/>8667,<wbr/> 0.<wbr/>9389,<wbr/> 0.<wbr/>9333,<wbr/> 0.<wbr/>9701,<wbr/> 1.<wbr/>0000,<wbr/> 1.<wbr/>0000 ]
21500 </code></pre>
21501 <p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
21502             </td>
21503           </tr>
21504
21505           <tr class="entries_header">
21506             <th class="th_details" colspan="5">HAL Implementation Details</th>
21507           </tr>
21508           <tr class="entry_cont">
21509             <td class="entry_details" colspan="5">
21510               <p>For good quality of mapping,<wbr/> at least 128 control points are
21511 preferred.<wbr/></p>
21512 <p>A typical use case of this would be a gamma-1/<wbr/>2.<wbr/>2 curve,<wbr/> with as many
21513 control points used as are available.<wbr/></p>
21514             </td>
21515           </tr>
21516
21517           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21518            <!-- end of entry -->
21519
21520
21521           <tr class="entry" id="controls_android.tonemap.curve">
21522             <td class="entry_name
21523              " rowspan="5">
21524               android.<wbr/>tonemap.<wbr/>curve
21525             </td>
21526             <td class="entry_type">
21527                 <span class="entry_type_name">float</span>
21528
21529               <span class="entry_type_visibility"> [public as tonemapCurve]</span>
21530
21531               <span class="entry_type_synthetic">[synthetic] </span>
21532
21533               <span class="entry_type_hwlevel">[full] </span>
21534
21535
21536
21537
21538             </td> <!-- entry_type -->
21539
21540             <td class="entry_description">
21541               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a>
21542 is CONTRAST_<wbr/>CURVE.<wbr/></p>
21543             </td>
21544
21545             <td class="entry_units">
21546             </td>
21547
21548             <td class="entry_range">
21549             </td>
21550
21551             <td class="entry_tags">
21552             </td>
21553
21554           </tr>
21555           <tr class="entries_header">
21556             <th class="th_details" colspan="5">Details</th>
21557           </tr>
21558           <tr class="entry_cont">
21559             <td class="entry_details" colspan="5">
21560               <p>The tonemapCurve consist of three curves for each of red,<wbr/> green,<wbr/> and blue
21561 channels respectively.<wbr/> The following example uses the red channel as an
21562 example.<wbr/> The same logic applies to green and blue channel.<wbr/>
21563 Each channel's curve is defined by an array of control points:</p>
21564 <pre><code>curveRed =
21565   [ P0(in,<wbr/> out),<wbr/> P1(in,<wbr/> out),<wbr/> P2(in,<wbr/> out),<wbr/> P3(in,<wbr/> out),<wbr/> ...,<wbr/> PN(in,<wbr/> out) ]
21566 2 &lt;= N &lt;= <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></code></pre>
21567 <p>These are sorted in order of increasing <code>Pin</code>; it is always
21568 guaranteed that input values 0.<wbr/>0 and 1.<wbr/>0 are included in the list to
21569 define a complete mapping.<wbr/> For input values between control points,<wbr/>
21570 the camera device must linearly interpolate between the control
21571 points.<wbr/></p>
21572 <p>Each curve can have an independent number of points,<wbr/> and the number
21573 of points can be less than max (that is,<wbr/> the request doesn't have to
21574 always provide a curve with number of points equivalent to
21575 <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a>).<wbr/></p>
21576 <p>A few examples,<wbr/> and their corresponding graphical mappings; these
21577 only specify the red channel and the precision is limited to 4
21578 digits,<wbr/> for conciseness.<wbr/></p>
21579 <p>Linear mapping:</p>
21580 <pre><code>curveRed = [ (0,<wbr/> 0),<wbr/> (1.<wbr/>0,<wbr/> 1.<wbr/>0) ]
21581 </code></pre>
21582 <p><img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/></p>
21583 <p>Invert mapping:</p>
21584 <pre><code>curveRed = [ (0,<wbr/> 1.<wbr/>0),<wbr/> (1.<wbr/>0,<wbr/> 0) ]
21585 </code></pre>
21586 <p><img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/></p>
21587 <p>Gamma 1/<wbr/>2.<wbr/>2 mapping,<wbr/> with 16 control points:</p>
21588 <pre><code>curveRed = [
21589   (0.<wbr/>0000,<wbr/> 0.<wbr/>0000),<wbr/> (0.<wbr/>0667,<wbr/> 0.<wbr/>2920),<wbr/> (0.<wbr/>1333,<wbr/> 0.<wbr/>4002),<wbr/> (0.<wbr/>2000,<wbr/> 0.<wbr/>4812),<wbr/>
21590   (0.<wbr/>2667,<wbr/> 0.<wbr/>5484),<wbr/> (0.<wbr/>3333,<wbr/> 0.<wbr/>6069),<wbr/> (0.<wbr/>4000,<wbr/> 0.<wbr/>6594),<wbr/> (0.<wbr/>4667,<wbr/> 0.<wbr/>7072),<wbr/>
21591   (0.<wbr/>5333,<wbr/> 0.<wbr/>7515),<wbr/> (0.<wbr/>6000,<wbr/> 0.<wbr/>7928),<wbr/> (0.<wbr/>6667,<wbr/> 0.<wbr/>8317),<wbr/> (0.<wbr/>7333,<wbr/> 0.<wbr/>8685),<wbr/>
21592   (0.<wbr/>8000,<wbr/> 0.<wbr/>9035),<wbr/> (0.<wbr/>8667,<wbr/> 0.<wbr/>9370),<wbr/> (0.<wbr/>9333,<wbr/> 0.<wbr/>9691),<wbr/> (1.<wbr/>0000,<wbr/> 1.<wbr/>0000) ]
21593 </code></pre>
21594 <p><img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/></p>
21595 <p>Standard sRGB gamma mapping,<wbr/> per IEC 61966-2-1:1999,<wbr/> with 16 control points:</p>
21596 <pre><code>curveRed = [
21597   (0.<wbr/>0000,<wbr/> 0.<wbr/>0000),<wbr/> (0.<wbr/>0667,<wbr/> 0.<wbr/>2864),<wbr/> (0.<wbr/>1333,<wbr/> 0.<wbr/>4007),<wbr/> (0.<wbr/>2000,<wbr/> 0.<wbr/>4845),<wbr/>
21598   (0.<wbr/>2667,<wbr/> 0.<wbr/>5532),<wbr/> (0.<wbr/>3333,<wbr/> 0.<wbr/>6125),<wbr/> (0.<wbr/>4000,<wbr/> 0.<wbr/>6652),<wbr/> (0.<wbr/>4667,<wbr/> 0.<wbr/>7130),<wbr/>
21599   (0.<wbr/>5333,<wbr/> 0.<wbr/>7569),<wbr/> (0.<wbr/>6000,<wbr/> 0.<wbr/>7977),<wbr/> (0.<wbr/>6667,<wbr/> 0.<wbr/>8360),<wbr/> (0.<wbr/>7333,<wbr/> 0.<wbr/>8721),<wbr/>
21600   (0.<wbr/>8000,<wbr/> 0.<wbr/>9063),<wbr/> (0.<wbr/>8667,<wbr/> 0.<wbr/>9389),<wbr/> (0.<wbr/>9333,<wbr/> 0.<wbr/>9701),<wbr/> (1.<wbr/>0000,<wbr/> 1.<wbr/>0000) ]
21601 </code></pre>
21602 <p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
21603             </td>
21604           </tr>
21605
21606           <tr class="entries_header">
21607             <th class="th_details" colspan="5">HAL Implementation Details</th>
21608           </tr>
21609           <tr class="entry_cont">
21610             <td class="entry_details" colspan="5">
21611               <p>This entry is created by the framework from the curveRed,<wbr/> curveGreen and
21612 curveBlue entries.<wbr/></p>
21613             </td>
21614           </tr>
21615
21616           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21617            <!-- end of entry -->
21618
21619
21620           <tr class="entry" id="controls_android.tonemap.mode">
21621             <td class="entry_name
21622              " rowspan="3">
21623               android.<wbr/>tonemap.<wbr/>mode
21624             </td>
21625             <td class="entry_type">
21626                 <span class="entry_type_name entry_type_name_enum">byte</span>
21627
21628               <span class="entry_type_visibility"> [public]</span>
21629
21630
21631               <span class="entry_type_hwlevel">[full] </span>
21632
21633
21634
21635                 <ul class="entry_type_enum">
21636                   <li>
21637                     <span class="entry_type_enum_name">CONTRAST_CURVE</span>
21638                     <span class="entry_type_enum_notes"><p>Use the tone mapping curve specified in
21639 the <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>* entries.<wbr/></p>
21640 <p>All color enhancement and tonemapping must be disabled,<wbr/> except
21641 for applying the tonemapping curve specified by
21642 <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/></p>
21643 <p>Must not slow down frame rate relative to raw
21644 sensor output.<wbr/></p></span>
21645                   </li>
21646                   <li>
21647                     <span class="entry_type_enum_name">FAST</span>
21648                     <span class="entry_type_enum_notes"><p>Advanced gamma mapping and color enhancement may be applied,<wbr/> without
21649 reducing frame rate compared to raw sensor output.<wbr/></p></span>
21650                   </li>
21651                   <li>
21652                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
21653                     <span class="entry_type_enum_notes"><p>High-quality gamma mapping and color enhancement will be applied,<wbr/> at
21654 the cost of reduced frame rate compared to raw sensor output.<wbr/></p></span>
21655                   </li>
21656                 </ul>
21657
21658             </td> <!-- entry_type -->
21659
21660             <td class="entry_description">
21661               <p>High-level global contrast/<wbr/>gamma/<wbr/>tonemapping control.<wbr/></p>
21662             </td>
21663
21664             <td class="entry_units">
21665             </td>
21666
21667             <td class="entry_range">
21668               <p><a href="#static_android.tonemap.availableToneMapModes">android.<wbr/>tonemap.<wbr/>available<wbr/>Tone<wbr/>Map<wbr/>Modes</a></p>
21669             </td>
21670
21671             <td class="entry_tags">
21672             </td>
21673
21674           </tr>
21675           <tr class="entries_header">
21676             <th class="th_details" colspan="5">Details</th>
21677           </tr>
21678           <tr class="entry_cont">
21679             <td class="entry_details" colspan="5">
21680               <p>When switching to an application-defined contrast curve by setting
21681 <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> to CONTRAST_<wbr/>CURVE,<wbr/> the curve is defined
21682 per-channel with a set of <code>(in,<wbr/> out)</code> points that specify the
21683 mapping from input high-bit-depth pixel value to the output
21684 low-bit-depth value.<wbr/>  Since the actual pixel ranges of both input
21685 and output may change depending on the camera pipeline,<wbr/> the values
21686 are specified by normalized floating-point numbers.<wbr/></p>
21687 <p>More-complex color mapping operations such as 3D color look-up
21688 tables,<wbr/> selective chroma enhancement,<wbr/> or other non-linear color
21689 transforms will be disabled when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
21690 CONTRAST_<wbr/>CURVE.<wbr/></p>
21691 <p>When using either FAST or HIGH_<wbr/>QUALITY,<wbr/> the camera device will
21692 emit its own tonemap curve in <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/>
21693 These values are always available,<wbr/> and as close as possible to the
21694 actually used nonlinear/<wbr/>nonglobal transforms.<wbr/></p>
21695 <p>If a request is sent with CONTRAST_<wbr/>CURVE with the camera device's
21696 provided curve in FAST or HIGH_<wbr/>QUALITY,<wbr/> the image's tonemap will be
21697 roughly the same.<wbr/></p>
21698             </td>
21699           </tr>
21700
21701
21702           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21703            <!-- end of entry -->
21704
21705
21706
21707       <!-- end of kind -->
21708       </tbody>
21709       <tr><td colspan="6" class="kind">static</td></tr>
21710
21711       <thead class="entries_header">
21712         <tr>
21713           <th class="th_name">Property Name</th>
21714           <th class="th_type">Type</th>
21715           <th class="th_description">Description</th>
21716           <th class="th_units">Units</th>
21717           <th class="th_range">Range</th>
21718           <th class="th_tags">Tags</th>
21719         </tr>
21720       </thead>
21721
21722       <tbody>
21723
21724
21725
21726
21727
21728
21729
21730
21731
21732
21733           <tr class="entry" id="static_android.tonemap.maxCurvePoints">
21734             <td class="entry_name
21735              " rowspan="5">
21736               android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points
21737             </td>
21738             <td class="entry_type">
21739                 <span class="entry_type_name">int32</span>
21740
21741               <span class="entry_type_visibility"> [public]</span>
21742
21743
21744               <span class="entry_type_hwlevel">[full] </span>
21745
21746
21747
21748
21749             </td> <!-- entry_type -->
21750
21751             <td class="entry_description">
21752               <p>Maximum number of supported points in the
21753 tonemap curve that can be used for <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/></p>
21754             </td>
21755
21756             <td class="entry_units">
21757             </td>
21758
21759             <td class="entry_range">
21760             </td>
21761
21762             <td class="entry_tags">
21763             </td>
21764
21765           </tr>
21766           <tr class="entries_header">
21767             <th class="th_details" colspan="5">Details</th>
21768           </tr>
21769           <tr class="entry_cont">
21770             <td class="entry_details" colspan="5">
21771               <p>If the actual number of points provided by the application (in <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>*) is
21772 less than this maximum,<wbr/> the camera device will resample the curve to its internal
21773 representation,<wbr/> using linear interpolation.<wbr/></p>
21774 <p>The output curves in the result metadata may have a different number
21775 of points than the input curves,<wbr/> and will represent the actual
21776 hardware curves used as closely as possible when linearly interpolated.<wbr/></p>
21777             </td>
21778           </tr>
21779
21780           <tr class="entries_header">
21781             <th class="th_details" colspan="5">HAL Implementation Details</th>
21782           </tr>
21783           <tr class="entry_cont">
21784             <td class="entry_details" colspan="5">
21785               <p>This value must be at least 64.<wbr/> This should be at least 128.<wbr/></p>
21786             </td>
21787           </tr>
21788
21789           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21790            <!-- end of entry -->
21791
21792
21793           <tr class="entry" id="static_android.tonemap.availableToneMapModes">
21794             <td class="entry_name
21795              " rowspan="3">
21796               android.<wbr/>tonemap.<wbr/>available<wbr/>Tone<wbr/>Map<wbr/>Modes
21797             </td>
21798             <td class="entry_type">
21799                 <span class="entry_type_name">byte</span>
21800                 <span class="entry_type_container">x</span>
21801
21802                 <span class="entry_type_array">
21803                   n
21804                 </span>
21805               <span class="entry_type_visibility"> [public as enumList]</span>
21806
21807
21808               <span class="entry_type_hwlevel">[full] </span>
21809
21810
21811                 <div class="entry_type_notes">list of enums</div>
21812
21813
21814             </td> <!-- entry_type -->
21815
21816             <td class="entry_description">
21817               <p>List of tonemapping modes for <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> that are supported by this camera
21818 device.<wbr/></p>
21819             </td>
21820
21821             <td class="entry_units">
21822             </td>
21823
21824             <td class="entry_range">
21825               <p>Any value listed in <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a></p>
21826             </td>
21827
21828             <td class="entry_tags">
21829             </td>
21830
21831           </tr>
21832           <tr class="entries_header">
21833             <th class="th_details" colspan="5">Details</th>
21834           </tr>
21835           <tr class="entry_cont">
21836             <td class="entry_details" colspan="5">
21837               <p>Camera devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability will always list
21838 CONTRAST_<wbr/>CURVE and FAST.<wbr/> This includes all FULL level devices.<wbr/></p>
21839             </td>
21840           </tr>
21841
21842
21843           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21844            <!-- end of entry -->
21845
21846
21847
21848       <!-- end of kind -->
21849       </tbody>
21850       <tr><td colspan="6" class="kind">dynamic</td></tr>
21851
21852       <thead class="entries_header">
21853         <tr>
21854           <th class="th_name">Property Name</th>
21855           <th class="th_type">Type</th>
21856           <th class="th_description">Description</th>
21857           <th class="th_units">Units</th>
21858           <th class="th_range">Range</th>
21859           <th class="th_tags">Tags</th>
21860         </tr>
21861       </thead>
21862
21863       <tbody>
21864
21865
21866
21867
21868
21869
21870
21871
21872
21873
21874           <tr class="entry" id="dynamic_android.tonemap.curveBlue">
21875             <td class="entry_name
21876              " rowspan="3">
21877               android.<wbr/>tonemap.<wbr/>curve<wbr/>Blue
21878             </td>
21879             <td class="entry_type">
21880                 <span class="entry_type_name">float</span>
21881                 <span class="entry_type_container">x</span>
21882
21883                 <span class="entry_type_array">
21884                   n x 2
21885                 </span>
21886               <span class="entry_type_visibility"> [hidden]</span>
21887
21888
21889               <span class="entry_type_hwlevel">[full] </span>
21890
21891
21892                 <div class="entry_type_notes">1D array of float pairs (P_<wbr/>IN,<wbr/> P_<wbr/>OUT).<wbr/> The maximum number of pairs is specified by android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points.<wbr/></div>
21893
21894
21895             </td> <!-- entry_type -->
21896
21897             <td class="entry_description">
21898               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the blue
21899 channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
21900 CONTRAST_<wbr/>CURVE.<wbr/></p>
21901             </td>
21902
21903             <td class="entry_units">
21904             </td>
21905
21906             <td class="entry_range">
21907             </td>
21908
21909             <td class="entry_tags">
21910             </td>
21911
21912           </tr>
21913           <tr class="entries_header">
21914             <th class="th_details" colspan="5">Details</th>
21915           </tr>
21916           <tr class="entry_cont">
21917             <td class="entry_details" colspan="5">
21918               <p>See <a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> for more details.<wbr/></p>
21919             </td>
21920           </tr>
21921
21922
21923           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21924            <!-- end of entry -->
21925
21926
21927           <tr class="entry" id="dynamic_android.tonemap.curveGreen">
21928             <td class="entry_name
21929              " rowspan="3">
21930               android.<wbr/>tonemap.<wbr/>curve<wbr/>Green
21931             </td>
21932             <td class="entry_type">
21933                 <span class="entry_type_name">float</span>
21934                 <span class="entry_type_container">x</span>
21935
21936                 <span class="entry_type_array">
21937                   n x 2
21938                 </span>
21939               <span class="entry_type_visibility"> [hidden]</span>
21940
21941
21942               <span class="entry_type_hwlevel">[full] </span>
21943
21944
21945                 <div class="entry_type_notes">1D array of float pairs (P_<wbr/>IN,<wbr/> P_<wbr/>OUT).<wbr/> The maximum number of pairs is specified by android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points.<wbr/></div>
21946
21947
21948             </td> <!-- entry_type -->
21949
21950             <td class="entry_description">
21951               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the green
21952 channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
21953 CONTRAST_<wbr/>CURVE.<wbr/></p>
21954             </td>
21955
21956             <td class="entry_units">
21957             </td>
21958
21959             <td class="entry_range">
21960             </td>
21961
21962             <td class="entry_tags">
21963             </td>
21964
21965           </tr>
21966           <tr class="entries_header">
21967             <th class="th_details" colspan="5">Details</th>
21968           </tr>
21969           <tr class="entry_cont">
21970             <td class="entry_details" colspan="5">
21971               <p>See <a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> for more details.<wbr/></p>
21972             </td>
21973           </tr>
21974
21975
21976           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21977            <!-- end of entry -->
21978
21979
21980           <tr class="entry" id="dynamic_android.tonemap.curveRed">
21981             <td class="entry_name
21982              " rowspan="5">
21983               android.<wbr/>tonemap.<wbr/>curve<wbr/>Red
21984             </td>
21985             <td class="entry_type">
21986                 <span class="entry_type_name">float</span>
21987                 <span class="entry_type_container">x</span>
21988
21989                 <span class="entry_type_array">
21990                   n x 2
21991                 </span>
21992               <span class="entry_type_visibility"> [hidden]</span>
21993
21994
21995               <span class="entry_type_hwlevel">[full] </span>
21996
21997
21998                 <div class="entry_type_notes">1D array of float pairs (P_<wbr/>IN,<wbr/> P_<wbr/>OUT).<wbr/> The maximum number of pairs is specified by android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points.<wbr/></div>
21999
22000
22001             </td> <!-- entry_type -->
22002
22003             <td class="entry_description">
22004               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the red
22005 channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
22006 CONTRAST_<wbr/>CURVE.<wbr/></p>
22007             </td>
22008
22009             <td class="entry_units">
22010             </td>
22011
22012             <td class="entry_range">
22013               <p>0-1 on both input and output coordinates,<wbr/> normalized
22014 as a floating-point value such that 0 == black and 1 == white.<wbr/></p>
22015             </td>
22016
22017             <td class="entry_tags">
22018             </td>
22019
22020           </tr>
22021           <tr class="entries_header">
22022             <th class="th_details" colspan="5">Details</th>
22023           </tr>
22024           <tr class="entry_cont">
22025             <td class="entry_details" colspan="5">
22026               <p>Each channel's curve is defined by an array of control points:</p>
22027 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> =
22028   [ P0in,<wbr/> P0out,<wbr/> P1in,<wbr/> P1out,<wbr/> P2in,<wbr/> P2out,<wbr/> P3in,<wbr/> P3out,<wbr/> ...,<wbr/> PNin,<wbr/> PNout ]
22029 2 &lt;= N &lt;= <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></code></pre>
22030 <p>These are sorted in order of increasing <code>Pin</code>; it is
22031 required that input values 0.<wbr/>0 and 1.<wbr/>0 are included in the list to
22032 define a complete mapping.<wbr/> For input values between control points,<wbr/>
22033 the camera device must linearly interpolate between the control
22034 points.<wbr/></p>
22035 <p>Each curve can have an independent number of points,<wbr/> and the number
22036 of points can be less than max (that is,<wbr/> the request doesn't have to
22037 always provide a curve with number of points equivalent to
22038 <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a>).<wbr/></p>
22039 <p>A few examples,<wbr/> and their corresponding graphical mappings; these
22040 only specify the red channel and the precision is limited to 4
22041 digits,<wbr/> for conciseness.<wbr/></p>
22042 <p>Linear mapping:</p>
22043 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [ 0,<wbr/> 0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0 ]
22044 </code></pre>
22045 <p><img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/></p>
22046 <p>Invert mapping:</p>
22047 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [ 0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 0 ]
22048 </code></pre>
22049 <p><img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/></p>
22050 <p>Gamma 1/<wbr/>2.<wbr/>2 mapping,<wbr/> with 16 control points:</p>
22051 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [
22052   0.<wbr/>0000,<wbr/> 0.<wbr/>0000,<wbr/> 0.<wbr/>0667,<wbr/> 0.<wbr/>2920,<wbr/> 0.<wbr/>1333,<wbr/> 0.<wbr/>4002,<wbr/> 0.<wbr/>2000,<wbr/> 0.<wbr/>4812,<wbr/>
22053   0.<wbr/>2667,<wbr/> 0.<wbr/>5484,<wbr/> 0.<wbr/>3333,<wbr/> 0.<wbr/>6069,<wbr/> 0.<wbr/>4000,<wbr/> 0.<wbr/>6594,<wbr/> 0.<wbr/>4667,<wbr/> 0.<wbr/>7072,<wbr/>
22054   0.<wbr/>5333,<wbr/> 0.<wbr/>7515,<wbr/> 0.<wbr/>6000,<wbr/> 0.<wbr/>7928,<wbr/> 0.<wbr/>6667,<wbr/> 0.<wbr/>8317,<wbr/> 0.<wbr/>7333,<wbr/> 0.<wbr/>8685,<wbr/>
22055   0.<wbr/>8000,<wbr/> 0.<wbr/>9035,<wbr/> 0.<wbr/>8667,<wbr/> 0.<wbr/>9370,<wbr/> 0.<wbr/>9333,<wbr/> 0.<wbr/>9691,<wbr/> 1.<wbr/>0000,<wbr/> 1.<wbr/>0000 ]
22056 </code></pre>
22057 <p><img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/></p>
22058 <p>Standard sRGB gamma mapping,<wbr/> per IEC 61966-2-1:1999,<wbr/> with 16 control points:</p>
22059 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [
22060   0.<wbr/>0000,<wbr/> 0.<wbr/>0000,<wbr/> 0.<wbr/>0667,<wbr/> 0.<wbr/>2864,<wbr/> 0.<wbr/>1333,<wbr/> 0.<wbr/>4007,<wbr/> 0.<wbr/>2000,<wbr/> 0.<wbr/>4845,<wbr/>
22061   0.<wbr/>2667,<wbr/> 0.<wbr/>5532,<wbr/> 0.<wbr/>3333,<wbr/> 0.<wbr/>6125,<wbr/> 0.<wbr/>4000,<wbr/> 0.<wbr/>6652,<wbr/> 0.<wbr/>4667,<wbr/> 0.<wbr/>7130,<wbr/>
22062   0.<wbr/>5333,<wbr/> 0.<wbr/>7569,<wbr/> 0.<wbr/>6000,<wbr/> 0.<wbr/>7977,<wbr/> 0.<wbr/>6667,<wbr/> 0.<wbr/>8360,<wbr/> 0.<wbr/>7333,<wbr/> 0.<wbr/>8721,<wbr/>
22063   0.<wbr/>8000,<wbr/> 0.<wbr/>9063,<wbr/> 0.<wbr/>8667,<wbr/> 0.<wbr/>9389,<wbr/> 0.<wbr/>9333,<wbr/> 0.<wbr/>9701,<wbr/> 1.<wbr/>0000,<wbr/> 1.<wbr/>0000 ]
22064 </code></pre>
22065 <p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
22066             </td>
22067           </tr>
22068
22069           <tr class="entries_header">
22070             <th class="th_details" colspan="5">HAL Implementation Details</th>
22071           </tr>
22072           <tr class="entry_cont">
22073             <td class="entry_details" colspan="5">
22074               <p>For good quality of mapping,<wbr/> at least 128 control points are
22075 preferred.<wbr/></p>
22076 <p>A typical use case of this would be a gamma-1/<wbr/>2.<wbr/>2 curve,<wbr/> with as many
22077 control points used as are available.<wbr/></p>
22078             </td>
22079           </tr>
22080
22081           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22082            <!-- end of entry -->
22083
22084
22085           <tr class="entry" id="dynamic_android.tonemap.curve">
22086             <td class="entry_name
22087              " rowspan="5">
22088               android.<wbr/>tonemap.<wbr/>curve
22089             </td>
22090             <td class="entry_type">
22091                 <span class="entry_type_name">float</span>
22092
22093               <span class="entry_type_visibility"> [public as tonemapCurve]</span>
22094
22095               <span class="entry_type_synthetic">[synthetic] </span>
22096
22097               <span class="entry_type_hwlevel">[full] </span>
22098
22099
22100
22101
22102             </td> <!-- entry_type -->
22103
22104             <td class="entry_description">
22105               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a>
22106 is CONTRAST_<wbr/>CURVE.<wbr/></p>
22107             </td>
22108
22109             <td class="entry_units">
22110             </td>
22111
22112             <td class="entry_range">
22113             </td>
22114
22115             <td class="entry_tags">
22116             </td>
22117
22118           </tr>
22119           <tr class="entries_header">
22120             <th class="th_details" colspan="5">Details</th>
22121           </tr>
22122           <tr class="entry_cont">
22123             <td class="entry_details" colspan="5">
22124               <p>The tonemapCurve consist of three curves for each of red,<wbr/> green,<wbr/> and blue
22125 channels respectively.<wbr/> The following example uses the red channel as an
22126 example.<wbr/> The same logic applies to green and blue channel.<wbr/>
22127 Each channel's curve is defined by an array of control points:</p>
22128 <pre><code>curveRed =
22129   [ P0(in,<wbr/> out),<wbr/> P1(in,<wbr/> out),<wbr/> P2(in,<wbr/> out),<wbr/> P3(in,<wbr/> out),<wbr/> ...,<wbr/> PN(in,<wbr/> out) ]
22130 2 &lt;= N &lt;= <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></code></pre>
22131 <p>These are sorted in order of increasing <code>Pin</code>; it is always
22132 guaranteed that input values 0.<wbr/>0 and 1.<wbr/>0 are included in the list to
22133 define a complete mapping.<wbr/> For input values between control points,<wbr/>
22134 the camera device must linearly interpolate between the control
22135 points.<wbr/></p>
22136 <p>Each curve can have an independent number of points,<wbr/> and the number
22137 of points can be less than max (that is,<wbr/> the request doesn't have to
22138 always provide a curve with number of points equivalent to
22139 <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a>).<wbr/></p>
22140 <p>A few examples,<wbr/> and their corresponding graphical mappings; these
22141 only specify the red channel and the precision is limited to 4
22142 digits,<wbr/> for conciseness.<wbr/></p>
22143 <p>Linear mapping:</p>
22144 <pre><code>curveRed = [ (0,<wbr/> 0),<wbr/> (1.<wbr/>0,<wbr/> 1.<wbr/>0) ]
22145 </code></pre>
22146 <p><img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/></p>
22147 <p>Invert mapping:</p>
22148 <pre><code>curveRed = [ (0,<wbr/> 1.<wbr/>0),<wbr/> (1.<wbr/>0,<wbr/> 0) ]
22149 </code></pre>
22150 <p><img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/></p>
22151 <p>Gamma 1/<wbr/>2.<wbr/>2 mapping,<wbr/> with 16 control points:</p>
22152 <pre><code>curveRed = [
22153   (0.<wbr/>0000,<wbr/> 0.<wbr/>0000),<wbr/> (0.<wbr/>0667,<wbr/> 0.<wbr/>2920),<wbr/> (0.<wbr/>1333,<wbr/> 0.<wbr/>4002),<wbr/> (0.<wbr/>2000,<wbr/> 0.<wbr/>4812),<wbr/>
22154   (0.<wbr/>2667,<wbr/> 0.<wbr/>5484),<wbr/> (0.<wbr/>3333,<wbr/> 0.<wbr/>6069),<wbr/> (0.<wbr/>4000,<wbr/> 0.<wbr/>6594),<wbr/> (0.<wbr/>4667,<wbr/> 0.<wbr/>7072),<wbr/>
22155   (0.<wbr/>5333,<wbr/> 0.<wbr/>7515),<wbr/> (0.<wbr/>6000,<wbr/> 0.<wbr/>7928),<wbr/> (0.<wbr/>6667,<wbr/> 0.<wbr/>8317),<wbr/> (0.<wbr/>7333,<wbr/> 0.<wbr/>8685),<wbr/>
22156   (0.<wbr/>8000,<wbr/> 0.<wbr/>9035),<wbr/> (0.<wbr/>8667,<wbr/> 0.<wbr/>9370),<wbr/> (0.<wbr/>9333,<wbr/> 0.<wbr/>9691),<wbr/> (1.<wbr/>0000,<wbr/> 1.<wbr/>0000) ]
22157 </code></pre>
22158 <p><img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/></p>
22159 <p>Standard sRGB gamma mapping,<wbr/> per IEC 61966-2-1:1999,<wbr/> with 16 control points:</p>
22160 <pre><code>curveRed = [
22161   (0.<wbr/>0000,<wbr/> 0.<wbr/>0000),<wbr/> (0.<wbr/>0667,<wbr/> 0.<wbr/>2864),<wbr/> (0.<wbr/>1333,<wbr/> 0.<wbr/>4007),<wbr/> (0.<wbr/>2000,<wbr/> 0.<wbr/>4845),<wbr/>
22162   (0.<wbr/>2667,<wbr/> 0.<wbr/>5532),<wbr/> (0.<wbr/>3333,<wbr/> 0.<wbr/>6125),<wbr/> (0.<wbr/>4000,<wbr/> 0.<wbr/>6652),<wbr/> (0.<wbr/>4667,<wbr/> 0.<wbr/>7130),<wbr/>
22163   (0.<wbr/>5333,<wbr/> 0.<wbr/>7569),<wbr/> (0.<wbr/>6000,<wbr/> 0.<wbr/>7977),<wbr/> (0.<wbr/>6667,<wbr/> 0.<wbr/>8360),<wbr/> (0.<wbr/>7333,<wbr/> 0.<wbr/>8721),<wbr/>
22164   (0.<wbr/>8000,<wbr/> 0.<wbr/>9063),<wbr/> (0.<wbr/>8667,<wbr/> 0.<wbr/>9389),<wbr/> (0.<wbr/>9333,<wbr/> 0.<wbr/>9701),<wbr/> (1.<wbr/>0000,<wbr/> 1.<wbr/>0000) ]
22165 </code></pre>
22166 <p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
22167             </td>
22168           </tr>
22169
22170           <tr class="entries_header">
22171             <th class="th_details" colspan="5">HAL Implementation Details</th>
22172           </tr>
22173           <tr class="entry_cont">
22174             <td class="entry_details" colspan="5">
22175               <p>This entry is created by the framework from the curveRed,<wbr/> curveGreen and
22176 curveBlue entries.<wbr/></p>
22177             </td>
22178           </tr>
22179
22180           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22181            <!-- end of entry -->
22182
22183
22184           <tr class="entry" id="dynamic_android.tonemap.mode">
22185             <td class="entry_name
22186              " rowspan="3">
22187               android.<wbr/>tonemap.<wbr/>mode
22188             </td>
22189             <td class="entry_type">
22190                 <span class="entry_type_name entry_type_name_enum">byte</span>
22191
22192               <span class="entry_type_visibility"> [public]</span>
22193
22194
22195               <span class="entry_type_hwlevel">[full] </span>
22196
22197
22198
22199                 <ul class="entry_type_enum">
22200                   <li>
22201                     <span class="entry_type_enum_name">CONTRAST_CURVE</span>
22202                     <span class="entry_type_enum_notes"><p>Use the tone mapping curve specified in
22203 the <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>* entries.<wbr/></p>
22204 <p>All color enhancement and tonemapping must be disabled,<wbr/> except
22205 for applying the tonemapping curve specified by
22206 <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/></p>
22207 <p>Must not slow down frame rate relative to raw
22208 sensor output.<wbr/></p></span>
22209                   </li>
22210                   <li>
22211                     <span class="entry_type_enum_name">FAST</span>
22212                     <span class="entry_type_enum_notes"><p>Advanced gamma mapping and color enhancement may be applied,<wbr/> without
22213 reducing frame rate compared to raw sensor output.<wbr/></p></span>
22214                   </li>
22215                   <li>
22216                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
22217                     <span class="entry_type_enum_notes"><p>High-quality gamma mapping and color enhancement will be applied,<wbr/> at
22218 the cost of reduced frame rate compared to raw sensor output.<wbr/></p></span>
22219                   </li>
22220                 </ul>
22221
22222             </td> <!-- entry_type -->
22223
22224             <td class="entry_description">
22225               <p>High-level global contrast/<wbr/>gamma/<wbr/>tonemapping control.<wbr/></p>
22226             </td>
22227
22228             <td class="entry_units">
22229             </td>
22230
22231             <td class="entry_range">
22232               <p><a href="#static_android.tonemap.availableToneMapModes">android.<wbr/>tonemap.<wbr/>available<wbr/>Tone<wbr/>Map<wbr/>Modes</a></p>
22233             </td>
22234
22235             <td class="entry_tags">
22236             </td>
22237
22238           </tr>
22239           <tr class="entries_header">
22240             <th class="th_details" colspan="5">Details</th>
22241           </tr>
22242           <tr class="entry_cont">
22243             <td class="entry_details" colspan="5">
22244               <p>When switching to an application-defined contrast curve by setting
22245 <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> to CONTRAST_<wbr/>CURVE,<wbr/> the curve is defined
22246 per-channel with a set of <code>(in,<wbr/> out)</code> points that specify the
22247 mapping from input high-bit-depth pixel value to the output
22248 low-bit-depth value.<wbr/>  Since the actual pixel ranges of both input
22249 and output may change depending on the camera pipeline,<wbr/> the values
22250 are specified by normalized floating-point numbers.<wbr/></p>
22251 <p>More-complex color mapping operations such as 3D color look-up
22252 tables,<wbr/> selective chroma enhancement,<wbr/> or other non-linear color
22253 transforms will be disabled when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
22254 CONTRAST_<wbr/>CURVE.<wbr/></p>
22255 <p>When using either FAST or HIGH_<wbr/>QUALITY,<wbr/> the camera device will
22256 emit its own tonemap curve in <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/>
22257 These values are always available,<wbr/> and as close as possible to the
22258 actually used nonlinear/<wbr/>nonglobal transforms.<wbr/></p>
22259 <p>If a request is sent with CONTRAST_<wbr/>CURVE with the camera device's
22260 provided curve in FAST or HIGH_<wbr/>QUALITY,<wbr/> the image's tonemap will be
22261 roughly the same.<wbr/></p>
22262             </td>
22263           </tr>
22264
22265
22266           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22267            <!-- end of entry -->
22268
22269
22270
22271       <!-- end of kind -->
22272       </tbody>
22273
22274   <!-- end of section -->
22275   <tr><td colspan="6" id="section_led" class="section">led</td></tr>
22276
22277
22278       <tr><td colspan="6" class="kind">controls</td></tr>
22279
22280       <thead class="entries_header">
22281         <tr>
22282           <th class="th_name">Property Name</th>
22283           <th class="th_type">Type</th>
22284           <th class="th_description">Description</th>
22285           <th class="th_units">Units</th>
22286           <th class="th_range">Range</th>
22287           <th class="th_tags">Tags</th>
22288         </tr>
22289       </thead>
22290
22291       <tbody>
22292
22293
22294
22295
22296
22297
22298
22299
22300
22301
22302           <tr class="entry" id="controls_android.led.transmit">
22303             <td class="entry_name
22304              " rowspan="1">
22305               android.<wbr/>led.<wbr/>transmit
22306             </td>
22307             <td class="entry_type">
22308                 <span class="entry_type_name entry_type_name_enum">byte</span>
22309
22310               <span class="entry_type_visibility"> [hidden as boolean]</span>
22311
22312
22313
22314
22315
22316                 <ul class="entry_type_enum">
22317                   <li>
22318                     <span class="entry_type_enum_name">OFF</span>
22319                   </li>
22320                   <li>
22321                     <span class="entry_type_enum_name">ON</span>
22322                   </li>
22323                 </ul>
22324
22325             </td> <!-- entry_type -->
22326
22327             <td class="entry_description">
22328               <p>This LED is nominally used to indicate to the user
22329 that the camera is powered on and may be streaming images back to the
22330 Application Processor.<wbr/> In certain rare circumstances,<wbr/> the OS may
22331 disable this when video is processed locally and not transmitted to
22332 any untrusted applications.<wbr/></p>
22333 <p>In particular,<wbr/> the LED <em>must</em> always be on when the data could be
22334 transmitted off the device.<wbr/> The LED <em>should</em> always be on whenever
22335 data is stored locally on the device.<wbr/></p>
22336 <p>The LED <em>may</em> be off if a trusted application is using the data that
22337 doesn't violate the above rules.<wbr/></p>
22338             </td>
22339
22340             <td class="entry_units">
22341             </td>
22342
22343             <td class="entry_range">
22344             </td>
22345
22346             <td class="entry_tags">
22347             </td>
22348
22349           </tr>
22350
22351
22352           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22353            <!-- end of entry -->
22354
22355
22356
22357       <!-- end of kind -->
22358       </tbody>
22359       <tr><td colspan="6" class="kind">dynamic</td></tr>
22360
22361       <thead class="entries_header">
22362         <tr>
22363           <th class="th_name">Property Name</th>
22364           <th class="th_type">Type</th>
22365           <th class="th_description">Description</th>
22366           <th class="th_units">Units</th>
22367           <th class="th_range">Range</th>
22368           <th class="th_tags">Tags</th>
22369         </tr>
22370       </thead>
22371
22372       <tbody>
22373
22374
22375
22376
22377
22378
22379
22380
22381
22382
22383           <tr class="entry" id="dynamic_android.led.transmit">
22384             <td class="entry_name
22385              " rowspan="1">
22386               android.<wbr/>led.<wbr/>transmit
22387             </td>
22388             <td class="entry_type">
22389                 <span class="entry_type_name entry_type_name_enum">byte</span>
22390
22391               <span class="entry_type_visibility"> [hidden as boolean]</span>
22392
22393
22394
22395
22396
22397                 <ul class="entry_type_enum">
22398                   <li>
22399                     <span class="entry_type_enum_name">OFF</span>
22400                   </li>
22401                   <li>
22402                     <span class="entry_type_enum_name">ON</span>
22403                   </li>
22404                 </ul>
22405
22406             </td> <!-- entry_type -->
22407
22408             <td class="entry_description">
22409               <p>This LED is nominally used to indicate to the user
22410 that the camera is powered on and may be streaming images back to the
22411 Application Processor.<wbr/> In certain rare circumstances,<wbr/> the OS may
22412 disable this when video is processed locally and not transmitted to
22413 any untrusted applications.<wbr/></p>
22414 <p>In particular,<wbr/> the LED <em>must</em> always be on when the data could be
22415 transmitted off the device.<wbr/> The LED <em>should</em> always be on whenever
22416 data is stored locally on the device.<wbr/></p>
22417 <p>The LED <em>may</em> be off if a trusted application is using the data that
22418 doesn't violate the above rules.<wbr/></p>
22419             </td>
22420
22421             <td class="entry_units">
22422             </td>
22423
22424             <td class="entry_range">
22425             </td>
22426
22427             <td class="entry_tags">
22428             </td>
22429
22430           </tr>
22431
22432
22433           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22434            <!-- end of entry -->
22435
22436
22437
22438       <!-- end of kind -->
22439       </tbody>
22440       <tr><td colspan="6" class="kind">static</td></tr>
22441
22442       <thead class="entries_header">
22443         <tr>
22444           <th class="th_name">Property Name</th>
22445           <th class="th_type">Type</th>
22446           <th class="th_description">Description</th>
22447           <th class="th_units">Units</th>
22448           <th class="th_range">Range</th>
22449           <th class="th_tags">Tags</th>
22450         </tr>
22451       </thead>
22452
22453       <tbody>
22454
22455
22456
22457
22458
22459
22460
22461
22462
22463
22464           <tr class="entry" id="static_android.led.availableLeds">
22465             <td class="entry_name
22466              " rowspan="1">
22467               android.<wbr/>led.<wbr/>available<wbr/>Leds
22468             </td>
22469             <td class="entry_type">
22470                 <span class="entry_type_name entry_type_name_enum">byte</span>
22471                 <span class="entry_type_container">x</span>
22472
22473                 <span class="entry_type_array">
22474                   n
22475                 </span>
22476               <span class="entry_type_visibility"> [hidden]</span>
22477
22478
22479
22480
22481
22482                 <ul class="entry_type_enum">
22483                   <li>
22484                     <span class="entry_type_enum_name">TRANSMIT</span>
22485                     <span class="entry_type_enum_notes"><p><a href="#controls_android.led.transmit">android.<wbr/>led.<wbr/>transmit</a> control is used.<wbr/></p></span>
22486                   </li>
22487                 </ul>
22488
22489             </td> <!-- entry_type -->
22490
22491             <td class="entry_description">
22492               <p>A list of camera LEDs that are available on this system.<wbr/></p>
22493             </td>
22494
22495             <td class="entry_units">
22496             </td>
22497
22498             <td class="entry_range">
22499             </td>
22500
22501             <td class="entry_tags">
22502             </td>
22503
22504           </tr>
22505
22506
22507           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22508            <!-- end of entry -->
22509
22510
22511
22512       <!-- end of kind -->
22513       </tbody>
22514
22515   <!-- end of section -->
22516   <tr><td colspan="6" id="section_info" class="section">info</td></tr>
22517
22518
22519       <tr><td colspan="6" class="kind">static</td></tr>
22520
22521       <thead class="entries_header">
22522         <tr>
22523           <th class="th_name">Property Name</th>
22524           <th class="th_type">Type</th>
22525           <th class="th_description">Description</th>
22526           <th class="th_units">Units</th>
22527           <th class="th_range">Range</th>
22528           <th class="th_tags">Tags</th>
22529         </tr>
22530       </thead>
22531
22532       <tbody>
22533
22534
22535
22536
22537
22538
22539
22540
22541
22542
22543           <tr class="entry" id="static_android.info.supportedHardwareLevel">
22544             <td class="entry_name
22545              " rowspan="5">
22546               android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level
22547             </td>
22548             <td class="entry_type">
22549                 <span class="entry_type_name entry_type_name_enum">byte</span>
22550
22551               <span class="entry_type_visibility"> [public]</span>
22552
22553
22554               <span class="entry_type_hwlevel">[legacy] </span>
22555
22556
22557
22558                 <ul class="entry_type_enum">
22559                   <li>
22560                     <span class="entry_type_enum_name">LIMITED</span>
22561                     <span class="entry_type_enum_notes"><p>This camera device has only limited capabilities.<wbr/></p></span>
22562                   </li>
22563                   <li>
22564                     <span class="entry_type_enum_name">FULL</span>
22565                     <span class="entry_type_enum_notes"><p>This camera device is capable of supporting advanced imaging applications.<wbr/></p></span>
22566                   </li>
22567                   <li>
22568                     <span class="entry_type_enum_name">LEGACY</span>
22569                     <span class="entry_type_enum_notes"><p>This camera device is running in backward compatibility mode.<wbr/></p></span>
22570                   </li>
22571                 </ul>
22572
22573             </td> <!-- entry_type -->
22574
22575             <td class="entry_description">
22576               <p>Generally classifies the overall set of the camera device functionality.<wbr/></p>
22577             </td>
22578
22579             <td class="entry_units">
22580             </td>
22581
22582             <td class="entry_range">
22583             </td>
22584
22585             <td class="entry_tags">
22586             </td>
22587
22588           </tr>
22589           <tr class="entries_header">
22590             <th class="th_details" colspan="5">Details</th>
22591           </tr>
22592           <tr class="entry_cont">
22593             <td class="entry_details" colspan="5">
22594               <p>Camera devices will come in three flavors: LEGACY,<wbr/> LIMITED and FULL.<wbr/></p>
22595 <p>A FULL device will support below capabilities:</p>
22596 <ul>
22597 <li>30fps at maximum resolution (== sensor resolution) is preferred,<wbr/> more than 20fps is required.<wbr/></li>
22598 <li>Per frame control (<a href="#static_android.sync.maxLatency">android.<wbr/>sync.<wbr/>max<wbr/>Latency</a> <code>==</code> PER_<wbr/>FRAME_<wbr/>CONTROL)</li>
22599 <li>Manual sensor control (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains MANUAL_<wbr/>SENSOR)</li>
22600 <li>Manual post-processing control (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains MANUAL_<wbr/>POST_<wbr/>PROCESSING)</li>
22601 <li>Arbitrary cropping region (<a href="#static_android.scaler.croppingType">android.<wbr/>scaler.<wbr/>cropping<wbr/>Type</a> <code>==</code> FREEFORM)</li>
22602 <li>At least 3 processed (but not stalling) format output streams (<a href="#static_android.request.maxNumOutputProc">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Proc</a> <code>&gt;=</code> 3)</li>
22603 <li>The required stream configuration defined in <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a></li>
22604 <li>The required exposure time range defined in <a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a></li>
22605 <li>The required maxFrameDuration defined in <a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a></li>
22606 </ul>
22607 <p>A LIMITED device may have some or none of the above characteristics.<wbr/>
22608 To find out more refer to <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>.<wbr/></p>
22609 <p>Some features are not part of any particular hardware level or capability and must be
22610 queried separately.<wbr/> These include:</p>
22611 <ul>
22612 <li>Calibrated timestamps (<a href="#static_android.sensor.info.timestampSource">android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source</a> <code>==</code> REALTIME)</li>
22613 <li>Precision lens control (<a href="#static_android.lens.info.focusDistanceCalibration">android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration</a> <code>==</code> CALIBRATED)</li>
22614 <li>Face detection (<a href="#static_android.statistics.info.availableFaceDetectModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Face<wbr/>Detect<wbr/>Modes</a>)</li>
22615 <li>Optical or electrical image stabilization
22616   (<a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a>,<wbr/>
22617    <a href="#static_android.control.availableVideoStabilizationModes">android.<wbr/>control.<wbr/>available<wbr/>Video<wbr/>Stabilization<wbr/>Modes</a>)</li>
22618 </ul>
22619 <p>A LEGACY device does not support per-frame control,<wbr/> manual sensor control,<wbr/> manual
22620 post-processing,<wbr/> arbitrary cropping regions,<wbr/> and has relaxed performance constraints.<wbr/></p>
22621 <p>Each higher level supports everything the lower level supports
22622 in this order: FULL <code>&gt;</code> LIMITED <code>&gt;</code> LEGACY.<wbr/></p>
22623             </td>
22624           </tr>
22625
22626           <tr class="entries_header">
22627             <th class="th_details" colspan="5">HAL Implementation Details</th>
22628           </tr>
22629           <tr class="entry_cont">
22630             <td class="entry_details" colspan="5">
22631               <p>The camera 3 HAL device can implement one of two possible
22632 operational modes; limited and full.<wbr/> Full support is
22633 expected from new higher-end devices.<wbr/> Limited mode has
22634 hardware requirements roughly in line with those for a
22635 camera HAL device v1 implementation,<wbr/> and is expected from
22636 older or inexpensive devices.<wbr/> Full is a strict superset of
22637 limited,<wbr/> and they share the same essential operational flow.<wbr/></p>
22638 <p>For full details refer to "S3.<wbr/> Operational Modes" in camera3.<wbr/>h</p>
22639 <p>Camera HAL3+ must not implement LEGACY mode.<wbr/> It is there
22640 for backwards compatibility in the <code>android.<wbr/>hardware.<wbr/>camera2</code>
22641 user-facing API only.<wbr/></p>
22642             </td>
22643           </tr>
22644
22645           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22646            <!-- end of entry -->
22647
22648
22649
22650       <!-- end of kind -->
22651       </tbody>
22652
22653   <!-- end of section -->
22654   <tr><td colspan="6" id="section_blackLevel" class="section">blackLevel</td></tr>
22655
22656
22657       <tr><td colspan="6" class="kind">controls</td></tr>
22658
22659       <thead class="entries_header">
22660         <tr>
22661           <th class="th_name">Property Name</th>
22662           <th class="th_type">Type</th>
22663           <th class="th_description">Description</th>
22664           <th class="th_units">Units</th>
22665           <th class="th_range">Range</th>
22666           <th class="th_tags">Tags</th>
22667         </tr>
22668       </thead>
22669
22670       <tbody>
22671
22672
22673
22674
22675
22676
22677
22678
22679
22680
22681           <tr class="entry" id="controls_android.blackLevel.lock">
22682             <td class="entry_name
22683              " rowspan="5">
22684               android.<wbr/>black<wbr/>Level.<wbr/>lock
22685             </td>
22686             <td class="entry_type">
22687                 <span class="entry_type_name entry_type_name_enum">byte</span>
22688
22689               <span class="entry_type_visibility"> [public as boolean]</span>
22690
22691
22692               <span class="entry_type_hwlevel">[full] </span>
22693
22694
22695
22696                 <ul class="entry_type_enum">
22697                   <li>
22698                     <span class="entry_type_enum_name">OFF</span>
22699                   </li>
22700                   <li>
22701                     <span class="entry_type_enum_name">ON</span>
22702                   </li>
22703                 </ul>
22704
22705             </td> <!-- entry_type -->
22706
22707             <td class="entry_description">
22708               <p>Whether black-level compensation is locked
22709 to its current values,<wbr/> or is free to vary.<wbr/></p>
22710             </td>
22711
22712             <td class="entry_units">
22713             </td>
22714
22715             <td class="entry_range">
22716             </td>
22717
22718             <td class="entry_tags">
22719               <ul class="entry_tags">
22720                   <li><a href="#tag_HAL2">HAL2</a></li>
22721               </ul>
22722             </td>
22723
22724           </tr>
22725           <tr class="entries_header">
22726             <th class="th_details" colspan="5">Details</th>
22727           </tr>
22728           <tr class="entry_cont">
22729             <td class="entry_details" colspan="5">
22730               <p>When set to <code>true</code> (ON),<wbr/> the values used for black-level
22731 compensation will not change until the lock is set to
22732 <code>false</code> (OFF).<wbr/></p>
22733 <p>Since changes to certain capture parameters (such as
22734 exposure time) may require resetting of black level
22735 compensation,<wbr/> the camera device must report whether setting
22736 the black level lock was successful in the output result
22737 metadata.<wbr/></p>
22738 <p>For example,<wbr/> if a sequence of requests is as follows:</p>
22739 <ul>
22740 <li>Request 1: Exposure = 10ms,<wbr/> Black level lock = OFF</li>
22741 <li>Request 2: Exposure = 10ms,<wbr/> Black level lock = ON</li>
22742 <li>Request 3: Exposure = 10ms,<wbr/> Black level lock = ON</li>
22743 <li>Request 4: Exposure = 20ms,<wbr/> Black level lock = ON</li>
22744 <li>Request 5: Exposure = 20ms,<wbr/> Black level lock = ON</li>
22745 <li>Request 6: Exposure = 20ms,<wbr/> Black level lock = ON</li>
22746 </ul>
22747 <p>And the exposure change in Request 4 requires the camera
22748 device to reset the black level offsets,<wbr/> then the output
22749 result metadata is expected to be:</p>
22750 <ul>
22751 <li>Result 1: Exposure = 10ms,<wbr/> Black level lock = OFF</li>
22752 <li>Result 2: Exposure = 10ms,<wbr/> Black level lock = ON</li>
22753 <li>Result 3: Exposure = 10ms,<wbr/> Black level lock = ON</li>
22754 <li>Result 4: Exposure = 20ms,<wbr/> Black level lock = OFF</li>
22755 <li>Result 5: Exposure = 20ms,<wbr/> Black level lock = ON</li>
22756 <li>Result 6: Exposure = 20ms,<wbr/> Black level lock = ON</li>
22757 </ul>
22758 <p>This indicates to the application that on frame 4,<wbr/> black
22759 levels were reset due to exposure value changes,<wbr/> and pixel
22760 values may not be consistent across captures.<wbr/></p>
22761 <p>The camera device will maintain the lock to the extent
22762 possible,<wbr/> only overriding the lock to OFF when changes to
22763 other request parameters require a black level recalculation
22764 or reset.<wbr/></p>
22765             </td>
22766           </tr>
22767
22768           <tr class="entries_header">
22769             <th class="th_details" colspan="5">HAL Implementation Details</th>
22770           </tr>
22771           <tr class="entry_cont">
22772             <td class="entry_details" colspan="5">
22773               <p>If for some reason black level locking is no longer possible
22774 (for example,<wbr/> the analog gain has changed,<wbr/> which forces
22775 black level offsets to be recalculated),<wbr/> then the HAL must
22776 override this request (and it must report 'OFF' when this
22777 does happen) until the next capture for which locking is
22778 possible again.<wbr/></p>
22779             </td>
22780           </tr>
22781
22782           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22783            <!-- end of entry -->
22784
22785
22786
22787       <!-- end of kind -->
22788       </tbody>
22789       <tr><td colspan="6" class="kind">dynamic</td></tr>
22790
22791       <thead class="entries_header">
22792         <tr>
22793           <th class="th_name">Property Name</th>
22794           <th class="th_type">Type</th>
22795           <th class="th_description">Description</th>
22796           <th class="th_units">Units</th>
22797           <th class="th_range">Range</th>
22798           <th class="th_tags">Tags</th>
22799         </tr>
22800       </thead>
22801
22802       <tbody>
22803
22804
22805
22806
22807
22808
22809
22810
22811
22812
22813           <tr class="entry" id="dynamic_android.blackLevel.lock">
22814             <td class="entry_name
22815              " rowspan="5">
22816               android.<wbr/>black<wbr/>Level.<wbr/>lock
22817             </td>
22818             <td class="entry_type">
22819                 <span class="entry_type_name entry_type_name_enum">byte</span>
22820
22821               <span class="entry_type_visibility"> [public as boolean]</span>
22822
22823
22824               <span class="entry_type_hwlevel">[full] </span>
22825
22826
22827
22828                 <ul class="entry_type_enum">
22829                   <li>
22830                     <span class="entry_type_enum_name">OFF</span>
22831                   </li>
22832                   <li>
22833                     <span class="entry_type_enum_name">ON</span>
22834                   </li>
22835                 </ul>
22836
22837             </td> <!-- entry_type -->
22838
22839             <td class="entry_description">
22840               <p>Whether black-level compensation is locked
22841 to its current values,<wbr/> or is free to vary.<wbr/></p>
22842             </td>
22843
22844             <td class="entry_units">
22845             </td>
22846
22847             <td class="entry_range">
22848             </td>
22849
22850             <td class="entry_tags">
22851               <ul class="entry_tags">
22852                   <li><a href="#tag_HAL2">HAL2</a></li>
22853               </ul>
22854             </td>
22855
22856           </tr>
22857           <tr class="entries_header">
22858             <th class="th_details" colspan="5">Details</th>
22859           </tr>
22860           <tr class="entry_cont">
22861             <td class="entry_details" colspan="5">
22862               <p>Whether the black level offset was locked for this frame.<wbr/>  Should be
22863 ON if <a href="#controls_android.blackLevel.lock">android.<wbr/>black<wbr/>Level.<wbr/>lock</a> was ON in the capture request,<wbr/> unless
22864 a change in other capture settings forced the camera device to
22865 perform a black level reset.<wbr/></p>
22866             </td>
22867           </tr>
22868
22869           <tr class="entries_header">
22870             <th class="th_details" colspan="5">HAL Implementation Details</th>
22871           </tr>
22872           <tr class="entry_cont">
22873             <td class="entry_details" colspan="5">
22874               <p>If for some reason black level locking is no longer possible
22875 (for example,<wbr/> the analog gain has changed,<wbr/> which forces
22876 black level offsets to be recalculated),<wbr/> then the HAL must
22877 override this request (and it must report 'OFF' when this
22878 does happen) until the next capture for which locking is
22879 possible again.<wbr/></p>
22880             </td>
22881           </tr>
22882
22883           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22884            <!-- end of entry -->
22885
22886
22887
22888       <!-- end of kind -->
22889       </tbody>
22890
22891   <!-- end of section -->
22892   <tr><td colspan="6" id="section_sync" class="section">sync</td></tr>
22893
22894
22895       <tr><td colspan="6" class="kind">dynamic</td></tr>
22896
22897       <thead class="entries_header">
22898         <tr>
22899           <th class="th_name">Property Name</th>
22900           <th class="th_type">Type</th>
22901           <th class="th_description">Description</th>
22902           <th class="th_units">Units</th>
22903           <th class="th_range">Range</th>
22904           <th class="th_tags">Tags</th>
22905         </tr>
22906       </thead>
22907
22908       <tbody>
22909
22910
22911
22912
22913
22914
22915
22916
22917
22918
22919           <tr class="entry" id="dynamic_android.sync.frameNumber">
22920             <td class="entry_name
22921              " rowspan="5">
22922               android.<wbr/>sync.<wbr/>frame<wbr/>Number
22923             </td>
22924             <td class="entry_type">
22925                 <span class="entry_type_name entry_type_name_enum">int64</span>
22926
22927               <span class="entry_type_visibility"> [hidden]</span>
22928
22929
22930               <span class="entry_type_hwlevel">[legacy] </span>
22931
22932
22933
22934                 <ul class="entry_type_enum">
22935                   <li>
22936                     <span class="entry_type_enum_name">CONVERGING</span>
22937                     <span class="entry_type_enum_value">-1</span>
22938                     <span class="entry_type_enum_notes"><p>The current result is not yet fully synchronized to any request.<wbr/></p>
22939 <p>Synchronization is in progress,<wbr/> and reading metadata from this
22940 result may include a mix of data that have taken effect since the
22941 last synchronization time.<wbr/></p>
22942 <p>In some future result,<wbr/> within <a href="#static_android.sync.maxLatency">android.<wbr/>sync.<wbr/>max<wbr/>Latency</a> frames,<wbr/>
22943 this value will update to the actual frame number frame number
22944 the result is guaranteed to be synchronized to (as long as the
22945 request settings remain constant).<wbr/></p></span>
22946                   </li>
22947                   <li>
22948                     <span class="entry_type_enum_name">UNKNOWN</span>
22949                     <span class="entry_type_enum_value">-2</span>
22950                     <span class="entry_type_enum_notes"><p>The current result's synchronization status is unknown.<wbr/></p>
22951 <p>The result may have already converged,<wbr/> or it may be in
22952 progress.<wbr/>  Reading from this result may include some mix
22953 of settings from past requests.<wbr/></p>
22954 <p>After a settings change,<wbr/> the new settings will eventually all
22955 take effect for the output buffers and results.<wbr/> However,<wbr/> this
22956 value will not change when that happens.<wbr/> Altering settings
22957 rapidly may provide outcomes using mixes of settings from recent
22958 requests.<wbr/></p>
22959 <p>This value is intended primarily for backwards compatibility with
22960 the older camera implementations (for android.<wbr/>hardware.<wbr/>Camera).<wbr/></p></span>
22961                   </li>
22962                 </ul>
22963
22964             </td> <!-- entry_type -->
22965
22966             <td class="entry_description">
22967               <p>The frame number corresponding to the last request
22968 with which the output result (metadata + buffers) has been fully
22969 synchronized.<wbr/></p>
22970             </td>
22971
22972             <td class="entry_units">
22973             </td>
22974
22975             <td class="entry_range">
22976               <p>Either a non-negative value corresponding to a
22977 <code>frame_<wbr/>number</code>,<wbr/> or one of the two enums (CONVERGING /<wbr/> UNKNOWN).<wbr/></p>
22978             </td>
22979
22980             <td class="entry_tags">
22981               <ul class="entry_tags">
22982                   <li><a href="#tag_V1">V1</a></li>
22983               </ul>
22984             </td>
22985
22986           </tr>
22987           <tr class="entries_header">
22988             <th class="th_details" colspan="5">Details</th>
22989           </tr>
22990           <tr class="entry_cont">
22991             <td class="entry_details" colspan="5">
22992               <p>When a request is submitted to the camera device,<wbr/> there is usually a
22993 delay of several frames before the controls get applied.<wbr/> A camera
22994 device may either choose to account for this delay by implementing a
22995 pipeline and carefully submit well-timed atomic control updates,<wbr/> or
22996 it may start streaming control changes that span over several frame
22997 boundaries.<wbr/></p>
22998 <p>In the latter case,<wbr/> whenever a request's settings change relative to
22999 the previous submitted request,<wbr/> the full set of changes may take
23000 multiple frame durations to fully take effect.<wbr/> Some settings may
23001 take effect sooner (in less frame durations) than others.<wbr/></p>
23002 <p>While a set of control changes are being propagated,<wbr/> this value
23003 will be CONVERGING.<wbr/></p>
23004 <p>Once it is fully known that a set of control changes have been
23005 finished propagating,<wbr/> and the resulting updated control settings
23006 have been read back by the camera device,<wbr/> this value will be set
23007 to a non-negative frame number (corresponding to the request to
23008 which the results have synchronized to).<wbr/></p>
23009 <p>Older camera device implementations may not have a way to detect
23010 when all camera controls have been applied,<wbr/> and will always set this
23011 value to UNKNOWN.<wbr/></p>
23012 <p>FULL capability devices will always have this value set to the
23013 frame number of the request corresponding to this result.<wbr/></p>
23014 <p><em>Further details</em>:</p>
23015 <ul>
23016 <li>Whenever a request differs from the last request,<wbr/> any future
23017 results not yet returned may have this value set to CONVERGING (this
23018 could include any in-progress captures not yet returned by the camera
23019 device,<wbr/> for more details see pipeline considerations below).<wbr/></li>
23020 <li>Submitting a series of multiple requests that differ from the
23021 previous request (e.<wbr/>g.<wbr/> r1,<wbr/> r2,<wbr/> r3 s.<wbr/>t.<wbr/> r1 != r2 != r3)
23022 moves the new synchronization frame to the last non-repeating
23023 request (using the smallest frame number from the contiguous list of
23024 repeating requests).<wbr/></li>
23025 <li>Submitting the same request repeatedly will not change this value
23026 to CONVERGING,<wbr/> if it was already a non-negative value.<wbr/></li>
23027 <li>When this value changes to non-negative,<wbr/> that means that all of the
23028 metadata controls from the request have been applied,<wbr/> all of the
23029 metadata controls from the camera device have been read to the
23030 updated values (into the result),<wbr/> and all of the graphics buffers
23031 corresponding to this result are also synchronized to the request.<wbr/></li>
23032 </ul>
23033 <p><em>Pipeline considerations</em>:</p>
23034 <p>Submitting a request with updated controls relative to the previously
23035 submitted requests may also invalidate the synchronization state
23036 of all the results corresponding to currently in-flight requests.<wbr/></p>
23037 <p>In other words,<wbr/> results for this current request and up to
23038 <a href="#static_android.request.pipelineMaxDepth">android.<wbr/>request.<wbr/>pipeline<wbr/>Max<wbr/>Depth</a> prior requests may have their
23039 <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> change to CONVERGING.<wbr/></p>
23040             </td>
23041           </tr>
23042
23043           <tr class="entries_header">
23044             <th class="th_details" colspan="5">HAL Implementation Details</th>
23045           </tr>
23046           <tr class="entry_cont">
23047             <td class="entry_details" colspan="5">
23048               <p>Using UNKNOWN here is illegal unless <a href="#static_android.sync.maxLatency">android.<wbr/>sync.<wbr/>max<wbr/>Latency</a>
23049 is also UNKNOWN.<wbr/></p>
23050 <p>FULL capability devices should simply set this value to the
23051 <code>frame_<wbr/>number</code> of the request this result corresponds to.<wbr/></p>
23052             </td>
23053           </tr>
23054
23055           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23056            <!-- end of entry -->
23057
23058
23059
23060       <!-- end of kind -->
23061       </tbody>
23062       <tr><td colspan="6" class="kind">static</td></tr>
23063
23064       <thead class="entries_header">
23065         <tr>
23066           <th class="th_name">Property Name</th>
23067           <th class="th_type">Type</th>
23068           <th class="th_description">Description</th>
23069           <th class="th_units">Units</th>
23070           <th class="th_range">Range</th>
23071           <th class="th_tags">Tags</th>
23072         </tr>
23073       </thead>
23074
23075       <tbody>
23076
23077
23078
23079
23080
23081
23082
23083
23084
23085
23086           <tr class="entry" id="static_android.sync.maxLatency">
23087             <td class="entry_name
23088              " rowspan="5">
23089               android.<wbr/>sync.<wbr/>max<wbr/>Latency
23090             </td>
23091             <td class="entry_type">
23092                 <span class="entry_type_name entry_type_name_enum">int32</span>
23093
23094               <span class="entry_type_visibility"> [public]</span>
23095
23096
23097               <span class="entry_type_hwlevel">[legacy] </span>
23098
23099
23100
23101                 <ul class="entry_type_enum">
23102                   <li>
23103                     <span class="entry_type_enum_name">PER_FRAME_CONTROL</span>
23104                     <span class="entry_type_enum_value">0</span>
23105                     <span class="entry_type_enum_notes"><p>Every frame has the requests immediately applied.<wbr/></p>
23106 <p>Furthermore for all results,<wbr/>
23107 <code><a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == CaptureResult#getFrameNumber()</code></p>
23108 <p>Changing controls over multiple requests one after another will
23109 produce results that have those controls applied atomically
23110 each frame.<wbr/></p>
23111 <p>All FULL capability devices will have this as their maxLatency.<wbr/></p></span>
23112                   </li>
23113                   <li>
23114                     <span class="entry_type_enum_name">UNKNOWN</span>
23115                     <span class="entry_type_enum_value">-1</span>
23116                     <span class="entry_type_enum_notes"><p>Each new frame has some subset (potentially the entire set)
23117 of the past requests applied to the camera settings.<wbr/></p>
23118 <p>By submitting a series of identical requests,<wbr/> the camera device
23119 will eventually have the camera settings applied,<wbr/> but it is
23120 unknown when that exact point will be.<wbr/></p>
23121 <p>All LEGACY capability devices will have this as their maxLatency.<wbr/></p></span>
23122                   </li>
23123                 </ul>
23124
23125             </td> <!-- entry_type -->
23126
23127             <td class="entry_description">
23128               <p>The maximum number of frames that can occur after a request
23129 (different than the previous) has been submitted,<wbr/> and before the
23130 result's state becomes synchronized (by setting
23131 <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> to a non-negative value).<wbr/></p>
23132             </td>
23133
23134             <td class="entry_units">
23135               Frame counts
23136             </td>
23137
23138             <td class="entry_range">
23139               <p>A positive value,<wbr/> PER_<wbr/>FRAME_<wbr/>CONTROL,<wbr/> or UNKNOWN.<wbr/></p>
23140             </td>
23141
23142             <td class="entry_tags">
23143               <ul class="entry_tags">
23144                   <li><a href="#tag_V1">V1</a></li>
23145               </ul>
23146             </td>
23147
23148           </tr>
23149           <tr class="entries_header">
23150             <th class="th_details" colspan="5">Details</th>
23151           </tr>
23152           <tr class="entry_cont">
23153             <td class="entry_details" colspan="5">
23154               <p>This defines the maximum distance (in number of metadata results),<wbr/>
23155 between <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> and the equivalent
23156 frame number for that result.<wbr/></p>
23157 <p>In other words this acts as an upper boundary for how many frames
23158 must occur before the camera device knows for a fact that the new
23159 submitted camera settings have been applied in outgoing frames.<wbr/></p>
23160 <p>For example if the distance was 2,<wbr/></p>
23161 <pre><code>initial request = X (repeating)
23162 request1 = X
23163 request2 = Y
23164 request3 = Y
23165 request4 = Y
23166
23167 where requestN has frameNumber N,<wbr/> and the first of the repeating
23168 initial request's has frameNumber F (and F &lt; 1).<wbr/>
23169
23170 initial result = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == F }
23171 result1 = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == F }
23172 result2 = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == CONVERGING }
23173 result3 = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == CONVERGING }
23174 result4 = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == 2 }
23175
23176 where resultN has frameNumber N.<wbr/>
23177 </code></pre>
23178 <p>Since <code>result4</code> has a <code>frameNumber == 4</code> and
23179 <code><a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == 2</code>,<wbr/> the distance is clearly
23180 <code>4 - 2 = 2</code>.<wbr/></p>
23181             </td>
23182           </tr>
23183
23184           <tr class="entries_header">
23185             <th class="th_details" colspan="5">HAL Implementation Details</th>
23186           </tr>
23187           <tr class="entry_cont">
23188             <td class="entry_details" colspan="5">
23189               <p>Use <code>frame_<wbr/>count</code> from camera3_<wbr/>request_<wbr/>t instead of
23190 <a href="#controls_android.request.frameCount">android.<wbr/>request.<wbr/>frame<wbr/>Count</a> or <code>CaptureResult#getFrameNumber()</code>.<wbr/></p>
23191 <p>LIMITED devices are strongly encouraged to use a non-negative
23192 value.<wbr/> If UNKNOWN is used here then app developers do not have a way
23193 to know when sensor settings have been applied.<wbr/></p>
23194             </td>
23195           </tr>
23196
23197           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23198            <!-- end of entry -->
23199
23200
23201
23202       <!-- end of kind -->
23203       </tbody>
23204
23205   <!-- end of section -->
23206 <!-- </namespace> -->
23207   </table>
23208
23209   <div class="tags" id="tag_index">
23210     <h2>Tags</h2>
23211     <ul>
23212       <li id="tag_BC">BC -
23213         Needed for backwards compatibility with old Java API
23214
23215         <ul class="tags_entries">
23216           <li><a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> (controls)</li>
23217           <li><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> (controls)</li>
23218           <li><a href="#controls_android.control.aeLock">android.control.aeLock</a> (controls)</li>
23219           <li><a href="#controls_android.control.aeMode">android.control.aeMode</a> (controls)</li>
23220           <li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a> (controls)</li>
23221           <li><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> (controls)</li>
23222           <li><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> (controls)</li>
23223           <li><a href="#controls_android.control.afMode">android.control.afMode</a> (controls)</li>
23224           <li><a href="#controls_android.control.afRegions">android.control.afRegions</a> (controls)</li>
23225           <li><a href="#controls_android.control.afTrigger">android.control.afTrigger</a> (controls)</li>
23226           <li><a href="#controls_android.control.awbLock">android.control.awbLock</a> (controls)</li>
23227           <li><a href="#controls_android.control.awbMode">android.control.awbMode</a> (controls)</li>
23228           <li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a> (controls)</li>
23229           <li><a href="#controls_android.control.captureIntent">android.control.captureIntent</a> (controls)</li>
23230           <li><a href="#controls_android.control.effectMode">android.control.effectMode</a> (controls)</li>
23231           <li><a href="#controls_android.control.mode">android.control.mode</a> (controls)</li>
23232           <li><a href="#controls_android.control.sceneMode">android.control.sceneMode</a> (controls)</li>
23233           <li><a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a> (controls)</li>
23234           <li><a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a> (static)</li>
23235           <li><a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a> (static)</li>
23236           <li><a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a> (static)</li>
23237           <li><a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a> (static)</li>
23238           <li><a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a> (static)</li>
23239           <li><a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a> (static)</li>
23240           <li><a href="#static_android.control.availableEffects">android.control.availableEffects</a> (static)</li>
23241           <li><a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a> (static)</li>
23242           <li><a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a> (static)</li>
23243           <li><a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a> (static)</li>
23244           <li><a href="#static_android.control.maxRegions">android.control.maxRegions</a> (static)</li>
23245           <li><a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a> (static)</li>
23246           <li><a href="#controls_android.flash.mode">android.flash.mode</a> (controls)</li>
23247           <li><a href="#static_android.flash.info.available">android.flash.info.available</a> (static)</li>
23248           <li><a href="#controls_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a> (controls)</li>
23249           <li><a href="#controls_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a> (controls)</li>
23250           <li><a href="#controls_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a> (controls)</li>
23251           <li><a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a> (controls)</li>
23252           <li><a href="#controls_android.jpeg.quality">android.jpeg.quality</a> (controls)</li>
23253           <li><a href="#controls_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a> (controls)</li>
23254           <li><a href="#controls_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a> (controls)</li>
23255           <li><a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a> (static)</li>
23256           <li><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> (controls)</li>
23257           <li><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a> (static)</li>
23258           <li><a href="#dynamic_android.lens.focusRange">android.lens.focusRange</a> (dynamic)</li>
23259           <li><a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a> (static)</li>
23260           <li><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> (controls)</li>
23261           <li><a href="#static_android.scaler.availableFormats">android.scaler.availableFormats</a> (static)</li>
23262           <li><a href="#static_android.scaler.availableJpegMinDurations">android.scaler.availableJpegMinDurations</a> (static)</li>
23263           <li><a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a> (static)</li>
23264           <li><a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> (static)</li>
23265           <li><a href="#static_android.scaler.availableProcessedMinDurations">android.scaler.availableProcessedMinDurations</a> (static)</li>
23266           <li><a href="#static_android.scaler.availableProcessedSizes">android.scaler.availableProcessedSizes</a> (static)</li>
23267           <li><a href="#static_android.scaler.availableRawMinDurations">android.scaler.availableRawMinDurations</a> (static)</li>
23268           <li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> (static)</li>
23269           <li><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> (static)</li>
23270           <li><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> (static)</li>
23271           <li><a href="#static_android.sensor.orientation">android.sensor.orientation</a> (static)</li>
23272           <li><a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a> (dynamic)</li>
23273           <li><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> (controls)</li>
23274           <li><a href="#static_android.statistics.info.maxFaceCount">android.statistics.info.maxFaceCount</a> (static)</li>
23275           <li><a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a> (dynamic)</li>
23276           <li><a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a> (dynamic)</li>
23277           <li><a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a> (dynamic)</li>
23278           <li><a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a> (dynamic)</li>
23279           <li><a href="#dynamic_android.lens.focalLength">android.lens.focalLength</a> (dynamic)</li>
23280           <li><a href="#dynamic_android.lens.focusDistance">android.lens.focusDistance</a> (dynamic)</li>
23281         </ul>
23282       </li> <!-- tag_BC -->
23283       <li id="tag_V1">V1 -
23284         New features for first camera 2 release (API1)
23285
23286         <ul class="tags_entries">
23287           <li><a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a> (static)</li>
23288           <li><a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a> (static)</li>
23289           <li><a href="#controls_android.edge.mode">android.edge.mode</a> (controls)</li>
23290           <li><a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a> (static)</li>
23291           <li><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a> (controls)</li>
23292           <li><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a> (static)</li>
23293           <li><a href="#controls_android.lens.aperture">android.lens.aperture</a> (controls)</li>
23294           <li><a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> (controls)</li>
23295           <li><a href="#controls_android.lens.focalLength">android.lens.focalLength</a> (controls)</li>
23296           <li><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> (controls)</li>
23297           <li><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (controls)</li>
23298           <li><a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a> (static)</li>
23299           <li><a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a> (static)</li>
23300           <li><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a> (static)</li>
23301           <li><a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a> (static)</li>
23302           <li><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> (static)</li>
23303           <li><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a> (static)</li>
23304           <li><a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a> (static)</li>
23305           <li><a href="#dynamic_android.lens.state">android.lens.state</a> (dynamic)</li>
23306           <li><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a> (controls)</li>
23307           <li><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a> (static)</li>
23308           <li><a href="#controls_android.request.id">android.request.id</a> (controls)</li>
23309           <li><a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a> (static)</li>
23310           <li><a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a> (static)</li>
23311           <li><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a> (controls)</li>
23312           <li><a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> (controls)</li>
23313           <li><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> (controls)</li>
23314           <li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> (static)</li>
23315           <li><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a> (static)</li>
23316           <li><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a> (static)</li>
23317           <li><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> (static)</li>
23318           <li><a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> (static)</li>
23319           <li><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a> (static)</li>
23320           <li><a href="#dynamic_android.sensor.rollingShutterSkew">android.sensor.rollingShutterSkew</a> (dynamic)</li>
23321           <li><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a> (controls)</li>
23322           <li><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a> (static)</li>
23323           <li><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a> (dynamic)</li>
23324           <li><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> (dynamic)</li>
23325           <li><a href="#static_android.sync.maxLatency">android.sync.maxLatency</a> (static)</li>
23326           <li><a href="#dynamic_android.edge.mode">android.edge.mode</a> (dynamic)</li>
23327           <li><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a> (dynamic)</li>
23328           <li><a href="#dynamic_android.lens.aperture">android.lens.aperture</a> (dynamic)</li>
23329           <li><a href="#dynamic_android.lens.filterDensity">android.lens.filterDensity</a> (dynamic)</li>
23330           <li><a href="#dynamic_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (dynamic)</li>
23331           <li><a href="#dynamic_android.noiseReduction.mode">android.noiseReduction.mode</a> (dynamic)</li>
23332         </ul>
23333       </li> <!-- tag_V1 -->
23334       <li id="tag_RAW">RAW -
23335         Needed for useful RAW image processing and DNG file support
23336
23337         <ul class="tags_entries">
23338           <li><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a> (controls)</li>
23339           <li><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a> (static)</li>
23340           <li><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> (static)</li>
23341           <li><a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a> (static)</li>
23342           <li><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> (static)</li>
23343           <li><a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a> (static)</li>
23344           <li><a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a> (static)</li>
23345           <li><a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a> (static)</li>
23346           <li><a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a> (static)</li>
23347           <li><a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a> (static)</li>
23348           <li><a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a> (static)</li>
23349           <li><a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a> (static)</li>
23350           <li><a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a> (static)</li>
23351           <li><a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a> (static)</li>
23352           <li><a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a> (static)</li>
23353           <li><a href="#static_android.sensor.profileHueSatMapDimensions">android.sensor.profileHueSatMapDimensions</a> (static)</li>
23354           <li><a href="#dynamic_android.sensor.neutralColorPoint">android.sensor.neutralColorPoint</a> (dynamic)</li>
23355           <li><a href="#dynamic_android.sensor.noiseProfile">android.sensor.noiseProfile</a> (dynamic)</li>
23356           <li><a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a> (dynamic)</li>
23357           <li><a href="#dynamic_android.sensor.profileToneCurve">android.sensor.profileToneCurve</a> (dynamic)</li>
23358           <li><a href="#dynamic_android.sensor.greenSplit">android.sensor.greenSplit</a> (dynamic)</li>
23359           <li><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a> (controls)</li>
23360           <li><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a> (static)</li>
23361           <li><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a> (dynamic)</li>
23362           <li><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> (controls)</li>
23363           <li><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a> (dynamic)</li>
23364         </ul>
23365       </li> <!-- tag_RAW -->
23366       <li id="tag_HAL2">HAL2 -
23367         Entry is only used by camera device HAL 2.x
23368
23369         <ul class="tags_entries">
23370           <li><a href="#controls_android.request.inputStreams">android.request.inputStreams</a> (controls)</li>
23371           <li><a href="#controls_android.request.outputStreams">android.request.outputStreams</a> (controls)</li>
23372           <li><a href="#controls_android.request.type">android.request.type</a> (controls)</li>
23373           <li><a href="#static_android.request.maxNumReprocessStreams">android.request.maxNumReprocessStreams</a> (static)</li>
23374           <li><a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a> (controls)</li>
23375         </ul>
23376       </li> <!-- tag_HAL2 -->
23377       <li id="tag_FULL">FULL -
23378         Entry is required for full hardware level devices, and optional for other hardware levels
23379
23380         <ul class="tags_entries">
23381           <li><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a> (static)</li>
23382         </ul>
23383       </li> <!-- tag_FULL -->
23384       <li id="tag_FUTURE">FUTURE -
23385         Entry is  under-specified and is not required for now. This is for book-keeping purpose,
23386         do not implement or use it, it may be revised for future.
23387
23388         <ul class="tags_entries">
23389           <li><a href="#controls_android.demosaic.mode">android.demosaic.mode</a> (controls)</li>
23390           <li><a href="#controls_android.edge.strength">android.edge.strength</a> (controls)</li>
23391           <li><a href="#controls_android.flash.firingPower">android.flash.firingPower</a> (controls)</li>
23392           <li><a href="#controls_android.flash.firingTime">android.flash.firingTime</a> (controls)</li>
23393           <li><a href="#static_android.flash.info.chargeDuration">android.flash.info.chargeDuration</a> (static)</li>
23394           <li><a href="#static_android.flash.colorTemperature">android.flash.colorTemperature</a> (static)</li>
23395           <li><a href="#static_android.flash.maxEnergy">android.flash.maxEnergy</a> (static)</li>
23396           <li><a href="#dynamic_android.jpeg.size">android.jpeg.size</a> (dynamic)</li>
23397           <li><a href="#static_android.lens.opticalAxisAngle">android.lens.opticalAxisAngle</a> (static)</li>
23398           <li><a href="#static_android.lens.position">android.lens.position</a> (static)</li>
23399           <li><a href="#controls_android.noiseReduction.strength">android.noiseReduction.strength</a> (controls)</li>
23400           <li><a href="#controls_android.request.metadataMode">android.request.metadataMode</a> (controls)</li>
23401           <li><a href="#static_android.sensor.baseGainFactor">android.sensor.baseGainFactor</a> (static)</li>
23402           <li><a href="#dynamic_android.sensor.temperature">android.sensor.temperature</a> (dynamic)</li>
23403           <li><a href="#controls_android.shading.strength">android.shading.strength</a> (controls)</li>
23404           <li><a href="#controls_android.statistics.histogramMode">android.statistics.histogramMode</a> (controls)</li>
23405           <li><a href="#controls_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a> (controls)</li>
23406           <li><a href="#static_android.statistics.info.histogramBucketCount">android.statistics.info.histogramBucketCount</a> (static)</li>
23407           <li><a href="#static_android.statistics.info.maxHistogramCount">android.statistics.info.maxHistogramCount</a> (static)</li>
23408           <li><a href="#static_android.statistics.info.maxSharpnessMapValue">android.statistics.info.maxSharpnessMapValue</a> (static)</li>
23409           <li><a href="#static_android.statistics.info.sharpnessMapSize">android.statistics.info.sharpnessMapSize</a> (static)</li>
23410           <li><a href="#dynamic_android.statistics.histogram">android.statistics.histogram</a> (dynamic)</li>
23411           <li><a href="#dynamic_android.statistics.sharpnessMap">android.statistics.sharpnessMap</a> (dynamic)</li>
23412         </ul>
23413       </li> <!-- tag_FUTURE -->
23414     </ul>
23415   </div>
23416
23417   [ <a href="#">top</a> ]
23418
23419 </body>
23420 </html>