docs.html - Android社区 - https://www.androidos.net.cn/

<!DOCTYPE html>
<html>
<!-- Copyright (C) 2012 The Android Open Source Project

Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-->
<head>
 
 <meta charset="utf-8" />
 <title>Android Camera HAL3.2 Properties</title>
 <style type="text/css">
 body { background-color: #f7f7f7; font-family: Roboto, sans-serif;}
 h1 { color: #333333; }
 h2 { color: #333333; }
 a:link { color: #258aaf; text-decoration: none}
 a:hover { color: #459aaf; text-decoration: underline }
 a:visited { color: #154a5f; text-decoration: none}
 .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}
 .kind { color: #eeeeee; font-size: 1.2em; font-weight: bold; padding-left: 1.5em; background-color: #aaaaaa }
 .entry { background-color: #f0f0f0 }
 .entry_cont { background-color: #f0f0f0 }
 .entries_header { background-color: #dddddd; text-align: center}

/* toc style */
    .toc_section_header { font-size:1.3em;  }
    .toc_kind_header { font-size:1.2em;  }
    .toc_deprecated { text-decoration:line-through; }

/* table column sizes */
    table { border-collapse:collapse; table-layout: fixed; width: 100%; word-wrap: break-word }
    td,th { border: 1px solid; border-color: #aaaaaa; padding-left: 0.5em; padding-right: 0.5em }
    .th_name { width: 20% }
    .th_units { width: 10% }
    .th_tags { width: 5% }
    .th_details { width: 25% }
    .th_type { width: 20% }
    .th_description { width: 20% }
    .th_range { width: 10% }
    td { font-size: 0.9em; }

/* hide the first thead, we need it there only to enforce column sizes */
    .thead_dummy { visibility: hidden; }

/* Entry flair */
    .entry_name { color: #333333; padding-left:1.0em; font-size:1.1em; font-family: monospace; vertical-align:top; }
    .entry_name_deprecated { text-decoration:line-through; }

/* Entry type flair */
    .entry_type_name { font-size:1.1em; color: #669900; font-weight: bold;}
    .entry_type_name_enum:after { color: #669900; font-weight: bold; content:" (enum)" }
    .entry_type_visibility { font-weight: bolder; padding-left:1em}
    .entry_type_synthetic { font-weight: bolder; color: #996600; }
    .entry_type_hwlevel { font-weight: bolder; color: #000066; }
    .entry_type_deprecated { font-weight: bolder; color: #4D4D4D; }
    .entry_type_enum_name { font-family: monospace; font-weight: bolder; }
    .entry_type_enum_notes:before { content:" - " }
    .entry_type_enum_notes>p:first-child { display:inline; }
    .entry_type_enum_value:before { content:" = " }
    .entry_type_enum_value { font-family: monospace; }
    .entry ul { margin: 0 0 0 0; list-style-position: inside; padding-left: 0.5em; }
    .entry ul li { padding: 0 0 0 0; margin: 0 0 0 0;}
    .entry_range_deprecated { font-weight: bolder; }

/* Entry tags flair */
    .entry_tags ul { list-style-type: none; }

/* Entry details (full docs) flair */
    .entry_details_header { font-weight: bold; background-color: #dddddd;
      text-align: center; font-size: 1.1em; margin-left: 0em; margin-right: 0em; }

/* Entry spacer flair */
    .entry_spacer { background-color: transparent; border-style: none; height: 0.5em; }

/* TODO: generate abbr element for each tag link? */
    /* TODO for each x.y.z try to link it to the entry */

</style>

<style>

{
      /* broken...
         supposedly there is a bug in chrome that it lays out tables before
         it knows its being printed, so the page-break-* styles are ignored
         */
        tr { page-break-after: always; page-break-inside: avoid; }
    }

</style>
</head>

<body>
 <h1>Android Camera HAL3.2 Properties</h1>

<h2>Table of Contents</h2>
 <ul class="toc">
 <li><a href="#tag_index" class="toc_section_header">Tags</a></li>
 <li>
 <a href="#section_colorCorrection">colorCorrection</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a></li>
 <li
 ><a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a></li>
 <li
 ><a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a></li>
 <li
 ><a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.colorCorrection.mode">android.colorCorrection.mode</a></li>
 <li
 ><a href="#dynamic_android.colorCorrection.transform">android.colorCorrection.transform</a></li>
 <li
 ><a href="#dynamic_android.colorCorrection.gains">android.colorCorrection.gains</a></li>
 <li
 ><a href="#dynamic_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">
 <li
 ><a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_control">control</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a></li>
 <li
 ><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>
 <li
 ><a href="#controls_android.control.aeLock">android.control.aeLock</a></li>
 <li
 ><a href="#controls_android.control.aeMode">android.control.aeMode</a></li>
 <li
 ><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>
 <li
 ><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>
 <li
 ><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>
 <li
 ><a href="#controls_android.control.afMode">android.control.afMode</a></li>
 <li
 ><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>
 <li
 ><a href="#controls_android.control.afTrigger">android.control.afTrigger</a></li>
 <li
 ><a href="#controls_android.control.awbLock">android.control.awbLock</a></li>
 <li
 ><a href="#controls_android.control.awbMode">android.control.awbMode</a></li>
 <li
 ><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>
 <li
 ><a href="#controls_android.control.captureIntent">android.control.captureIntent</a></li>
 <li
 ><a href="#controls_android.control.effectMode">android.control.effectMode</a></li>
 <li
 ><a href="#controls_android.control.mode">android.control.mode</a></li>
 <li
 ><a href="#controls_android.control.sceneMode">android.control.sceneMode</a></li>
 <li
 ><a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">
 <li
 ><a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a></li>
 <li
 ><a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a></li>
 <li
 ><a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a></li>
 <li
 ><a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a></li>
 <li
 ><a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a></li>
 <li
 ><a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a></li>
 <li
 ><a href="#static_android.control.availableEffects">android.control.availableEffects</a></li>
 <li
 ><a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a></li>
 <li
 ><a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a></li>
 <li
 ><a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a></li>
 <li
 ><a href="#static_android.control.maxRegions">android.control.maxRegions</a></li>
 <li
 ><a href="#static_android.control.maxRegionsAe">android.control.maxRegionsAe</a></li>
 <li
 ><a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a></li>
 <li
 ><a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a></li>
 <li
 ><a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a></li>
 <li
 ><a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 class="toc_deprecated"
 ><a href="#dynamic_android.control.aePrecaptureId">android.control.aePrecaptureId</a></li>
 <li
 ><a href="#dynamic_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a></li>
 <li
 ><a href="#dynamic_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>
 <li
 ><a href="#dynamic_android.control.aeLock">android.control.aeLock</a></li>
 <li
 ><a href="#dynamic_android.control.aeMode">android.control.aeMode</a></li>
 <li
 ><a href="#dynamic_android.control.aeRegions">android.control.aeRegions</a></li>
 <li
 ><a href="#dynamic_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>
 <li
 ><a href="#dynamic_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>
 <li
 ><a href="#dynamic_android.control.aeState">android.control.aeState</a></li>
 <li
 ><a href="#dynamic_android.control.afMode">android.control.afMode</a></li>
 <li
 ><a href="#dynamic_android.control.afRegions">android.control.afRegions</a></li>
 <li
 ><a href="#dynamic_android.control.afTrigger">android.control.afTrigger</a></li>
 <li
 ><a href="#dynamic_android.control.afState">android.control.afState</a></li>
 <li
 class="toc_deprecated"
 ><a href="#dynamic_android.control.afTriggerId">android.control.afTriggerId</a></li>
 <li
 ><a href="#dynamic_android.control.awbLock">android.control.awbLock</a></li>
 <li
 ><a href="#dynamic_android.control.awbMode">android.control.awbMode</a></li>
 <li
 ><a href="#dynamic_android.control.awbRegions">android.control.awbRegions</a></li>
 <li
 ><a href="#dynamic_android.control.captureIntent">android.control.captureIntent</a></li>
 <li
 ><a href="#dynamic_android.control.awbState">android.control.awbState</a></li>
 <li
 ><a href="#dynamic_android.control.effectMode">android.control.effectMode</a></li>
 <li
 ><a href="#dynamic_android.control.mode">android.control.mode</a></li>
 <li
 ><a href="#dynamic_android.control.sceneMode">android.control.sceneMode</a></li>
 <li
 ><a href="#dynamic_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_demosaic">demosaic</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.demosaic.mode">android.demosaic.mode</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_edge">edge</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.edge.mode">android.edge.mode</a></li>
 <li
 ><a href="#controls_android.edge.strength">android.edge.strength</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">
 <li
 ><a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.edge.mode">android.edge.mode</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_flash">flash</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.flash.firingPower">android.flash.firingPower</a></li>
 <li
 ><a href="#controls_android.flash.firingTime">android.flash.firingTime</a></li>
 <li
 ><a href="#controls_android.flash.mode">android.flash.mode</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">

<li
 ><a href="#static_android.flash.info.available">android.flash.info.available</a></li>
 <li
 ><a href="#static_android.flash.info.chargeDuration">android.flash.info.chargeDuration</a></li>

<li
 ><a href="#static_android.flash.colorTemperature">android.flash.colorTemperature</a></li>
 <li
 ><a href="#static_android.flash.maxEnergy">android.flash.maxEnergy</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.flash.firingPower">android.flash.firingPower</a></li>
 <li
 ><a href="#dynamic_android.flash.firingTime">android.flash.firingTime</a></li>
 <li
 ><a href="#dynamic_android.flash.mode">android.flash.mode</a></li>
 <li
 ><a href="#dynamic_android.flash.state">android.flash.state</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_hotPixel">hotPixel</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">
 <li
 ><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_jpeg">jpeg</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.jpeg.gpsLocation">android.jpeg.gpsLocation</a></li>
 <li
 ><a href="#controls_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a></li>
 <li
 ><a href="#controls_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a></li>
 <li
 ><a href="#controls_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a></li>
 <li
 ><a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a></li>
 <li
 ><a href="#controls_android.jpeg.quality">android.jpeg.quality</a></li>
 <li
 ><a href="#controls_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a></li>
 <li
 ><a href="#controls_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">
 <li
 ><a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a></li>
 <li
 ><a href="#static_android.jpeg.maxSize">android.jpeg.maxSize</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.jpeg.gpsLocation">android.jpeg.gpsLocation</a></li>
 <li
 ><a href="#dynamic_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a></li>
 <li
 ><a href="#dynamic_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a></li>
 <li
 ><a href="#dynamic_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a></li>
 <li
 ><a href="#dynamic_android.jpeg.orientation">android.jpeg.orientation</a></li>
 <li
 ><a href="#dynamic_android.jpeg.quality">android.jpeg.quality</a></li>
 <li
 ><a href="#dynamic_android.jpeg.size">android.jpeg.size</a></li>
 <li
 ><a href="#dynamic_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a></li>
 <li
 ><a href="#dynamic_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_lens">lens</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.lens.aperture">android.lens.aperture</a></li>
 <li
 ><a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a></li>
 <li
 ><a href="#controls_android.lens.focalLength">android.lens.focalLength</a></li>
 <li
 ><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a></li>
 <li
 ><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">

<li
 ><a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a></li>
 <li
 ><a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a></li>
 <li
 ><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a></li>
 <li
 ><a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a></li>
 <li
 ><a href="#static_android.lens.info.hyperfocalDistance">android.lens.info.hyperfocalDistance</a></li>
 <li
 ><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a></li>
 <li
 ><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a></li>
 <li
 ><a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a></li>

<li
 ><a href="#static_android.lens.facing">android.lens.facing</a></li>
 <li
 ><a href="#static_android.lens.opticalAxisAngle">android.lens.opticalAxisAngle</a></li>
 <li
 ><a href="#static_android.lens.position">android.lens.position</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.lens.aperture">android.lens.aperture</a></li>
 <li
 ><a href="#dynamic_android.lens.filterDensity">android.lens.filterDensity</a></li>
 <li
 ><a href="#dynamic_android.lens.focalLength">android.lens.focalLength</a></li>
 <li
 ><a href="#dynamic_android.lens.focusDistance">android.lens.focusDistance</a></li>
 <li
 ><a href="#dynamic_android.lens.focusRange">android.lens.focusRange</a></li>
 <li
 ><a href="#dynamic_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a></li>
 <li
 ><a href="#dynamic_android.lens.state">android.lens.state</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_noiseReduction">noiseReduction</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a></li>
 <li
 ><a href="#controls_android.noiseReduction.strength">android.noiseReduction.strength</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">
 <li
 ><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.noiseReduction.mode">android.noiseReduction.mode</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_quirks">quirks</a>
 <ul class="toc_section">
 <li>
 static
 <ul class="toc_section">
 <li
 class="toc_deprecated"
 ><a href="#static_android.quirks.meteringCropRegion">android.quirks.meteringCropRegion</a></li>
 <li
 class="toc_deprecated"
 ><a href="#static_android.quirks.triggerAfWithAuto">android.quirks.triggerAfWithAuto</a></li>
 <li
 class="toc_deprecated"
 ><a href="#static_android.quirks.useZslFormat">android.quirks.useZslFormat</a></li>
 <li
 class="toc_deprecated"
 ><a href="#static_android.quirks.usePartialResult">android.quirks.usePartialResult</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 class="toc_deprecated"
 ><a href="#dynamic_android.quirks.partialResult">android.quirks.partialResult</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_request">request</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 class="toc_deprecated"
 ><a href="#controls_android.request.frameCount">android.request.frameCount</a></li>
 <li
 ><a href="#controls_android.request.id">android.request.id</a></li>
 <li
 class="toc_deprecated"
 ><a href="#controls_android.request.inputStreams">android.request.inputStreams</a></li>
 <li
 ><a href="#controls_android.request.metadataMode">android.request.metadataMode</a></li>
 <li
 class="toc_deprecated"
 ><a href="#controls_android.request.outputStreams">android.request.outputStreams</a></li>
 <li
 class="toc_deprecated"
 ><a href="#controls_android.request.type">android.request.type</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">
 <li
 ><a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a></li>
 <li
 ><a href="#static_android.request.maxNumOutputRaw">android.request.maxNumOutputRaw</a></li>
 <li
 ><a href="#static_android.request.maxNumOutputProc">android.request.maxNumOutputProc</a></li>
 <li
 ><a href="#static_android.request.maxNumOutputProcStalling">android.request.maxNumOutputProcStalling</a></li>
 <li
 class="toc_deprecated"
 ><a href="#static_android.request.maxNumReprocessStreams">android.request.maxNumReprocessStreams</a></li>
 <li
 ><a href="#static_android.request.maxNumInputStreams">android.request.maxNumInputStreams</a></li>
 <li
 ><a href="#static_android.request.pipelineMaxDepth">android.request.pipelineMaxDepth</a></li>
 <li
 ><a href="#static_android.request.partialResultCount">android.request.partialResultCount</a></li>
 <li
 ><a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a></li>
 <li
 ><a href="#static_android.request.availableRequestKeys">android.request.availableRequestKeys</a></li>
 <li
 ><a href="#static_android.request.availableResultKeys">android.request.availableResultKeys</a></li>
 <li
 ><a href="#static_android.request.availableCharacteristicsKeys">android.request.availableCharacteristicsKeys</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 class="toc_deprecated"
 ><a href="#dynamic_android.request.frameCount">android.request.frameCount</a></li>
 <li
 ><a href="#dynamic_android.request.id">android.request.id</a></li>
 <li
 ><a href="#dynamic_android.request.metadataMode">android.request.metadataMode</a></li>
 <li
 class="toc_deprecated"
 ><a href="#dynamic_android.request.outputStreams">android.request.outputStreams</a></li>
 <li
 ><a href="#dynamic_android.request.pipelineDepth">android.request.pipelineDepth</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_scaler">scaler</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">
 <li
 class="toc_deprecated"
 ><a href="#static_android.scaler.availableFormats">android.scaler.availableFormats</a></li>
 <li
 class="toc_deprecated"
 ><a href="#static_android.scaler.availableJpegMinDurations">android.scaler.availableJpegMinDurations</a></li>
 <li
 class="toc_deprecated"
 ><a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a></li>
 <li
 ><a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a></li>
 <li
 class="toc_deprecated"
 ><a href="#static_android.scaler.availableProcessedMinDurations">android.scaler.availableProcessedMinDurations</a></li>
 <li
 class="toc_deprecated"
 ><a href="#static_android.scaler.availableProcessedSizes">android.scaler.availableProcessedSizes</a></li>
 <li
 class="toc_deprecated"
 ><a href="#static_android.scaler.availableRawMinDurations">android.scaler.availableRawMinDurations</a></li>
 <li
 class="toc_deprecated"
 ><a href="#static_android.scaler.availableRawSizes">android.scaler.availableRawSizes</a></li>
 <li
 ><a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a></li>
 <li
 ><a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a></li>
 <li
 ><a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a></li>
 <li
 ><a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a></li>
 <li
 ><a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a></li>
 <li
 ><a href="#static_android.scaler.croppingType">android.scaler.croppingType</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.scaler.cropRegion">android.scaler.cropRegion</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_sensor">sensor</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a></li>
 <li
 ><a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a></li>
 <li
 ><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a></li>
 <li
 ><a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a></li>
 <li
 ><a href="#controls_android.sensor.testPatternMode">android.sensor.testPatternMode</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">

<li
 ><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a></li>
 <li
 ><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a></li>
 <li
 ><a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a></li>
 <li
 ><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a></li>
 <li
 ><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a></li>
 <li
 ><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a></li>
 <li
 ><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a></li>
 <li
 ><a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a></li>
 <li
 ><a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a></li>

<li
 ><a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a></li>
 <li
 ><a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a></li>
 <li
 ><a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a></li>
 <li
 ><a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a></li>
 <li
 ><a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a></li>
 <li
 ><a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a></li>
 <li
 ><a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a></li>
 <li
 ><a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a></li>
 <li
 ><a href="#static_android.sensor.baseGainFactor">android.sensor.baseGainFactor</a></li>
 <li
 ><a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a></li>
 <li
 ><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a></li>
 <li
 ><a href="#static_android.sensor.orientation">android.sensor.orientation</a></li>
 <li
 ><a href="#static_android.sensor.profileHueSatMapDimensions">android.sensor.profileHueSatMapDimensions</a></li>
 <li
 ><a href="#static_android.sensor.availableTestPatternModes">android.sensor.availableTestPatternModes</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.sensor.exposureTime">android.sensor.exposureTime</a></li>
 <li
 ><a href="#dynamic_android.sensor.frameDuration">android.sensor.frameDuration</a></li>
 <li
 ><a href="#dynamic_android.sensor.sensitivity">android.sensor.sensitivity</a></li>
 <li
 ><a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a></li>
 <li
 ><a href="#dynamic_android.sensor.temperature">android.sensor.temperature</a></li>
 <li
 ><a href="#dynamic_android.sensor.neutralColorPoint">android.sensor.neutralColorPoint</a></li>
 <li
 ><a href="#dynamic_android.sensor.noiseProfile">android.sensor.noiseProfile</a></li>
 <li
 ><a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a></li>
 <li
 ><a href="#dynamic_android.sensor.profileToneCurve">android.sensor.profileToneCurve</a></li>
 <li
 ><a href="#dynamic_android.sensor.greenSplit">android.sensor.greenSplit</a></li>
 <li
 ><a href="#dynamic_android.sensor.testPatternData">android.sensor.testPatternData</a></li>
 <li
 ><a href="#dynamic_android.sensor.testPatternMode">android.sensor.testPatternMode</a></li>
 <li
 ><a href="#dynamic_android.sensor.rollingShutterSkew">android.sensor.rollingShutterSkew</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_shading">shading</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.shading.mode">android.shading.mode</a></li>
 <li
 ><a href="#controls_android.shading.strength">android.shading.strength</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.shading.mode">android.shading.mode</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_statistics">statistics</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>
 <li
 ><a href="#controls_android.statistics.histogramMode">android.statistics.histogramMode</a></li>
 <li
 ><a href="#controls_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a></li>
 <li
 ><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a></li>
 <li
 ><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">

<li
 ><a href="#static_android.statistics.info.availableFaceDetectModes">android.statistics.info.availableFaceDetectModes</a></li>
 <li
 ><a href="#static_android.statistics.info.histogramBucketCount">android.statistics.info.histogramBucketCount</a></li>
 <li
 ><a href="#static_android.statistics.info.maxFaceCount">android.statistics.info.maxFaceCount</a></li>
 <li
 ><a href="#static_android.statistics.info.maxHistogramCount">android.statistics.info.maxHistogramCount</a></li>
 <li
 ><a href="#static_android.statistics.info.maxSharpnessMapValue">android.statistics.info.maxSharpnessMapValue</a></li>
 <li
 ><a href="#static_android.statistics.info.sharpnessMapSize">android.statistics.info.sharpnessMapSize</a></li>
 <li
 ><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a></li>

</ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>
 <li
 ><a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a></li>
 <li
 ><a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a></li>
 <li
 ><a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a></li>
 <li
 ><a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a></li>
 <li
 ><a href="#dynamic_android.statistics.faces">android.statistics.faces</a></li>
 <li
 ><a href="#dynamic_android.statistics.histogram">android.statistics.histogram</a></li>
 <li
 ><a href="#dynamic_android.statistics.histogramMode">android.statistics.histogramMode</a></li>
 <li
 ><a href="#dynamic_android.statistics.sharpnessMap">android.statistics.sharpnessMap</a></li>
 <li
 ><a href="#dynamic_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a></li>
 <li
 ><a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a></li>
 <li
 ><a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a></li>
 <li
 class="toc_deprecated"
 ><a href="#dynamic_android.statistics.predictedColorGains">android.statistics.predictedColorGains</a></li>
 <li
 class="toc_deprecated"
 ><a href="#dynamic_android.statistics.predictedColorTransform">android.statistics.predictedColorTransform</a></li>
 <li
 ><a href="#dynamic_android.statistics.sceneFlicker">android.statistics.sceneFlicker</a></li>
 <li
 ><a href="#dynamic_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a></li>
 <li
 ><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a></li>
 <li
 ><a href="#dynamic_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_tonemap">tonemap</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.tonemap.curveBlue">android.tonemap.curveBlue</a></li>
 <li
 ><a href="#controls_android.tonemap.curveGreen">android.tonemap.curveGreen</a></li>
 <li
 ><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a></li>
 <li
 ><a href="#controls_android.tonemap.curve">android.tonemap.curve</a></li>
 <li
 ><a href="#controls_android.tonemap.mode">android.tonemap.mode</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">
 <li
 ><a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></li>
 <li
 ><a href="#static_android.tonemap.availableToneMapModes">android.tonemap.availableToneMapModes</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.tonemap.curveBlue">android.tonemap.curveBlue</a></li>
 <li
 ><a href="#dynamic_android.tonemap.curveGreen">android.tonemap.curveGreen</a></li>
 <li
 ><a href="#dynamic_android.tonemap.curveRed">android.tonemap.curveRed</a></li>
 <li
 ><a href="#dynamic_android.tonemap.curve">android.tonemap.curve</a></li>
 <li
 ><a href="#dynamic_android.tonemap.mode">android.tonemap.mode</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_led">led</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.led.transmit">android.led.transmit</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.led.transmit">android.led.transmit</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">
 <li
 ><a href="#static_android.led.availableLeds">android.led.availableLeds</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_info">info</a>
 <ul class="toc_section">
 <li>
 static
 <ul class="toc_section">
 <li
 ><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_blackLevel">blackLevel</a>
 <ul class="toc_section">
 <li>
 controls
 <ul class="toc_section">
 <li
 ><a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a></li>
 </ul>
 </li>
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.blackLevel.lock">android.blackLevel.lock</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 <li>
 <a href="#section_sync">sync</a>
 <ul class="toc_section">
 <li>
 dynamic
 <ul class="toc_section">
 <li
 ><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a></li>
 </ul>
 </li>
 <li>
 static
 <ul class="toc_section">
 <li
 ><a href="#static_android.sync.maxLatency">android.sync.maxLatency</a></li>
 </ul>
 </li>
 </ul> 
 </li>
 </ul>

<h1>Properties</h1>
 <table class="properties">

<thead class="thead_dummy">
 <tr>
 <th class="th_name">Property Name</th>
 <th class="th_type">Type</th>
 <th class="th_description">Description</th>
 <th class="th_units">Units</th>
 <th class="th_range">Range</th>
 <th class="th_tags">Tags</th>
 </tr>
 </thead> 

 <tr><td colspan="6" id="section_colorCorrection" class="section">colorCorrection</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<thead class="entries_header">
 <tr>
 <th class="th_name">Property Name</th>
 <th class="th_type">Type</th>
 <th class="th_description">Description</th>
 <th class="th_units">Units</th>
 <th class="th_range">Range</th>
 <th class="th_tags">Tags</th>
 </tr>
 </thead>

<tbody>

<tr class="entry" id="controls_android.colorCorrection.mode">
 <td class="entry_name
 " rowspan="3">
 android.colorCorrection.mode
 </td>
 <td class="entry_type">
 byte

[public]

[full]

<ul class="entry_type_enum">
 <li>
 TRANSFORM_MATRIX
 Use the <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a> matrix
and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> to do color conversion.
All advanced white balance adjustments (not specified
by our white balance pipeline) must be disabled.
If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.control.awbMode</a> != OFF</code>, then
TRANSFORM_MATRIX is ignored. The camera device will override
this value to either FAST or HIGH_QUALITY.
 </li>
 <li>
 FAST
 Color correction processing must not slow down
capture rate relative to sensor raw output.
Advanced white balance adjustments above and beyond
the specified white balance pipeline may be applied.
If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.control.awbMode</a> != OFF</code>, then
the camera device uses the last frame's AWB values
(or defaults if AWB has never been run).
 </li>
 <li>
 HIGH_QUALITY
 Color correction processing operates at improved
quality but reduced capture rate (relative to sensor raw
output).
Advanced white balance adjustments above and beyond
the specified white balance pipeline may be applied.
If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.control.awbMode</a> != OFF</code>, then
the camera device uses the last frame's AWB values
(or defaults if AWB has never been run).
 </li>
 </ul>

</td>

<td class="entry_description">
 The mode control selects how the image data is converted from the
sensor's native color into linear sRGB color.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When auto-white balance (AWB) is enabled with <a href="#controls_android.control.awbMode">android.control.awbMode</a>, this
control is overridden by the AWB routine. When AWB is disabled, the
application controls how the color mapping is performed.
We define the expected processing pipeline below. For consistency
across devices, this is always the case with TRANSFORM_MATRIX.
When either FULL or HIGH_QUALITY is used, the camera device may
do additional processing but <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> and
<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a> will still be provided by the
camera device (in the results) and be roughly correct.
Switching to TRANSFORM_MATRIX and using the data provided from
FAST or HIGH_QUALITY will yield a picture with the same white point
as what was produced by the camera device in the earlier frame.
The expected processing pipeline is as follows:
<img alt="White balance processing pipeline" src="images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png"/>
The white balance is encoded by two values, a 4-channel white-balance
gain vector (applied in the Bayer domain), and a 3x3 color transform
matrix (applied after demosaic).
The 4-channel white-balance gains are defined as:
<pre><code><a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> = [ R G_even G_odd B ]
</code></pre>
where <code>G_even</code> is the gain for green pixels on even rows of the
output, and <code>G_odd</code> is the gain for green pixels on the odd rows.
These may be identical for a given camera device implementation; if
the camera device does not support a separate gain for even/odd green
channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to
<code>G_even</code> in the output result metadata.
The matrices for color transforms are defined as a 9-entry vector:
<pre><code><a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a> = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ]
</code></pre>
which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>,
to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,
with colors as follows:
<pre><code>r' = I0r + I1g + I2b
g' = I3r + I4g + I5b
b' = I6r + I7g + I8b
</code></pre>
Both the input and output value ranges must match. Overflow/underflow
values are clipped to fit within the range.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.colorCorrection.transform">
 <td class="entry_name
 " rowspan="3">
 android.colorCorrection.transform
 </td>
 <td class="entry_type">
 rational
 x

3 x 3
 
 [public as colorSpaceTransform]

[full]

<div class="entry_type_notes">3x3 rational matrix in row-major order</div>

</td>

<td class="entry_description">
 A color transform matrix to use to transform
from sensor RGB color space to output linear sRGB color space.
 </td>

<td class="entry_units">
 Unitless scale factors
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This matrix is either set by the camera device when the request
<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> is not TRANSFORM_MATRIX, or
directly by the application in the request when the
<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> is TRANSFORM_MATRIX.
In the latter case, the camera device may round the matrix to account
for precision issues; the final rounded matrix should be reported back
in this matrix result metadata. The transform should keep the magnitude
of the output color values within <code>[0, 1.0]</code> (assuming input color
values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.colorCorrection.gains">
 <td class="entry_name
 " rowspan="5">
 android.colorCorrection.gains
 </td>
 <td class="entry_type">
 float
 x

4
 
 [public as rggbChannelVector]

[full]

<div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>

</td>

<td class="entry_description">
 Gains applying to Bayer raw color channels for
white-balance.
 </td>

<td class="entry_units">
 Unitless gain factors
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 These per-channel gains are either set by the camera device
when the request <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> is not
TRANSFORM_MATRIX, or directly by the application in the
request when the <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> is
TRANSFORM_MATRIX.
The gains in the result metadata are the gains actually
applied by the camera device to the current frame.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The 4-channel white-balance gains are defined in
the order of <code>[R G_even G_odd B]</code>, where <code>G_even</code> is the gain
for green pixels on even rows of the output, and <code>G_odd</code>
is the gain for green pixels on the odd rows.
If a HAL does not support a separate gain for even/odd green
channels, it must use the <code>G_even</code> value, and write
<code>G_odd</code> equal to <code>G_even</code> in the output result metadata.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.colorCorrection.aberrationMode">
 <td class="entry_name
 " rowspan="3">
 android.colorCorrection.aberrationMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 OFF
 No aberration correction is applied.
 </li>
 <li>
 FAST
 Aberration correction will not slow down capture rate
relative to sensor raw output.
 </li>
 <li>
 HIGH_QUALITY
 Aberration correction operates at improved quality but reduced
capture rate (relative to sensor raw output).
 </li>
 </ul>

</td>

<td class="entry_description">
 Mode of operation for the chromatic aberration correction algorithm.
 </td>

<td class="entry_range">
 <a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Chromatic (color) aberration is caused by the fact that different wavelengths of light
can not focus on the same point after exiting from the lens. This metadata defines
the high level control of chromatic aberration correction algorithm, which aims to
minimize the chromatic artifacts that may occur along the object boundaries in an
image.
FAST/HIGH_QUALITY both mean that camera device determined aberration
correction will be applied. HIGH_QUALITY mode indicates that the camera device will
use the highest-quality aberration correction algorithms, even if it slows down
capture rate. FAST means the camera device will not slow down capture rate when
applying aberration correction.
LEGACY devices will always be in FAST mode.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.colorCorrection.mode">
 <td class="entry_name
 " rowspan="3">
 android.colorCorrection.mode
 </td>
 <td class="entry_type">
 byte

[public]

[full]

</td>

<td class="entry_description">
 The mode control selects how the image data is converted from the
sensor's native color into linear sRGB color.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.colorCorrection.transform">
 <td class="entry_name
 " rowspan="3">
 android.colorCorrection.transform
 </td>
 <td class="entry_type">
 rational
 x

3 x 3
 
 [public as colorSpaceTransform]

[full]

<div class="entry_type_notes">3x3 rational matrix in row-major order</div>

</td>

<td class="entry_description">
 A color transform matrix to use to transform
from sensor RGB color space to output linear sRGB color space.
 </td>

<td class="entry_units">
 Unitless scale factors
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.colorCorrection.gains">
 <td class="entry_name
 " rowspan="5">
 android.colorCorrection.gains
 </td>
 <td class="entry_type">
 float
 x

4
 
 [public as rggbChannelVector]

[full]

<div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>

</td>

<td class="entry_description">
 Gains applying to Bayer raw color channels for
white-balance.
 </td>

<td class="entry_units">
 Unitless gain factors
 </td>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The 4-channel white-balance gains are defined in
the order of <code>[R G_even G_odd B]</code>, where <code>G_even</code> is the gain
for green pixels on even rows of the output, and <code>G_odd</code>
is the gain for green pixels on the odd rows.
If a HAL does not support a separate gain for even/odd green
channels, it must use the <code>G_even</code> value, and write
<code>G_odd</code> equal to <code>G_even</code> in the output result metadata.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.colorCorrection.aberrationMode">
 <td class="entry_name
 " rowspan="3">
 android.colorCorrection.aberrationMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 Mode of operation for the chromatic aberration correction algorithm.
 </td>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.colorCorrection.availableAberrationModes">
 <td class="entry_name
 " rowspan="3">
 android.colorCorrection.availableAberrationModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[legacy]

<div class="entry_type_notes">list of enums</div>

</td>

<td class="entry_description">
 List of aberration correction modes for <a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a> that are
supported by this camera device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This key lists the valid modes for <a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a>. If no
aberration correction modes are available for a device, this list will solely include
OFF mode. All camera devices will support either OFF or FAST mode.
Camera devices that support the MANUAL_POST_PROCESSING capability will always list
OFF mode. This includes all FULL level devices.
LEGACY devices will always only support FAST mode.
 </td>
 </tr>

</tbody>

<tr><td colspan="6" id="section_control" class="section">control</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.control.aeAntibandingMode">
 <td class="entry_name
 " rowspan="5">
 android.control.aeAntibandingMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 OFF
 The camera device will not adjust exposure duration to
avoid banding problems.
 </li>
 <li>
 50HZ
 The camera device will adjust exposure duration to
avoid banding problems with 50Hz illumination sources.
 </li>
 <li>
 60HZ
 The camera device will adjust exposure duration to
avoid banding problems with 60Hz illumination
sources.
 </li>
 <li>
 AUTO
 The camera device will automatically adapt its
antibanding routine to the current illumination
condition. This is the default mode if AUTO is
available on given camera device.
 </li>
 </ul>

</td>

<td class="entry_description">
 The desired setting for the camera device's auto-exposure
algorithm's antibanding compensation.
 </td>

<td class="entry_range">
 <a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Some kinds of lighting fixtures, such as some fluorescent
lights, flicker at the rate of the power supply frequency
(60Hz or 50Hz, depending on country). While this is
typically not noticeable to a person, it can be visible to
a camera device. If a camera sets its exposure time to the
wrong value, the flicker may become visible in the
viewfinder as flicker or in a final captured image, as a
set of variable-brightness bands across the image.
Therefore, the auto-exposure routines of camera devices
include antibanding routines that ensure that the chosen
exposure value will not cause such banding. The choice of
exposure time depends on the rate of flicker, which the
camera device can detect automatically, or the expected
rate can be selected by the application using this
control.
A given camera device may not support all of the possible
options for the antibanding mode. The
<a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a> key contains
the available modes for a given camera device.
AUTO mode is the default if it is available on given
camera device. When AUTO mode is not available, the
default will be either 50HZ or 60HZ, and both 50HZ
and 60HZ will be available.
If manual exposure control is enabled (by setting
<a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> to OFF),
then this setting has no effect, and the application must
ensure it selects exposure times that do not cause banding
issues. The <a href="#dynamic_android.statistics.sceneFlicker">android.statistics.sceneFlicker</a> key can assist
the application in this.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For all capture request templates, this field must be set
to AUTO if AUTO mode is available. If AUTO is not available,
the default must be either 50HZ or 60HZ, and both 50HZ and
60HZ must be available.
If manual exposure control is enabled (by setting
<a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> to OFF),
then the exposure values provided by the application must not be
adjusted for antibanding.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.aeExposureCompensation">
 <td class="entry_name
 " rowspan="3">
 android.control.aeExposureCompensation
 </td>
 <td class="entry_type">
 int32

[public]

[legacy]

</td>

<td class="entry_description">
 Adjustment to auto-exposure (AE) target image
brightness.
 </td>

<td class="entry_units">
 Compensation steps
 </td>

<td class="entry_range">
 <a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The adjustment is measured as a count of steps, with the
step size defined by <a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a> and the
allowed range by <a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a>.
For example, if the exposure value (EV) step is 0.333, '6'
will mean an exposure compensation of +2 EV; -3 will mean an
exposure compensation of -1 EV. One EV represents a doubling
of image brightness. Note that this control will only be
effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>!=</code> OFF. This control
will take effect even when <a href="#controls_android.control.aeLock">android.control.aeLock</a> <code>== true</code>.
In the event of exposure compensation value being changed, camera device
may take several frames to reach the newly requested exposure target.
During that time, <a href="#dynamic_android.control.aeState">android.control.aeState</a> field will be in the SEARCHING
state. Once the new exposure target is reached, <a href="#dynamic_android.control.aeState">android.control.aeState</a> will
change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or
FLASH_REQUIRED (if the scene is too dark for still capture).
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.aeLock">
 <td class="entry_name
 " rowspan="3">
 android.control.aeLock
 </td>
 <td class="entry_type">
 byte

[public as boolean]

[legacy]

<ul class="entry_type_enum">
 <li>
 OFF
 Auto-exposure lock is disabled; the AE algorithm
is free to update its parameters.
 </li>
 <li>
 ON
 Auto-exposure lock is enabled; the AE algorithm
must not update the exposure and sensitivity parameters
while the lock is active.
<a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> setting changes
will still take effect while auto-exposure is locked.
Some rare LEGACY devices may not support
this, in which case the value will always be overridden to OFF.
 </li>
 </ul>

</td>

<td class="entry_description">
 Whether auto-exposure (AE) is currently locked to its latest
calculated values.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When set to <code>true</code> (ON), the AE algorithm is locked to its latest parameters,
and will not change exposure settings until the lock is set to <code>false</code> (OFF).
Note that even when AE is locked, the flash may be fired if
the <a href="#controls_android.control.aeMode">android.control.aeMode</a> is ON_AUTO_FLASH /
ON_ALWAYS_FLASH / ON_AUTO_FLASH_REDEYE.
When <a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> is changed, even if the AE lock
is ON, the camera device will still adjust its exposure value.
If AE precapture is triggered (see <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>)
when AE is already locked, the camera device will not change the exposure time
(<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>) and sensitivity (<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>)
parameters. The flash may be fired if the <a href="#controls_android.control.aeMode">android.control.aeMode</a>
is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the
<a href="#controls_android.control.aeMode">android.control.aeMode</a> is ON_ALWAYS_FLASH, the scene may become overexposed.
Since the camera device has a pipeline of in-flight requests, the settings that
get locked do not necessarily correspond to the settings that were present in the
latest capture result received from the camera device, since additional captures
and AE updates may have occurred even before the result was sent out. If an
application is switching between automatic and manual control and wishes to eliminate
any flicker during the switch, the following procedure is recommended:
<ol>
<li>Starting in auto-AE mode:</li>
<li>Lock AE</li>
<li>Wait for the first result to be output that has the AE locked</li>
<li>Copy exposure settings from that result into a request, set the request to manual AE</li>
<li>Submit the capture request, proceed to run manual AE as desired.</li>
</ol>
See <a href="#dynamic_android.control.aeState">android.control.aeState</a> for AE lock related state transition details.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.aeMode">
 <td class="entry_name
 " rowspan="3">
 android.control.aeMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 OFF
 The camera device's autoexposure routine is disabled.
The application-selected <a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,
<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> and
<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> are used by the camera
device, along with android.flash.* fields, if there's
a flash unit for this camera device.
Note that auto-white balance (AWB) and auto-focus (AF)
behavior is device dependent when AE is in OFF mode.
To have consistent behavior across different devices,
it is recommended to either set AWB and AF to OFF mode
or lock AWB and AF before setting AE to OFF.
See <a href="#controls_android.control.awbMode">android.control.awbMode</a>, <a href="#controls_android.control.afMode">android.control.afMode</a>,
<a href="#controls_android.control.awbLock">android.control.awbLock</a>, and <a href="#controls_android.control.afTrigger">android.control.afTrigger</a>
for more details.
LEGACY devices do not support the OFF mode and will
override attempts to use this value to ON.
 </li>
 <li>
 ON
 The camera device's autoexposure routine is active,
with no flash control.
The application's values for
<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,
<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, and
<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> are ignored. The
application has control over the various
android.flash.* fields.
 </li>
 <li>
 ON_AUTO_FLASH
 Like ON, except that the camera device also controls
the camera's flash unit, firing it in low-light
conditions.
The flash may be fired during a precapture sequence
(triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>) and
may be fired for captures for which the
<a href="#controls_android.control.captureIntent">android.control.captureIntent</a> field is set to
STILL_CAPTURE
 </li>
 <li>
 ON_ALWAYS_FLASH
 Like ON, except that the camera device also controls
the camera's flash unit, always firing it for still
captures.
The flash may be fired during a precapture sequence
(triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>) and
will always be fired for captures for which the
<a href="#controls_android.control.captureIntent">android.control.captureIntent</a> field is set to
STILL_CAPTURE
 </li>
 <li>
 ON_AUTO_FLASH_REDEYE
 Like ON_AUTO_FLASH, but with automatic red eye
reduction.
If deemed necessary by the camera device, a red eye
reduction flash will fire during the precapture
sequence.
 </li>
 </ul>

</td>

<td class="entry_description">
 The desired mode for the camera device's
auto-exposure routine.
 </td>

<td class="entry_range">
 <a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control is only effective if <a href="#controls_android.control.mode">android.control.mode</a> is
AUTO.
When set to any of the ON modes, the camera device's
auto-exposure routine is enabled, overriding the
application's selected exposure time, sensor sensitivity,
and frame duration (<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,
<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, and
<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a>). If one of the FLASH modes
is selected, the camera device's flash unit controls are
also overridden.
The FLASH modes are only available if the camera device
has a flash unit (<a href="#static_android.flash.info.available">android.flash.info.available</a> is <code>true</code>).
If flash TORCH mode is desired, this field must be set to
ON or OFF, and <a href="#controls_android.flash.mode">android.flash.mode</a> set to TORCH.
When set to any of the ON modes, the values chosen by the
camera device auto-exposure routine for the overridden
fields for a given capture will be available in its
CaptureResult.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.aeRegions">
 <td class="entry_name
 " rowspan="5">
 android.control.aeRegions
 </td>
 <td class="entry_type">
 int32
 x

5 x area_count
 
 [public as meteringRectangle]

</td>

<td class="entry_description">
 List of metering areas to use for auto-exposure adjustment.
 </td>

<td class="entry_units">
 Pixel coordinates within android.sensor.info.activeArraySize
 </td>

<td class="entry_range">
 Coordinates must be between <code>[(0,0), (width, height))</code> of
<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Not available if <a href="#static_android.control.maxRegionsAe">android.control.maxRegionsAe</a> is 0.
Otherwise will always be present.
The maximum number of regions supported by the device is determined by the value
of <a href="#static_android.control.maxRegionsAe">android.control.maxRegionsAe</a>.
The coordinate system is based on the active pixel array,
with (0,0) being the top-left pixel in the active pixel array, and
(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,
<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the
bottom-right pixel in the active pixel array.
The weight must be within <code>[0, 1000]</code>, and represents a weight
for every pixel in the area. This means that a large metering area
with the same weight as a smaller area will have more effect in
the metering result. Metering areas can partially overlap and the
camera device will add the weights in the overlap region.
The weights are relative to weights of other exposure metering regions, so if only one
region is used, all non-zero weights will have the same effect. A region with 0
weight is ignored.
If all regions have 0 weight, then no specific metering area needs to be used by the
camera device.
If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> returned in
capture result metadata, the camera device will ignore the sections outside the crop
region and output only the intersection rectangle as the metering region in the result
metadata. If the region is entirely outside the crop region, it will be ignored and
not reported in the result metadata.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The HAL level representation of MeteringRectangle[] is a
int[5 * area_count].
Every five elements represent a metering region of
(xmin, ymin, xmax, ymax, weight).
The rectangle is defined to be inclusive on xmin and ymin, but
exclusive on xmax and ymax.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.aeTargetFpsRange">
 <td class="entry_name
 " rowspan="3">
 android.control.aeTargetFpsRange
 </td>
 <td class="entry_type">
 int32
 x

2
 
 [public as rangeInt]

[legacy]

</td>

<td class="entry_description">
 Range over which the auto-exposure routine can
adjust the capture frame rate to maintain good
exposure.
 </td>

<td class="entry_units">
 Frames per second (FPS)
 </td>

<td class="entry_range">
 Any of the entries in <a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Only constrains auto-exposure (AE) algorithm, not
manual control of <a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a> and
<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a>.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.aePrecaptureTrigger">
 <td class="entry_name
 " rowspan="3">
 android.control.aePrecaptureTrigger
 </td>
 <td class="entry_type">
 byte

[public]

[limited]

<ul class="entry_type_enum">
 <li>
 IDLE
 The trigger is idle.
 </li>
 <li>
 START
 The precapture metering sequence will be started
by the camera device.
The exact effect of the precapture trigger depends on
the current AE mode and state.
 </li>
 </ul>

</td>

<td class="entry_description">
 Whether the camera device will trigger a precapture
metering sequence when it processes this request.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This entry is normally set to IDLE, or is not
included at all in the request settings. When included and
set to START, the camera device will trigger the auto-exposure (AE)
precapture metering sequence.
The precapture sequence should be triggered before starting a
high-quality still capture for final metering decisions to
be made, and for firing pre-capture flash pulses to estimate
scene brightness and required final capture flash power, when
the flash is enabled.
Normally, this entry should be set to START for only a
single request, and the application should wait until the
sequence completes before starting a new one.
When a precapture metering sequence is finished, the camera device
may lock the auto-exposure routine internally to be able to accurately expose the
subsequent still capture image (<code><a href="#controls_android.control.captureIntent">android.control.captureIntent</a> == STILL_CAPTURE</code>).
For this case, the AE may not resume normal scan if no subsequent still capture is
submitted. To ensure that the AE routine restarts normal scan, the application should
submit a request with <code><a href="#controls_android.control.aeLock">android.control.aeLock</a> == true</code>, followed by a request
with <code><a href="#controls_android.control.aeLock">android.control.aeLock</a> == false</code>, if the application decides not to submit a
still capture request after the precapture sequence completes.
The exact effect of auto-exposure (AE) precapture trigger
depends on the current AE mode and state; see
<a href="#dynamic_android.control.aeState">android.control.aeState</a> for AE precapture state transition
details.
On LEGACY-level devices, the precapture trigger is not supported;
capturing a high-resolution JPEG image will automatically trigger a
precapture sequence before the high-resolution capture, including
potentially firing a pre-capture flash.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.afMode">
 <td class="entry_name
 " rowspan="5">
 android.control.afMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 OFF
 The auto-focus routine does not control the lens;
<a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> is controlled by the
application.
 </li>
 <li>
 AUTO
 Basic automatic focus mode.
In this mode, the lens does not move unless
the autofocus trigger action is called. When that trigger
is activated, AF will transition to ACTIVE_SCAN, then to
the outcome of the scan (FOCUSED or NOT_FOCUSED).
Always supported if lens is not fixed focus.
Use <a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> to determine if lens
is fixed-focus.
Triggering AF_CANCEL resets the lens position to default,
and sets the AF state to INACTIVE.
 </li>
 <li>
 MACRO
 Close-up focusing mode.
In this mode, the lens does not move unless the
autofocus trigger action is called. When that trigger is
activated, AF will transition to ACTIVE_SCAN, then to
the outcome of the scan (FOCUSED or NOT_FOCUSED). This
mode is optimized for focusing on objects very close to
the camera.
When that trigger is activated, AF will transition to
ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or
NOT_FOCUSED). Triggering cancel AF resets the lens
position to default, and sets the AF state to
INACTIVE.
 </li>
 <li>
 CONTINUOUS_VIDEO
 In this mode, the AF algorithm modifies the lens
position continually to attempt to provide a
constantly-in-focus image stream.
The focusing behavior should be suitable for good quality
video recording; typically this means slower focus
movement and no overshoots. When the AF trigger is not
involved, the AF algorithm should start in INACTIVE state,
and then transition into PASSIVE_SCAN and PASSIVE_FOCUSED
states as appropriate. When the AF trigger is activated,
the algorithm should immediately transition into
AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the
lens position until a cancel AF trigger is received.
Once cancel is received, the algorithm should transition
back to INACTIVE and resume passive scan. Note that this
behavior is not identical to CONTINUOUS_PICTURE, since an
ongoing PASSIVE_SCAN must immediately be
canceled.
 </li>
 <li>
 CONTINUOUS_PICTURE
 In this mode, the AF algorithm modifies the lens
position continually to attempt to provide a
constantly-in-focus image stream.
The focusing behavior should be suitable for still image
capture; typically this means focusing as fast as
possible. When the AF trigger is not involved, the AF
algorithm should start in INACTIVE state, and then
transition into PASSIVE_SCAN and PASSIVE_FOCUSED states as
appropriate as it attempts to maintain focus. When the AF
trigger is activated, the algorithm should finish its
PASSIVE_SCAN if active, and then transition into
AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the
lens position until a cancel AF trigger is received.
When the AF cancel trigger is activated, the algorithm
should transition back to INACTIVE and then act as if it
has just been started.
 </li>
 <li>
 EDOF
 Extended depth of field (digital focus) mode.
The camera device will produce images with an extended
depth of field automatically; no special focusing
operations need to be done before taking a picture.
AF triggers are ignored, and the AF state will always be
INACTIVE.
 </li>
 </ul>

</td>

<td class="entry_description">
 Whether auto-focus (AF) is currently enabled, and what
mode it is set to.
 </td>

<td class="entry_range">
 <a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Only effective if <a href="#controls_android.control.mode">android.control.mode</a> = AUTO and the lens is not fixed focus
(i.e. <code><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> > 0</code>). Also note that
when <a href="#controls_android.control.aeMode">android.control.aeMode</a> is OFF, the behavior of AF is device
dependent. It is recommended to lock AF by using <a href="#controls_android.control.afTrigger">android.control.afTrigger</a> before
setting <a href="#controls_android.control.aeMode">android.control.aeMode</a> to OFF, or set AF mode to OFF when AE is OFF.
If the lens is controlled by the camera device auto-focus algorithm,
the camera device will report the current AF status in <a href="#dynamic_android.control.afState">android.control.afState</a>
in result metadata.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When afMode is AUTO or MACRO, the lens must not move until an AF trigger is sent in a
request (<a href="#controls_android.control.afTrigger">android.control.afTrigger</a> <code>==</code> START). After an AF trigger, the afState will end
up with either FOCUSED_LOCKED or NOT_FOCUSED_LOCKED state (see
<a href="#dynamic_android.control.afState">android.control.afState</a> for detailed state transitions), which indicates that the lens is
locked and will not move. If camera movement (e.g. tilting camera) causes the lens to move
after the lens is locked, the HAL must compensate this movement appropriately such that
the same focal plane remains in focus.
When afMode is one of the continuous auto focus modes, the HAL is free to start a AF
scan whenever it's not locked. When the lens is locked after an AF trigger
(see <a href="#dynamic_android.control.afState">android.control.afState</a> for detailed state transitions), the HAL should maintain the
same lock behavior as above.
When afMode is OFF, the application controls focus manually. The accuracy of the
focus distance control depends on the <a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a>.
However, the lens must not move regardless of the camera movement for any focus distance
manual control.
To put this in concrete terms, if the camera has lens elements which may move based on
camera orientation or motion (e.g. due to gravity), then the HAL must drive the lens to
remain in a fixed position invariant to the camera's orientation or motion, for example,
by using accelerometer measurements in the lens control logic. This is a typical issue
that will arise on camera modules with open-loop VCMs.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.afRegions">
 <td class="entry_name
 " rowspan="5">
 android.control.afRegions
 </td>
 <td class="entry_type">
 int32
 x

5 x area_count
 
 [public as meteringRectangle]

</td>

<td class="entry_description">
 List of metering areas to use for auto-focus.
 </td>

<td class="entry_units">
 Pixel coordinates within android.sensor.info.activeArraySize
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Not available if <a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a> is 0.
Otherwise will always be present.
The maximum number of focus areas supported by the device is determined by the value
of <a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a>.
The coordinate system is based on the active pixel array,
with (0,0) being the top-left pixel in the active pixel array, and
(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,
<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the
bottom-right pixel in the active pixel array.
The weight must be within <code>[0, 1000]</code>, and represents a weight
for every pixel in the area. This means that a large metering area
with the same weight as a smaller area will have more effect in
the metering result. Metering areas can partially overlap and the
camera device will add the weights in the overlap region.
The weights are relative to weights of other metering regions, so if only one region
is used, all non-zero weights will have the same effect. A region with 0 weight is
ignored.
If all regions have 0 weight, then no specific metering area needs to be used by the
camera device.
If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> returned in
capture result metadata, the camera device will ignore the sections outside the crop
region and output only the intersection rectangle as the metering region in the result
metadata. If the region is entirely outside the crop region, it will be ignored and
not reported in the result metadata.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The HAL level representation of MeteringRectangle[] is a
int[5 * area_count].
Every five elements represent a metering region of
(xmin, ymin, xmax, ymax, weight).
The rectangle is defined to be inclusive on xmin and ymin, but
exclusive on xmax and ymax.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.afTrigger">
 <td class="entry_name
 " rowspan="3">
 android.control.afTrigger
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 IDLE
 The trigger is idle.
 </li>
 <li>
 START
 Autofocus will trigger now.
 </li>
 <li>
 CANCEL
 Autofocus will return to its initial
state, and cancel any currently active trigger.
 </li>
 </ul>

</td>

<td class="entry_description">
 Whether the camera device will trigger autofocus for this request.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.awbLock">
 <td class="entry_name
 " rowspan="3">
 android.control.awbLock
 </td>
 <td class="entry_type">
 byte

[public as boolean]

[legacy]

<ul class="entry_type_enum">
 <li>
 OFF
 Auto-white balance lock is disabled; the AWB
algorithm is free to update its parameters if in AUTO
mode.
 </li>
 <li>
 ON
 Auto-white balance lock is enabled; the AWB
algorithm will not update its parameters while the lock
is active.
 </li>
 </ul>

</td>

<td class="entry_description">
 Whether auto-white balance (AWB) is currently locked to its
latest calculated values.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When set to <code>true</code> (ON), the AWB algorithm is locked to its latest parameters,
and will not change color balance settings until the lock is set to <code>false</code> (OFF).
Since the camera device has a pipeline of in-flight requests, the settings that
get locked do not necessarily correspond to the settings that were present in the
latest capture result received from the camera device, since additional captures
and AWB updates may have occurred even before the result was sent out. If an
application is switching between automatic and manual control and wishes to eliminate
any flicker during the switch, the following procedure is recommended:
<ol>
<li>Starting in auto-AWB mode:</li>
<li>Lock AWB</li>
<li>Wait for the first result to be output that has the AWB locked</li>
<li>Copy AWB settings from that result into a request, set the request to manual AWB</li>
<li>Submit the capture request, proceed to run manual AWB as desired.</li>
</ol>
Note that AWB lock is only meaningful when
<a href="#controls_android.control.awbMode">android.control.awbMode</a> is in the AUTO mode; in other modes,
AWB is already fixed to a specific setting.
Some LEGACY devices may not support ON; the value is then overridden to OFF.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.awbMode">
 <td class="entry_name
 " rowspan="3">
 android.control.awbMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 OFF
 The camera device's auto-white balance routine is disabled.
The application-selected color transform matrix
(<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>) and gains
(<a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a>) are used by the camera
device for manual white balance control.
 </li>
 <li>
 AUTO
 The camera device's auto-white balance routine is active.
The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>
and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.
For devices that support the MANUAL_POST_PROCESSING capability, the
values used by the camera device for the transform and gains
will be available in the capture result for this request.
 </li>
 <li>
 INCANDESCENT
 The camera device's auto-white balance routine is disabled;
the camera device uses incandescent light as the assumed scene
illumination for white balance.
While the exact white balance transforms are up to the
camera device, they will approximately match the CIE
standard illuminant A.
The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>
and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.
For devices that support the MANUAL_POST_PROCESSING capability, the
values used by the camera device for the transform and gains
will be available in the capture result for this request.
 </li>
 <li>
 FLUORESCENT
 The camera device's auto-white balance routine is disabled;
the camera device uses fluorescent light as the assumed scene
illumination for white balance.
While the exact white balance transforms are up to the
camera device, they will approximately match the CIE
standard illuminant F2.
The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>
and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.
For devices that support the MANUAL_POST_PROCESSING capability, the
values used by the camera device for the transform and gains
will be available in the capture result for this request.
 </li>
 <li>
 WARM_FLUORESCENT
 The camera device's auto-white balance routine is disabled;
the camera device uses warm fluorescent light as the assumed scene
illumination for white balance.
While the exact white balance transforms are up to the
camera device, they will approximately match the CIE
standard illuminant F4.
The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>
and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.
For devices that support the MANUAL_POST_PROCESSING capability, the
values used by the camera device for the transform and gains
will be available in the capture result for this request.
 </li>
 <li>
 DAYLIGHT
 The camera device's auto-white balance routine is disabled;
the camera device uses daylight light as the assumed scene
illumination for white balance.
While the exact white balance transforms are up to the
camera device, they will approximately match the CIE
standard illuminant D65.
The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>
and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.
For devices that support the MANUAL_POST_PROCESSING capability, the
values used by the camera device for the transform and gains
will be available in the capture result for this request.
 </li>
 <li>
 CLOUDY_DAYLIGHT
 The camera device's auto-white balance routine is disabled;
the camera device uses cloudy daylight light as the assumed scene
illumination for white balance.
The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>
and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.
For devices that support the MANUAL_POST_PROCESSING capability, the
values used by the camera device for the transform and gains
will be available in the capture result for this request.
 </li>
 <li>
 TWILIGHT
 The camera device's auto-white balance routine is disabled;
the camera device uses twilight light as the assumed scene
illumination for white balance.
The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>
and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.
For devices that support the MANUAL_POST_PROCESSING capability, the
values used by the camera device for the transform and gains
will be available in the capture result for this request.
 </li>
 <li>
 SHADE
 The camera device's auto-white balance routine is disabled;
the camera device uses shade light as the assumed scene
illumination for white balance.
The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>
and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.
For devices that support the MANUAL_POST_PROCESSING capability, the
values used by the camera device for the transform and gains
will be available in the capture result for this request.
 </li>
 </ul>

</td>

<td class="entry_description">
 Whether auto-white balance (AWB) is currently setting the color
transform fields, and what its illumination target
is.
 </td>

<td class="entry_range">
 <a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control is only effective if <a href="#controls_android.control.mode">android.control.mode</a> is AUTO.
When set to the ON mode, the camera device's auto-white balance
routine is enabled, overriding the application's selected
<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>, <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> and
<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a>. Note that when <a href="#controls_android.control.aeMode">android.control.aeMode</a>
is OFF, the behavior of AWB is device dependent. It is recommened to
also set AWB mode to OFF or lock AWB by using <a href="#controls_android.control.awbLock">android.control.awbLock</a> before
setting AE mode to OFF.
When set to the OFF mode, the camera device's auto-white balance
routine is disabled. The application manually controls the white
balance by <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>, <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a>
and <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a>.
When set to any other modes, the camera device's auto-white
balance routine is disabled. The camera device uses each
particular illumination target for white balance
adjustment. The application's values for
<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>,
<a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> and
<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> are ignored.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.awbRegions">
 <td class="entry_name
 " rowspan="5">
 android.control.awbRegions
 </td>
 <td class="entry_type">
 int32
 x

5 x area_count
 
 [public as meteringRectangle]

</td>

<td class="entry_description">
 List of metering areas to use for auto-white-balance illuminant
estimation.
 </td>

<td class="entry_units">
 Pixel coordinates within android.sensor.info.activeArraySize
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Not available if <a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a> is 0.
Otherwise will always be present.
The maximum number of regions supported by the device is determined by the value
of <a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a>.
The coordinate system is based on the active pixel array,
with (0,0) being the top-left pixel in the active pixel array, and
(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,
<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the
bottom-right pixel in the active pixel array.
The weight must range from 0 to 1000, and represents a weight
for every pixel in the area. This means that a large metering area
with the same weight as a smaller area will have more effect in
the metering result. Metering areas can partially overlap and the
camera device will add the weights in the overlap region.
The weights are relative to weights of other white balance metering regions, so if
only one region is used, all non-zero weights will have the same effect. A region with
0 weight is ignored.
If all regions have 0 weight, then no specific metering area needs to be used by the
camera device.
If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> returned in
capture result metadata, the camera device will ignore the sections outside the crop
region and output only the intersection rectangle as the metering region in the result
metadata. If the region is entirely outside the crop region, it will be ignored and
not reported in the result metadata.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The HAL level representation of MeteringRectangle[] is a
int[5 * area_count].
Every five elements represent a metering region of
(xmin, ymin, xmax, ymax, weight).
The rectangle is defined to be inclusive on xmin and ymin, but
exclusive on xmax and ymax.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.captureIntent">
 <td class="entry_name
 " rowspan="3">
 android.control.captureIntent
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 CUSTOM
 The goal of this request doesn't fall into the other
categories. The camera device will default to preview-like
behavior.
 </li>
 <li>
 PREVIEW
 This request is for a preview-like use case.
The precapture trigger may be used to start off a metering
w/flash sequence.
 </li>
 <li>
 STILL_CAPTURE
 This request is for a still capture-type
use case.
If the flash unit is under automatic control, it may fire as needed.
 </li>
 <li>
 VIDEO_RECORD
 This request is for a video recording
use case.
 </li>
 <li>
 VIDEO_SNAPSHOT
 This request is for a video snapshot (still
image while recording video) use case.
The camera device should take the highest-quality image
possible (given the other settings) without disrupting the
frame rate of video recording. 
 </li>
 <li>
 ZERO_SHUTTER_LAG
 This request is for a ZSL usecase; the
application will stream full-resolution images and
reprocess one or several later for a final
capture.
 </li>
 <li>
 MANUAL
 This request is for manual capture use case where
the applications want to directly control the capture parameters.
For example, the application may wish to manually control
<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>, <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, etc.
 </li>
 </ul>

</td>

<td class="entry_description">
 Information to the camera device 3A (auto-exposure,
auto-focus, auto-white balance) routines about the purpose
of this capture, to help the camera device to decide optimal 3A
strategy.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control (except for MANUAL) is only effective if
<code><a href="#controls_android.control.mode">android.control.mode</a> != OFF</code> and any 3A routine is active.
ZERO_SHUTTER_LAG will be supported if <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>
contains ZSL. MANUAL will be supported if <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>
contains MANUAL_SENSOR. Other intent values are always supported.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.effectMode">
 <td class="entry_name
 " rowspan="3">
 android.control.effectMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 OFF
 No color effect will be applied.
 </li>
 <li>
 MONO
 [optional]
 A "monocolor" effect where the image is mapped into
a single color.
This will typically be grayscale.
 </li>
 <li>
 NEGATIVE
 [optional]
 A "photo-negative" effect where the image's colors
are inverted.
 </li>
 <li>
 SOLARIZE
 [optional]
 A "solarisation" effect (Sabattier effect) where the
image is wholly or partially reversed in
tone.
 </li>
 <li>
 SEPIA
 [optional]
 A "sepia" effect where the image is mapped into warm
gray, red, and brown tones.
 </li>
 <li>
 POSTERIZE
 [optional]
 A "posterization" effect where the image uses
discrete regions of tone rather than a continuous
gradient of tones.
 </li>
 <li>
 WHITEBOARD
 [optional]
 A "whiteboard" effect where the image is typically displayed
as regions of white, with black or grey details.
 </li>
 <li>
 BLACKBOARD
 [optional]
 A "blackboard" effect where the image is typically displayed
as regions of black, with white or grey details.
 </li>
 <li>
 AQUA
 [optional]
 An "aqua" effect where a blue hue is added to the image.
 </li>
 </ul>

</td>

<td class="entry_description">
 A special color effect to apply.
 </td>

<td class="entry_range">
 <a href="#static_android.control.availableEffects">android.control.availableEffects</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When this mode is set, a color effect will be applied
to images produced by the camera device. The interpretation
and implementation of these color effects is left to the
implementor of the camera device, and should not be
depended on to be consistent (or present) across all
devices.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.mode">
 <td class="entry_name
 " rowspan="3">
 android.control.mode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 OFF
 Full application control of pipeline.
All control by the device's metering and focusing (3A)
routines is disabled, and no other settings in
android.control.* have any effect, except that
<a href="#controls_android.control.captureIntent">android.control.captureIntent</a> may be used by the camera
device to select post-processing values for processing
blocks that do not allow for manual control, or are not
exposed by the camera API.
However, the camera device's 3A routines may continue to
collect statistics and update their internal state so that
when control is switched to AUTO mode, good control values
can be immediately applied.
 </li>
 <li>
 AUTO
 Use settings for each individual 3A routine.
Manual control of capture parameters is disabled. All
controls in android.control.* besides sceneMode take
effect.
 </li>
 <li>
 USE_SCENE_MODE
 Use a specific scene mode.
Enabling this disables control.aeMode, control.awbMode and
control.afMode controls; the camera device will ignore
those settings while USE_SCENE_MODE is active (except for
FACE_PRIORITY scene mode). Other control entries are still
active. This setting can only be used if scene mode is
supported (i.e. <a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a>
contain some modes other than DISABLED).
 </li>
 <li>
 OFF_KEEP_STATE
 Same as OFF mode, except that this capture will not be
used by camera device background auto-exposure, auto-white balance and
auto-focus algorithms (3A) to update their statistics.
Specifically, the 3A routines are locked to the last
values set from a request with AUTO, OFF, or
USE_SCENE_MODE, and any statistics or state updates
collected from manual captures with OFF_KEEP_STATE will be
discarded by the camera device.
 </li>
 </ul>

</td>

<td class="entry_description">
 Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control
routines.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This is a top-level 3A control switch. When set to OFF, all 3A control
by the camera device is disabled. The application must set the fields for
capture parameters itself.
When set to AUTO, the individual algorithm controls in
android.control.* are in effect, such as <a href="#controls_android.control.afMode">android.control.afMode</a>.
When set to USE_SCENE_MODE, the individual controls in
android.control.* are mostly disabled, and the camera device implements
one of the scene mode settings (such as ACTION, SUNSET, or PARTY)
as it wishes. The camera device scene mode 3A settings are provided by
<a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a>.
When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference
is that this frame will not be used by camera device background 3A statistics
update, as if this frame is never captured. This mode can be used in the scenario
where the application doesn't want a 3A manual control capture to affect
the subsequent auto 3A capture results.
LEGACY mode devices will only support AUTO and USE_SCENE_MODE modes.
LIMITED mode devices will only support OFF and OFF_KEEP_STATE if they
support the MANUAL_SENSOR and MANUAL_POST_PROCSESING capabilities.
FULL mode devices will always support OFF and OFF_KEEP_STATE.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.sceneMode">
 <td class="entry_name
 " rowspan="5">
 android.control.sceneMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 DISABLED
 0
 Indicates that no scene modes are set for a given capture request.
 </li>
 <li>
 FACE_PRIORITY
 If face detection support exists, use face
detection data for auto-focus, auto-white balance, and
auto-exposure routines.
If face detection statistics are disabled
(i.e. <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> is set to OFF),
this should still operate correctly (but will not return
face detection statistics to the framework).
Unlike the other scene modes, <a href="#controls_android.control.aeMode">android.control.aeMode</a>,
<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a>
remain active when FACE_PRIORITY is set.
 </li>
 <li>
 ACTION
 [optional]
 Optimized for photos of quickly moving objects.
Similar to SPORTS.
 </li>
 <li>
 PORTRAIT
 [optional]
 Optimized for still photos of people.
 </li>
 <li>
 LANDSCAPE
 [optional]
 Optimized for photos of distant macroscopic objects.
 </li>
 <li>
 NIGHT
 [optional]
 Optimized for low-light settings.
 </li>
 <li>
 NIGHT_PORTRAIT
 [optional]
 Optimized for still photos of people in low-light
settings.
 </li>
 <li>
 THEATRE
 [optional]
 Optimized for dim, indoor settings where flash must
remain off.
 </li>
 <li>
 BEACH
 [optional]
 Optimized for bright, outdoor beach settings.
 </li>
 <li>
 SNOW
 [optional]
 Optimized for bright, outdoor settings containing snow.
 </li>
 <li>
 SUNSET
 [optional]
 Optimized for scenes of the setting sun.
 </li>
 <li>
 STEADYPHOTO
 [optional]
 Optimized to avoid blurry photos due to small amounts of
device motion (for example: due to hand shake).
 </li>
 <li>
 FIREWORKS
 [optional]
 Optimized for nighttime photos of fireworks.
 </li>
 <li>
 SPORTS
 [optional]
 Optimized for photos of quickly moving people.
Similar to ACTION.
 </li>
 <li>
 PARTY
 [optional]
 Optimized for dim, indoor settings with multiple moving
people.
 </li>
 <li>
 CANDLELIGHT
 [optional]
 Optimized for dim settings where the main light source
is a flame.
 </li>
 <li>
 BARCODE
 [optional]
 Optimized for accurately capturing a photo of barcode
for use by camera applications that wish to read the
barcode value.
 </li>
 <li>
 HIGH_SPEED_VIDEO
 [optional]
 Optimized for high speed video recording (frame rate >=60fps) use case.
The supported high speed video sizes and fps ranges are specified in
<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a>. To get desired
output frame rates, the application is only allowed to select video size
and fps range combinations listed in this static metadata. The fps range
can be control via <a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a>.
In this mode, the camera device will override aeMode, awbMode, and afMode to
ON, ON, and CONTINUOUS_VIDEO, respectively. All post-processing block mode
controls will be overridden to be FAST. Therefore, no manual control of capture
and post-processing parameters is possible. All other controls operate the
same as when <a href="#controls_android.control.mode">android.control.mode</a> == AUTO. This means that all other
android.control.* fields continue to work, such as
<ul>
<li><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>
<li><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>
<li><a href="#controls_android.control.aeLock">android.control.aeLock</a></li>
<li><a href="#controls_android.control.awbLock">android.control.awbLock</a></li>
<li><a href="#controls_android.control.effectMode">android.control.effectMode</a></li>
<li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>
<li><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>
<li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>
<li><a href="#controls_android.control.afTrigger">android.control.afTrigger</a></li>
<li><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>
</ul>
Outside of android.control.*, the following controls will work:
<ul>
<li><a href="#controls_android.flash.mode">android.flash.mode</a> (automatic flash for still capture will not work since aeMode is ON)</li>
<li><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (if it is supported)</li>
<li><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a></li>
<li><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>
</ul>
For high speed recording use case, the actual maximum supported frame rate may
be lower than what camera can output, depending on the destination Surfaces for
the image data. For example, if the destination surface is from video encoder,
the application need check if the video encoder is capable of supporting the
high frame rate for a given video size, or it will end up with lower recording
frame rate. If the destination surface is from preview window, the preview frame
rate will be bounded by the screen refresh rate.
The camera device will only support up to 2 output high speed streams
(processed non-stalling format defined in <a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a>)
in this mode. This control will be effective only if all of below conditions are true:
<ul>
<li>The application created no more than maxNumHighSpeedStreams processed non-stalling
format output streams, where maxNumHighSpeedStreams is calculated as
min(2, <a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a>[Processed (but not-stalling)]).</li>
<li>The stream sizes are selected from the sizes reported by
<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a>.</li>
<li>No processed non-stalling or raw streams are configured.</li>
</ul>
When above conditions are NOT satistied, the controls of this mode and
<a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> will be ignored by the camera device,
the camera device will fall back to <a href="#controls_android.control.mode">android.control.mode</a> <code>==</code> AUTO,
and the returned capture result metadata will give the fps range choosen
by the camera device.
Switching into or out of this mode may trigger some camera ISP/sensor
reconfigurations, which may introduce extra latency. It is recommended that
the application avoids unnecessary scene mode switch as much as possible.
 </li>
 <li>
 HDR
 [optional]
 Turn on a device-specific high dynamic range (HDR) mode.
In this scene mode, the camera device captures images
that keep a larger range of scene illumination levels
visible in the final image. For example, when taking a
picture of a object in front of a bright window, both
the object and the scene through the window may be
visible when using HDR mode, while in normal AUTO mode,
one or the other may be poorly exposed. As a tradeoff,
HDR mode generally takes much longer to capture a single
image, has no user control, and may have other artifacts
depending on the HDR method used.
Therefore, HDR captures operate at a much slower rate
than regular captures.
In this mode, on LIMITED or FULL devices, when a request
is made with a <a href="#controls_android.control.captureIntent">android.control.captureIntent</a> of
STILL_CAPTURE, the camera device will capture an image
using a high dynamic range capture technique. On LEGACY
devices, captures that target a JPEG-format output will
be captured with HDR, and the capture intent is not
relevant.
The HDR capture may involve the device capturing a burst
of images internally and combining them into one, or it
may involve the device using specialized high dynamic
range capture hardware. In all cases, a single image is
produced in response to a capture request submitted
while in HDR mode.
Since substantial post-processing is generally needed to
produce an HDR image, only YUV and JPEG outputs are
supported for LIMITED/FULL device HDR captures, and only
JPEG outputs are supported for LEGACY HDR
captures. Using a RAW output for HDR capture is not
supported.
 </li>
 </ul>

</td>

<td class="entry_description">
 Control for which scene mode is currently active.
 </td>

<td class="entry_range">
 <a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Scene modes are custom camera modes optimized for a certain set of conditions and
capture settings.
This is the mode that that is active when
<code><a href="#controls_android.control.mode">android.control.mode</a> == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY,
these modes will disable <a href="#controls_android.control.aeMode">android.control.aeMode</a>,
<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a> while in use.
The interpretation and implementation of these scene modes is left
to the implementor of the camera device. Their behavior will not be
consistent across all devices, and any given device may only implement
a subset of these modes.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 HAL implementations that include scene modes are expected to provide
the per-scene settings to use for <a href="#controls_android.control.aeMode">android.control.aeMode</a>,
<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a> in
<a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a>.
For HIGH_SPEED_VIDEO mode, if it is included in <a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a>,
the HAL must list supported video size and fps range in
<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a>. For a given size, e.g.
1280x720, if the HAL has two different sensor configurations for normal streaming
mode and high speed streaming, when this scene mode is set/reset in a sequence of capture
requests, the HAL may have to switch between different sensor modes.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.control.videoStabilizationMode">
 <td class="entry_name
 " rowspan="3">
 android.control.videoStabilizationMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 OFF
 Video stabilization is disabled.
 </li>
 <li>
 ON
 Video stabilization is enabled.
 </li>
 </ul>

</td>

<td class="entry_description">
 Whether video stabilization is
active.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Video stabilization automatically translates and scales images from
the camera in order to stabilize motion between consecutive frames.
If enabled, video stabilization can modify the
<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> to keep the video stream stabilized.
Switching between different video stabilization modes may take several
frames to initialize, the camera device will report the current mode
in capture result metadata. For example, When "ON" mode is requested,
the video stabilization modes in the first several capture results may
still be "OFF", and it will become "ON" when the initialization is
done.
If a camera device supports both this mode and OIS
(<a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a>), turning both modes on may
produce undesirable interaction, so it is recommended not to enable
both at the same time.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.control.aeAvailableAntibandingModes">
 <td class="entry_name
 " rowspan="3">
 android.control.aeAvailableAntibandingModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[legacy]

<div class="entry_type_notes">list of enums</div>

</td>

<td class="entry_description">
 List of auto-exposure antibanding modes for <a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> that are
supported by this camera device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Not all of the auto-exposure anti-banding modes may be
supported by a given camera device. This field lists the
valid anti-banding modes that the application may request
for this camera device with the
<a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> control.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.aeAvailableModes">
 <td class="entry_name
 " rowspan="3">
 android.control.aeAvailableModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[legacy]

<div class="entry_type_notes">list of enums</div>

</td>

<td class="entry_description">
 List of auto-exposure modes for <a href="#controls_android.control.aeMode">android.control.aeMode</a> that are supported by this camera
device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.control.aeMode">android.control.aeMode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Not all the auto-exposure modes may be supported by a
given camera device, especially if no flash unit is
available. This entry lists the valid modes for
<a href="#controls_android.control.aeMode">android.control.aeMode</a> for this camera device.
All camera devices support ON, and all camera devices with flash
units support ON_AUTO_FLASH and ON_ALWAYS_FLASH.
FULL mode camera devices always support OFF mode,
which enables application control of camera exposure time,
sensitivity, and frame duration.
LEGACY mode camera devices never support OFF mode.
LIMITED mode devices support OFF if they support the MANUAL_SENSOR
capability.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.aeAvailableTargetFpsRanges">
 <td class="entry_name
 " rowspan="3">
 android.control.aeAvailableTargetFpsRanges
 </td>
 <td class="entry_type">
 int32
 x

2 x n
 
 [public as rangeInt]

[legacy]

<div class="entry_type_notes">list of pairs of frame rates</div>

</td>

<td class="entry_description">
 List of frame rate ranges for <a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> supported by
this camera device.
 </td>

<td class="entry_units">
 Frames per second (FPS)
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For devices at the LIMITED level or above, this list will include at least (30, 30) for
constant-framerate recording.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.aeCompensationRange">
 <td class="entry_name
 " rowspan="1">
 android.control.aeCompensationRange
 </td>
 <td class="entry_type">
 int32
 x

2
 
 [public as rangeInt]

[legacy]

</td>

<td class="entry_description">
 Maximum and minimum exposure compensation values for
<a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a>, in counts of <a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a>,
that are supported by this camera device.
 </td>

<td class="entry_range">
 Range [0,0] indicates that exposure compensation is not supported.
For LIMITED and FULL devices, range must follow below requirements if exposure
compensation is supported (<code>range != [0, 0]</code>):
<code>Min.exposure compensation * <a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a> <= -2 EV</code>
<code>Max.exposure compensation * <a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a> >= 2 EV</code>
LEGACY devices may support a smaller range than this.
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.aeCompensationStep">
 <td class="entry_name
 " rowspan="5">
 android.control.aeCompensationStep
 </td>
 <td class="entry_type">
 rational

[public]

[legacy]

</td>

<td class="entry_description">
 Smallest step by which the exposure compensation
can be changed.
 </td>

<td class="entry_units">
 Exposure Value (EV)
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This is the unit for <a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a>. For example, if this key has
a value of <code>1/2</code>, then a setting of <code>-2</code> for <a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> means
that the target EV offset for the auto-exposure routine is -1 EV.
One unit of EV compensation changes the brightness of the captured image by a factor
of two. +1 EV doubles the image brightness, while -1 EV halves the image brightness.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.afAvailableModes">
 <td class="entry_name
 " rowspan="3">
 android.control.afAvailableModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[legacy]

<div class="entry_type_notes">List of enums</div>

</td>

<td class="entry_description">
 List of auto-focus (AF) modes for <a href="#controls_android.control.afMode">android.control.afMode</a> that are
supported by this camera device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.control.afMode">android.control.afMode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Not all the auto-focus modes may be supported by a
given camera device. This entry lists the valid modes for
<a href="#controls_android.control.afMode">android.control.afMode</a> for this camera device.
All LIMITED and FULL mode camera devices will support OFF mode, and all
camera devices with adjustable focuser units
(<code><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> > 0</code>) will support AUTO mode.
LEGACY devices will support OFF mode only if they support
focusing to infinity (by also setting <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> to
<code>0.0f</code>).
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.availableEffects">
 <td class="entry_name
 " rowspan="3">
 android.control.availableEffects
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[legacy]

<div class="entry_type_notes">List of enums (android.control.effectMode).</div>

</td>

<td class="entry_description">
 List of color effects for <a href="#controls_android.control.effectMode">android.control.effectMode</a> that are supported by this camera
device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.control.effectMode">android.control.effectMode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This list contains the color effect modes that can be applied to
images produced by the camera device.
Implementations are not expected to be consistent across all devices.
If no color effect modes are available for a device, this will only list
OFF.
A color effect will only be applied if
<a href="#controls_android.control.mode">android.control.mode</a> != OFF. OFF is always included in this list.
This control has no effect on the operation of other control routines such
as auto-exposure, white balance, or focus.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.availableSceneModes">
 <td class="entry_name
 " rowspan="3">
 android.control.availableSceneModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[legacy]

<div class="entry_type_notes">List of enums (android.control.sceneMode).</div>

</td>

<td class="entry_description">
 List of scene modes for <a href="#controls_android.control.sceneMode">android.control.sceneMode</a> that are supported by this camera
device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.control.sceneMode">android.control.sceneMode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This list contains scene modes that can be set for the camera device.
Only scene modes that have been fully implemented for the
camera device may be included here. Implementations are not expected
to be consistent across all devices.
If no scene modes are supported by the camera device, this
will be set to DISABLED. Otherwise DISABLED will not be listed.
FACE_PRIORITY is always listed if face detection is
supported (i.e.<code><a href="#static_android.statistics.info.maxFaceCount">android.statistics.info.maxFaceCount</a> >
0</code>).
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.availableVideoStabilizationModes">
 <td class="entry_name
 " rowspan="3">
 android.control.availableVideoStabilizationModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[legacy]

<div class="entry_type_notes">List of enums.</div>

</td>

<td class="entry_description">
 List of video stabilization modes for <a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a>
that are supported by this camera device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 OFF will always be listed.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.awbAvailableModes">
 <td class="entry_name
 " rowspan="3">
 android.control.awbAvailableModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[legacy]

<div class="entry_type_notes">List of enums</div>

</td>

<td class="entry_description">
 List of auto-white-balance modes for <a href="#controls_android.control.awbMode">android.control.awbMode</a> that are supported by this
camera device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.control.awbMode">android.control.awbMode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Not all the auto-white-balance modes may be supported by a
given camera device. This entry lists the valid modes for
<a href="#controls_android.control.awbMode">android.control.awbMode</a> for this camera device.
All camera devices will support ON mode.
Camera devices that support the MANUAL_POST_PROCESSING capability will always support OFF
mode, which enables application control of white balance, by using
<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a> and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a>(<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> must be set to TRANSFORM_MATRIX). This includes all FULL
mode camera devices.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.maxRegions">
 <td class="entry_name
 " rowspan="1">
 android.control.maxRegions
 </td>
 <td class="entry_type">
 int32
 x

3
 
 [hidden]

[legacy]

</td>

<td class="entry_description">
 List of the maximum number of regions that can be used for metering in
auto-exposure (AE), auto-white balance (AWB), and auto-focus (AF);
this corresponds to the the maximum number of elements in
<a href="#controls_android.control.aeRegions">android.control.aeRegions</a>, <a href="#controls_android.control.awbRegions">android.control.awbRegions</a>,
and <a href="#controls_android.control.afRegions">android.control.afRegions</a>.
 </td>

<td class="entry_range">
 Value must be >= 0 for each element. For full-capability devices
this value must be >= 1 for AE and AF. The order of the elements is:
<code>(AE, AWB, AF)</code>.
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.maxRegionsAe">
 <td class="entry_name
 " rowspan="5">
 android.control.maxRegionsAe
 </td>
 <td class="entry_type">
 int32

[public]

[synthetic]

[legacy]

</td>

<td class="entry_description">
 The maximum number of metering regions that can be used by the auto-exposure (AE)
routine.
 </td>

<td class="entry_range">
 Value will be >= 0. For FULL-capability devices, this
value will be >= 1.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This corresponds to the the maximum allowed number of elements in
<a href="#controls_android.control.aeRegions">android.control.aeRegions</a>.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.maxRegionsAwb">
 <td class="entry_name
 " rowspan="5">
 android.control.maxRegionsAwb
 </td>
 <td class="entry_type">
 int32

[public]

[synthetic]

[legacy]

</td>

<td class="entry_description">
 The maximum number of metering regions that can be used by the auto-white balance (AWB)
routine.
 </td>

<td class="entry_range">
 Value will be >= 0.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This corresponds to the the maximum allowed number of elements in
<a href="#controls_android.control.awbRegions">android.control.awbRegions</a>.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.maxRegionsAf">
 <td class="entry_name
 " rowspan="5">
 android.control.maxRegionsAf
 </td>
 <td class="entry_type">
 int32

[public]

[synthetic]

[legacy]

</td>

<td class="entry_description">
 The maximum number of metering regions that can be used by the auto-focus (AF) routine.
 </td>

<td class="entry_range">
 Value will be >= 0. For FULL-capability devices, this
value will be >= 1.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This corresponds to the the maximum allowed number of elements in
<a href="#controls_android.control.afRegions">android.control.afRegions</a>.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.sceneModeOverrides">
 <td class="entry_name
 " rowspan="5">
 android.control.sceneModeOverrides
 </td>
 <td class="entry_type">
 byte
 x

3 x length(availableSceneModes)
 
 [system]

[limited]

</td>

<td class="entry_description">
 Ordered list of auto-exposure, auto-white balance, and auto-focus
settings to use with each available scene mode.
 </td>

<td class="entry_range">
 For each available scene mode, the list must contain three
entries containing the <a href="#controls_android.control.aeMode">android.control.aeMode</a>,
<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a> values used
by the camera device. The entry order is <code>(aeMode, awbMode, afMode)</code>
where aeMode has the lowest index position.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When a scene mode is enabled, the camera device is expected
to override <a href="#controls_android.control.aeMode">android.control.aeMode</a>, <a href="#controls_android.control.awbMode">android.control.awbMode</a>,
and <a href="#controls_android.control.afMode">android.control.afMode</a> with its preferred settings for
that scene mode.
The order of this list matches that of availableSceneModes,
with 3 entries for each mode. The overrides listed
for FACE_PRIORITY are ignored, since for that
mode the application-set <a href="#controls_android.control.aeMode">android.control.aeMode</a>,
<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a> values are
used instead, matching the behavior when <a href="#controls_android.control.mode">android.control.mode</a>
is set to AUTO. It is recommended that the FACE_PRIORITY
overrides should be set to 0.
For example, if availableSceneModes contains
<code>(FACE_PRIORITY, ACTION, NIGHT)</code>, then the camera framework
expects sceneModeOverrides to have 9 entries formatted like:
<code>(0, 0, 0, ON_AUTO_FLASH, AUTO, CONTINUOUS_PICTURE,
ON_AUTO_FLASH, INCANDESCENT, AUTO)</code>.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 To maintain backward compatibility, this list will be made available
in the static metadata of the camera service. The camera service will
use these values to set <a href="#controls_android.control.aeMode">android.control.aeMode</a>,
<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a> when using a scene
mode other than FACE_PRIORITY.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.control.availableHighSpeedVideoConfigurations">
 <td class="entry_name
 " rowspan="5">
 android.control.availableHighSpeedVideoConfigurations
 </td>
 <td class="entry_type">
 int32
 x

4 x n
 
 [hidden as highSpeedVideoConfiguration]

[limited]

</td>

<td class="entry_description">
 List of available high speed video size and fps range configurations
supported by the camera device, in the format of (width, height, fps_min, fps_max).
 </td>

<td class="entry_range">
 For each configuration, the fps_max >= 60fps.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When HIGH_SPEED_VIDEO is supported in <a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a>,
this metadata will list the supported high speed video size and fps range
configurations. All the sizes listed in this configuration will be a subset
of the sizes reported by StreamConfigurationMap#getOutputSizes for processed
non-stalling formats.
For the high speed video use case, where the application will set
<a href="#controls_android.control.sceneMode">android.control.sceneMode</a> to HIGH_SPEED_VIDEO in capture requests, the application must
select the video size and fps range from this metadata to configure the recording and
preview streams and setup the recording requests. For example, if the application intends
to do high speed recording, it can select the maximum size reported by this metadata to
configure output streams. Once the size is selected, application can filter this metadata
by selected size and get the supported fps ranges, and use these fps ranges to setup the
recording requests. Note that for the use case of multiple output streams, application
must select one unique size from this metadata to use. Otherwise a request error might
occur.
For normal video recording use case, where some application will NOT set
<a href="#controls_android.control.sceneMode">android.control.sceneMode</a> to HIGH_SPEED_VIDEO in capture requests, the fps ranges
reported in this metadata must not be used to setup capture requests, or it will cause
request error.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 All the sizes listed in this configuration will be a subset of the sizes reported by
<a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a> for processed non-stalling output formats.
Note that for all high speed video configurations, HAL must be able to support a minimum
of two streams, though the application might choose to configure just one stream.
Since the HIGH_SPEED_VIDEO mode may be turned on for preview view only case, the preview
fps is bounded by device refresh rate (e.g. 60fps). For a given resolution, it is
recommended that this list includes some fps ranges (e.g. [30, 60]) that is suitable
for preview only streaming case.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.control.aePrecaptureId">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.control.aePrecaptureId
 </td>
 <td class="entry_type">
 int32

[system]

[deprecated]

</td>

<td class="entry_description">
 The ID sent with the latest
CAMERA2_TRIGGER_PRECAPTURE_METERING call
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Must be 0 if no
CAMERA2_TRIGGER_PRECAPTURE_METERING trigger received yet
by HAL. Always updated even if AE algorithm ignores the
trigger
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.aeAntibandingMode">
 <td class="entry_name
 " rowspan="5">
 android.control.aeAntibandingMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 The desired setting for the camera device's auto-exposure
algorithm's antibanding compensation.
 </td>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For all capture request templates, this field must be set
to AUTO if AUTO mode is available. If AUTO is not available,
the default must be either 50HZ or 60HZ, and both 50HZ and
60HZ must be available.
If manual exposure control is enabled (by setting
<a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> to OFF),
then the exposure values provided by the application must not be
adjusted for antibanding.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.aeExposureCompensation">
 <td class="entry_name
 " rowspan="3">
 android.control.aeExposureCompensation
 </td>
 <td class="entry_type">
 int32

[public]

[legacy]

</td>

<td class="entry_description">
 Adjustment to auto-exposure (AE) target image
brightness.
 </td>

<td class="entry_units">
 Compensation steps
 </td>

<td class="entry_range">
 <a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a>
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.aeLock">
 <td class="entry_name
 " rowspan="3">
 android.control.aeLock
 </td>
 <td class="entry_type">
 byte

[public as boolean]

[legacy]

</td>

<td class="entry_description">
 Whether auto-exposure (AE) is currently locked to its latest
calculated values.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.aeMode">
 <td class="entry_name
 " rowspan="3">
 android.control.aeMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 The desired mode for the camera device's
auto-exposure routine.
 </td>

<td class="entry_range">
 <a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control is only effective if <a href="#controls_android.control.mode">android.control.mode</a> is
AUTO.
When set to any of the ON modes, the camera device's
auto-exposure routine is enabled, overriding the
application's selected exposure time, sensor sensitivity,
and frame duration (<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,
<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, and
<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a>). If one of the FLASH modes
is selected, the camera device's flash unit controls are
also overridden.
The FLASH modes are only available if the camera device
has a flash unit (<a href="#static_android.flash.info.available">android.flash.info.available</a> is <code>true</code>).
If flash TORCH mode is desired, this field must be set to
ON or OFF, and <a href="#controls_android.flash.mode">android.flash.mode</a> set to TORCH.
When set to any of the ON modes, the values chosen by the
camera device auto-exposure routine for the overridden
fields for a given capture will be available in its
CaptureResult.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.aeRegions">
 <td class="entry_name
 " rowspan="5">
 android.control.aeRegions
 </td>
 <td class="entry_type">
 int32
 x

5 x area_count
 
 [public as meteringRectangle]

</td>

<td class="entry_description">
 List of metering areas to use for auto-exposure adjustment.
 </td>

<td class="entry_units">
 Pixel coordinates within android.sensor.info.activeArraySize
 </td>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The HAL level representation of MeteringRectangle[] is a
int[5 * area_count].
Every five elements represent a metering region of
(xmin, ymin, xmax, ymax, weight).
The rectangle is defined to be inclusive on xmin and ymin, but
exclusive on xmax and ymax.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.aeTargetFpsRange">
 <td class="entry_name
 " rowspan="3">
 android.control.aeTargetFpsRange
 </td>
 <td class="entry_type">
 int32
 x

2
 
 [public as rangeInt]

[legacy]

</td>

<td class="entry_description">
 Range over which the auto-exposure routine can
adjust the capture frame rate to maintain good
exposure.
 </td>

<td class="entry_units">
 Frames per second (FPS)
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.aePrecaptureTrigger">
 <td class="entry_name
 " rowspan="3">
 android.control.aePrecaptureTrigger
 </td>
 <td class="entry_type">
 byte

[public]

[limited]

</td>

<td class="entry_description">
 Whether the camera device will trigger a precapture
metering sequence when it processes this request.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.aeState">
 <td class="entry_name
 " rowspan="3">
 android.control.aeState
 </td>
 <td class="entry_type">
 byte

[public]

[limited]

<ul class="entry_type_enum">
 <li>
 INACTIVE
 AE is off or recently reset.
When a camera device is opened, it starts in
this state. This is a transient state, the camera device may skip reporting
this state in capture result.
 </li>
 <li>
 SEARCHING
 AE doesn't yet have a good set of control values
for the current scene.
This is a transient state, the camera device may skip
reporting this state in capture result.
 </li>
 <li>
 CONVERGED
 AE has a good set of control values for the
current scene.
 </li>
 <li>
 LOCKED
 AE has been locked.
 </li>
 <li>
 FLASH_REQUIRED
 AE has a good set of control values, but flash
needs to be fired for good quality still
capture.
 </li>
 <li>
 PRECAPTURE
 AE has been asked to do a precapture sequence
and is currently executing it.
Precapture can be triggered through setting
<a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> to START.
Once PRECAPTURE completes, AE will transition to CONVERGED
or FLASH_REQUIRED as appropriate. This is a transient
state, the camera device may skip reporting this state in
capture result.
 </li>
 </ul>

</td>

<td class="entry_description">
 Current state of the auto-exposure (AE) algorithm.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.afMode">
 <td class="entry_name
 " rowspan="5">
 android.control.afMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 Whether auto-focus (AF) is currently enabled, and what
mode it is set to.
 </td>

<td class="entry_range">
 <a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a>
 </td>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When afMode is AUTO or MACRO, the lens must not move until an AF trigger is sent in a
request (<a href="#controls_android.control.afTrigger">android.control.afTrigger</a> <code>==</code> START). After an AF trigger, the afState will end
up with either FOCUSED_LOCKED or NOT_FOCUSED_LOCKED state (see
<a href="#dynamic_android.control.afState">android.control.afState</a> for detailed state transitions), which indicates that the lens is
locked and will not move. If camera movement (e.g. tilting camera) causes the lens to move
after the lens is locked, the HAL must compensate this movement appropriately such that
the same focal plane remains in focus.
When afMode is one of the continuous auto focus modes, the HAL is free to start a AF
scan whenever it's not locked. When the lens is locked after an AF trigger
(see <a href="#dynamic_android.control.afState">android.control.afState</a> for detailed state transitions), the HAL should maintain the
same lock behavior as above.
When afMode is OFF, the application controls focus manually. The accuracy of the
focus distance control depends on the <a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a>.
However, the lens must not move regardless of the camera movement for any focus distance
manual control.
To put this in concrete terms, if the camera has lens elements which may move based on
camera orientation or motion (e.g. due to gravity), then the HAL must drive the lens to
remain in a fixed position invariant to the camera's orientation or motion, for example,
by using accelerometer measurements in the lens control logic. This is a typical issue
that will arise on camera modules with open-loop VCMs.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.afRegions">
 <td class="entry_name
 " rowspan="5">
 android.control.afRegions
 </td>
 <td class="entry_type">
 int32
 x

5 x area_count
 
 [public as meteringRectangle]

</td>

<td class="entry_description">
 List of metering areas to use for auto-focus.
 </td>

<td class="entry_units">
 Pixel coordinates within android.sensor.info.activeArraySize
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Not available if <a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a> is 0.
Otherwise will always be present.
The maximum number of focus areas supported by the device is determined by the value
of <a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a>.
The coordinate system is based on the active pixel array,
with (0,0) being the top-left pixel in the active pixel array, and
(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,
<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the
bottom-right pixel in the active pixel array.
The weight must be within <code>[0, 1000]</code>, and represents a weight
for every pixel in the area. This means that a large metering area
with the same weight as a smaller area will have more effect in
the metering result. Metering areas can partially overlap and the
camera device will add the weights in the overlap region.
The weights are relative to weights of other metering regions, so if only one region
is used, all non-zero weights will have the same effect. A region with 0 weight is
ignored.
If all regions have 0 weight, then no specific metering area needs to be used by the
camera device.
If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> returned in
capture result metadata, the camera device will ignore the sections outside the crop
region and output only the intersection rectangle as the metering region in the result
metadata. If the region is entirely outside the crop region, it will be ignored and
not reported in the result metadata.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The HAL level representation of MeteringRectangle[] is a
int[5 * area_count].
Every five elements represent a metering region of
(xmin, ymin, xmax, ymax, weight).
The rectangle is defined to be inclusive on xmin and ymin, but
exclusive on xmax and ymax.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.afTrigger">
 <td class="entry_name
 " rowspan="3">
 android.control.afTrigger
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 IDLE
 The trigger is idle.
 </li>
 <li>
 START
 Autofocus will trigger now.
 </li>
 <li>
 CANCEL
 Autofocus will return to its initial
state, and cancel any currently active trigger.
 </li>
 </ul>

</td>

<td class="entry_description">
 Whether the camera device will trigger autofocus for this request.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.afState">
 <td class="entry_name
 " rowspan="3">
 android.control.afState
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 INACTIVE
 AF is off or has not yet tried to scan/been asked
to scan.
When a camera device is opened, it starts in this
state. This is a transient state, the camera device may
skip reporting this state in capture
result.
 </li>
 <li>
 PASSIVE_SCAN
 AF is currently performing an AF scan initiated the
camera device in a continuous autofocus mode.
Only used by CONTINUOUS_* AF modes. This is a transient
state, the camera device may skip reporting this state in
capture result.
 </li>
 <li>
 PASSIVE_FOCUSED
 AF currently believes it is in focus, but may
restart scanning at any time.
Only used by CONTINUOUS_* AF modes. This is a transient
state, the camera device may skip reporting this state in
capture result.
 </li>
 <li>
 ACTIVE_SCAN
 AF is performing an AF scan because it was
triggered by AF trigger.
Only used by AUTO or MACRO AF modes. This is a transient
state, the camera device may skip reporting this state in
capture result.
 </li>
 <li>
 FOCUSED_LOCKED
 AF believes it is focused correctly and has locked
focus.
This state is reached only after an explicit START AF trigger has been
sent (<a href="#controls_android.control.afTrigger">android.control.afTrigger</a>), when good focus has been obtained.
The lens will remain stationary until the AF mode (<a href="#controls_android.control.afMode">android.control.afMode</a>) is changed or
a new AF trigger is sent to the camera device (<a href="#controls_android.control.afTrigger">android.control.afTrigger</a>).
 </li>
 <li>
 NOT_FOCUSED_LOCKED
 AF has failed to focus successfully and has locked
focus.
This state is reached only after an explicit START AF trigger has been
sent (<a href="#controls_android.control.afTrigger">android.control.afTrigger</a>), when good focus cannot be obtained.
The lens will remain stationary until the AF mode (<a href="#controls_android.control.afMode">android.control.afMode</a>) is changed or
a new AF trigger is sent to the camera device (<a href="#controls_android.control.afTrigger">android.control.afTrigger</a>).
 </li>
 <li>
 PASSIVE_UNFOCUSED
 AF finished a passive scan without finding focus,
and may restart scanning at any time.
Only used by CONTINUOUS_* AF modes. This is a transient state, the camera
device may skip reporting this state in capture result.
LEGACY camera devices do not support this state. When a passive
scan has finished, it will always go to PASSIVE_FOCUSED.
 </li>
 </ul>

</td>

<td class="entry_description">
 Current state of auto-focus (AF) algorithm.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Switching between or enabling AF modes (<a href="#controls_android.control.afMode">android.control.afMode</a>) always
resets the AF state to INACTIVE. Similarly, switching between <a href="#controls_android.control.mode">android.control.mode</a>,
or <a href="#controls_android.control.sceneMode">android.control.sceneMode</a> if <code><a href="#controls_android.control.mode">android.control.mode</a> == USE_SCENE_MODE</code> resets all
the algorithm states to INACTIVE.
The camera device can do several state transitions between two results, if it is
allowed by the state transition table. For example: INACTIVE may never actually be
seen in a result.
The state in the result is the state for this image (in sync with this image): if
AF state becomes FOCUSED, then the image data associated with this result should
be sharp.
Below are state transition tables for different AF modes.
When <a href="#controls_android.control.afMode">android.control.afMode</a> is AF_MODE_OFF or AF_MODE_EDOF:
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center"></td>
<td align="center">INACTIVE</td>
<td align="center">Never changes</td>
</tr>
</tbody>
</table>
When <a href="#controls_android.control.afMode">android.control.afMode</a> is AF_MODE_AUTO or AF_MODE_MACRO:
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center">AF_TRIGGER</td>
<td align="center">ACTIVE_SCAN</td>
<td align="center">Start AF sweep, Lens now moving</td>
</tr>
<tr>
<td align="center">ACTIVE_SCAN</td>
<td align="center">AF sweep done</td>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">Focused, Lens now locked</td>
</tr>
<tr>
<td align="center">ACTIVE_SCAN</td>
<td align="center">AF sweep done</td>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">Not focused, Lens now locked</td>
</tr>
<tr>
<td align="center">ACTIVE_SCAN</td>
<td align="center">AF_CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Cancel/reset AF, Lens now locked</td>
</tr>
<tr>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">AF_CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Cancel/reset AF</td>
</tr>
<tr>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">AF_TRIGGER</td>
<td align="center">ACTIVE_SCAN</td>
<td align="center">Start new sweep, Lens now moving</td>
</tr>
<tr>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">AF_CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Cancel/reset AF</td>
</tr>
<tr>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">AF_TRIGGER</td>
<td align="center">ACTIVE_SCAN</td>
<td align="center">Start new sweep, Lens now moving</td>
</tr>
<tr>
<td align="center">Any state</td>
<td align="center">Mode change</td>
<td align="center">INACTIVE</td>
<td align="center"></td>
</tr>
</tbody>
</table>
For the above table, the camera device may skip reporting any state changes that happen
without application intervention (i.e. mode switch, trigger, locking). Any state that
can be skipped in that manner is called a transient state.
For example, for these AF modes (AF_MODE_AUTO and AF_MODE_MACRO), in addition to the
state transitions listed in above table, it is also legal for the camera device to skip
one or more transient states between two results. See below table for examples:
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center">AF_TRIGGER</td>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">Focus is already good or good after a scan, lens is now locked.</td>
</tr>
<tr>
<td align="center">INACTIVE</td>
<td align="center">AF_TRIGGER</td>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">Focus failed after a scan, lens is now locked.</td>
</tr>
<tr>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">AF_TRIGGER</td>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">Focus is already good or good after a scan, lens is now locked.</td>
</tr>
<tr>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">AF_TRIGGER</td>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">Focus is good after a scan, lens is not locked.</td>
</tr>
</tbody>
</table>
When <a href="#controls_android.control.afMode">android.control.afMode</a> is AF_MODE_CONTINUOUS_VIDEO:
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center">Camera device initiates new scan</td>
<td align="center">PASSIVE_SCAN</td>
<td align="center">Start AF scan, Lens now moving</td>
</tr>
<tr>
<td align="center">INACTIVE</td>
<td align="center">AF_TRIGGER</td>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">AF state query, Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_SCAN</td>
<td align="center">Camera device completes current scan</td>
<td align="center">PASSIVE_FOCUSED</td>
<td align="center">End AF scan, Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_SCAN</td>
<td align="center">Camera device fails current scan</td>
<td align="center">PASSIVE_UNFOCUSED</td>
<td align="center">End AF scan, Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_SCAN</td>
<td align="center">AF_TRIGGER</td>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">Immediate transition, if focus is good. Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_SCAN</td>
<td align="center">AF_TRIGGER</td>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">Immediate transition, if focus is bad. Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_SCAN</td>
<td align="center">AF_CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Reset lens position, Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_FOCUSED</td>
<td align="center">Camera device initiates new scan</td>
<td align="center">PASSIVE_SCAN</td>
<td align="center">Start AF scan, Lens now moving</td>
</tr>
<tr>
<td align="center">PASSIVE_UNFOCUSED</td>
<td align="center">Camera device initiates new scan</td>
<td align="center">PASSIVE_SCAN</td>
<td align="center">Start AF scan, Lens now moving</td>
</tr>
<tr>
<td align="center">PASSIVE_FOCUSED</td>
<td align="center">AF_TRIGGER</td>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">Immediate transition, lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_UNFOCUSED</td>
<td align="center">AF_TRIGGER</td>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">Immediate transition, lens now locked</td>
</tr>
<tr>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">AF_TRIGGER</td>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">No effect</td>
</tr>
<tr>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">AF_CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Restart AF scan</td>
</tr>
<tr>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">AF_TRIGGER</td>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">No effect</td>
</tr>
<tr>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">AF_CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Restart AF scan</td>
</tr>
</tbody>
</table>
When <a href="#controls_android.control.afMode">android.control.afMode</a> is AF_MODE_CONTINUOUS_PICTURE:
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center">Camera device initiates new scan</td>
<td align="center">PASSIVE_SCAN</td>
<td align="center">Start AF scan, Lens now moving</td>
</tr>
<tr>
<td align="center">INACTIVE</td>
<td align="center">AF_TRIGGER</td>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">AF state query, Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_SCAN</td>
<td align="center">Camera device completes current scan</td>
<td align="center">PASSIVE_FOCUSED</td>
<td align="center">End AF scan, Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_SCAN</td>
<td align="center">Camera device fails current scan</td>
<td align="center">PASSIVE_UNFOCUSED</td>
<td align="center">End AF scan, Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_SCAN</td>
<td align="center">AF_TRIGGER</td>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">Eventual transition once the focus is good. Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_SCAN</td>
<td align="center">AF_TRIGGER</td>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">Eventual transition if cannot find focus. Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_SCAN</td>
<td align="center">AF_CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Reset lens position, Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_FOCUSED</td>
<td align="center">Camera device initiates new scan</td>
<td align="center">PASSIVE_SCAN</td>
<td align="center">Start AF scan, Lens now moving</td>
</tr>
<tr>
<td align="center">PASSIVE_UNFOCUSED</td>
<td align="center">Camera device initiates new scan</td>
<td align="center">PASSIVE_SCAN</td>
<td align="center">Start AF scan, Lens now moving</td>
</tr>
<tr>
<td align="center">PASSIVE_FOCUSED</td>
<td align="center">AF_TRIGGER</td>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">Immediate trans. Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_UNFOCUSED</td>
<td align="center">AF_TRIGGER</td>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">Immediate trans. Lens now locked</td>
</tr>
<tr>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">AF_TRIGGER</td>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">No effect</td>
</tr>
<tr>
<td align="center">FOCUSED_LOCKED</td>
<td align="center">AF_CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Restart AF scan</td>
</tr>
<tr>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">AF_TRIGGER</td>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">No effect</td>
</tr>
<tr>
<td align="center">NOT_FOCUSED_LOCKED</td>
<td align="center">AF_CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Restart AF scan</td>
</tr>
</tbody>
</table>
When switch between AF_MODE_CONTINUOUS_* (CAF modes) and AF_MODE_AUTO/AF_MODE_MACRO
(AUTO modes), the initial INACTIVE or PASSIVE_SCAN states may be skipped by the
camera device. When a trigger is included in a mode switch request, the trigger
will be evaluated in the context of the new mode in the request.
See below table for examples:
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">any state</td>
<td align="center">CAF-->AUTO mode switch</td>
<td align="center">INACTIVE</td>
<td align="center">Mode switch without trigger, initial state must be INACTIVE</td>
</tr>
<tr>
<td align="center">any state</td>
<td align="center">CAF-->AUTO mode switch with AF_TRIGGER</td>
<td align="center">trigger-reachable states from INACTIVE</td>
<td align="center">Mode switch with trigger, INACTIVE is skipped</td>
</tr>
<tr>
<td align="center">any state</td>
<td align="center">AUTO-->CAF mode switch</td>
<td align="center">passively reachable states from INACTIVE</td>
<td align="center">Mode switch without trigger, passive transient state is skipped</td>
</tr>
</tbody>
</table>
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.afTriggerId">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.control.afTriggerId
 </td>
 <td class="entry_type">
 int32

[system]

[deprecated]

</td>

<td class="entry_description">
 The ID sent with the latest
CAMERA2_TRIGGER_AUTOFOCUS call
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Must be 0 if no CAMERA2_TRIGGER_AUTOFOCUS trigger
received yet by HAL. Always updated even if AF algorithm
ignores the trigger
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.awbLock">
 <td class="entry_name
 " rowspan="3">
 android.control.awbLock
 </td>
 <td class="entry_type">
 byte

[public as boolean]

[legacy]

</td>

<td class="entry_description">
 Whether auto-white balance (AWB) is currently locked to its
latest calculated values.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When set to <code>true</code> (ON), the AWB algorithm is locked to its latest parameters,
and will not change color balance settings until the lock is set to <code>false</code> (OFF).
Since the camera device has a pipeline of in-flight requests, the settings that
get locked do not necessarily correspond to the settings that were present in the
latest capture result received from the camera device, since additional captures
and AWB updates may have occurred even before the result was sent out. If an
application is switching between automatic and manual control and wishes to eliminate
any flicker during the switch, the following procedure is recommended:
<ol>
<li>Starting in auto-AWB mode:</li>
<li>Lock AWB</li>
<li>Wait for the first result to be output that has the AWB locked</li>
<li>Copy AWB settings from that result into a request, set the request to manual AWB</li>
<li>Submit the capture request, proceed to run manual AWB as desired.</li>
</ol>
Note that AWB lock is only meaningful when
<a href="#controls_android.control.awbMode">android.control.awbMode</a> is in the AUTO mode; in other modes,
AWB is already fixed to a specific setting.
Some LEGACY devices may not support ON; the value is then overridden to OFF.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.awbMode">
 <td class="entry_name
 " rowspan="3">
 android.control.awbMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_range">
 <a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control is only effective if <a href="#controls_android.control.mode">android.control.mode</a> is AUTO.
When set to the ON mode, the camera device's auto-white balance
routine is enabled, overriding the application's selected
<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>, <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> and
<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a>. Note that when <a href="#controls_android.control.aeMode">android.control.aeMode</a>
is OFF, the behavior of AWB is device dependent. It is recommened to
also set AWB mode to OFF or lock AWB by using <a href="#controls_android.control.awbLock">android.control.awbLock</a> before
setting AE mode to OFF.
When set to the OFF mode, the camera device's auto-white balance
routine is disabled. The application manually controls the white
balance by <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>, <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a>
and <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a>.
When set to any other modes, the camera device's auto-white
balance routine is disabled. The camera device uses each
particular illumination target for white balance
adjustment. The application's values for
<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>,
<a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> and
<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> are ignored.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.awbRegions">
 <td class="entry_name
 " rowspan="5">
 android.control.awbRegions
 </td>
 <td class="entry_type">
 int32
 x

5 x area_count
 
 [public as meteringRectangle]

</td>

<td class="entry_description">
 List of metering areas to use for auto-white-balance illuminant
estimation.
 </td>

<td class="entry_units">
 Pixel coordinates within android.sensor.info.activeArraySize
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Not available if <a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a> is 0.
Otherwise will always be present.
The maximum number of regions supported by the device is determined by the value
of <a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a>.
The coordinate system is based on the active pixel array,
with (0,0) being the top-left pixel in the active pixel array, and
(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,
<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the
bottom-right pixel in the active pixel array.
The weight must range from 0 to 1000, and represents a weight
for every pixel in the area. This means that a large metering area
with the same weight as a smaller area will have more effect in
the metering result. Metering areas can partially overlap and the
camera device will add the weights in the overlap region.
The weights are relative to weights of other white balance metering regions, so if
only one region is used, all non-zero weights will have the same effect. A region with
0 weight is ignored.
If all regions have 0 weight, then no specific metering area needs to be used by the
camera device.
If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> returned in
capture result metadata, the camera device will ignore the sections outside the crop
region and output only the intersection rectangle as the metering region in the result
metadata. If the region is entirely outside the crop region, it will be ignored and
not reported in the result metadata.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The HAL level representation of MeteringRectangle[] is a
int[5 * area_count].
Every five elements represent a metering region of
(xmin, ymin, xmax, ymax, weight).
The rectangle is defined to be inclusive on xmin and ymin, but
exclusive on xmax and ymax.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.captureIntent">
 <td class="entry_name
 " rowspan="3">
 android.control.captureIntent
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control (except for MANUAL) is only effective if
<code><a href="#controls_android.control.mode">android.control.mode</a> != OFF</code> and any 3A routine is active.
ZERO_SHUTTER_LAG will be supported if <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>
contains ZSL. MANUAL will be supported if <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>
contains MANUAL_SENSOR. Other intent values are always supported.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.awbState">
 <td class="entry_name
 " rowspan="3">
 android.control.awbState
 </td>
 <td class="entry_type">
 byte

[public]

[limited]

<ul class="entry_type_enum">
 <li>
 INACTIVE
 AWB is not in auto mode, or has not yet started metering.
When a camera device is opened, it starts in this
state. This is a transient state, the camera device may
skip reporting this state in capture
result.
 </li>
 <li>
 SEARCHING
 AWB doesn't yet have a good set of control
values for the current scene.
This is a transient state, the camera device
may skip reporting this state in capture result.
 </li>
 <li>
 CONVERGED
 AWB has a good set of control values for the
current scene.
 </li>
 <li>
 LOCKED
 AWB has been locked.
 </li>
 </ul>

</td>

<td class="entry_description">
 Current state of auto-white balance (AWB) algorithm.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.effectMode">
 <td class="entry_name
 " rowspan="3">
 android.control.effectMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 A special color effect to apply.
 </td>

<td class="entry_range">
 <a href="#static_android.control.availableEffects">android.control.availableEffects</a>
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.mode">
 <td class="entry_name
 " rowspan="3">
 android.control.mode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control
routines.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.sceneMode">
 <td class="entry_name
 " rowspan="5">
 android.control.sceneMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 Control for which scene mode is currently active.
 </td>

<td class="entry_range">
 <a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a>
 </td>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 HAL implementations that include scene modes are expected to provide
the per-scene settings to use for <a href="#controls_android.control.aeMode">android.control.aeMode</a>,
<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a> in
<a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a>.
For HIGH_SPEED_VIDEO mode, if it is included in <a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a>,
the HAL must list supported video size and fps range in
<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a>. For a given size, e.g.
1280x720, if the HAL has two different sensor configurations for normal streaming
mode and high speed streaming, when this scene mode is set/reset in a sequence of capture
requests, the HAL may have to switch between different sensor modes.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.control.videoStabilizationMode">
 <td class="entry_name
 " rowspan="3">
 android.control.videoStabilizationMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 Whether video stabilization is
active.
 </td>

</tbody>

<tr><td colspan="6" id="section_demosaic" class="section">demosaic</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.demosaic.mode">
 <td class="entry_name
 " rowspan="1">
 android.demosaic.mode
 </td>
 <td class="entry_type">
 byte

[system]

<ul class="entry_type_enum">
 <li>
 FAST
 Minimal or no slowdown of frame rate compared to
Bayer RAW output.
 </li>
 <li>
 HIGH_QUALITY
 Improved processing quality but the frame rate is slowed down
relative to raw output.
 </li>
 </ul>

</td>

<td class="entry_description">
 Controls the quality of the demosaicing
processing.
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

</tbody>

<tr><td colspan="6" id="section_edge" class="section">edge</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.edge.mode">
 <td class="entry_name
 " rowspan="3">
 android.edge.mode
 </td>
 <td class="entry_type">
 byte

[public]

[full]

<ul class="entry_type_enum">
 <li>
 OFF
 No edge enhancement is applied.
 </li>
 <li>
 FAST
 Apply edge enhancement at a quality level that does not slow down frame rate relative to sensor
output
 </li>
 <li>
 HIGH_QUALITY
 Apply high-quality edge enhancement, at a cost of reducing output frame rate.
 </li>
 </ul>

</td>

<td class="entry_description">
 Operation mode for edge
enhancement.
 </td>

<td class="entry_range">
 <a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Edge enhancement improves sharpness and details in the captured image. OFF means
no enhancement will be applied by the camera device.
FAST/HIGH_QUALITY both mean camera device determined enhancement
will be applied. HIGH_QUALITY mode indicates that the
camera device will use the highest-quality enhancement algorithms,
even if it slows down capture rate. FAST means the camera device will
not slow down capture rate when applying edge enhancement.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.edge.strength">
 <td class="entry_name
 " rowspan="1">
 android.edge.strength
 </td>
 <td class="entry_type">
 byte

[system]

</td>

<td class="entry_description">
 Control the amount of edge enhancement
applied to the images
 </td>

<td class="entry_units">
 1-10; 10 is maximum sharpening
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.edge.availableEdgeModes">
 <td class="entry_name
 " rowspan="3">
 android.edge.availableEdgeModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[full]

<div class="entry_type_notes">list of enums</div>

</td>

<td class="entry_description">
 List of edge enhancement modes for <a href="#controls_android.edge.mode">android.edge.mode</a> that are supported by this camera
device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.edge.mode">android.edge.mode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Full-capability camera devices must always support OFF; all devices will list FAST.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.edge.mode">
 <td class="entry_name
 " rowspan="3">
 android.edge.mode
 </td>
 <td class="entry_type">
 byte

[public]

[full]

</td>

<td class="entry_description">
 Operation mode for edge
enhancement.
 </td>

<td class="entry_range">
 <a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a>
 </td>

</tbody>

<tr><td colspan="6" id="section_flash" class="section">flash</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.flash.firingPower">
 <td class="entry_name
 " rowspan="3">
 android.flash.firingPower
 </td>
 <td class="entry_type">
 byte

[system]

</td>

<td class="entry_description">
 Power for flash firing/torch
 </td>

<td class="entry_units">
 10 is max power; 0 is no flash. Linear
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Power for snapshot may use a different scale than
for torch mode. Only one entry for torch mode will be
used
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.flash.firingTime">
 <td class="entry_name
 " rowspan="3">
 android.flash.firingTime
 </td>
 <td class="entry_type">
 int64

[system]

</td>

<td class="entry_description">
 Firing time of flash relative to start of
exposure
 </td>

<td class="entry_units">
 nanoseconds
 </td>

<td class="entry_range">
 0-(exposure time-flash duration)
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Clamped to (0, exposure time - flash
duration).
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.flash.mode">
 <td class="entry_name
 " rowspan="3">
 android.flash.mode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 OFF
 Do not fire the flash for this capture.
 </li>
 <li>
 SINGLE
 If the flash is available and charged, fire flash
for this capture.
 </li>
 <li>
 TORCH
 Transition flash to continuously on.
 </li>
 </ul>

</td>

<td class="entry_description">
 The desired mode for for the camera device's flash control.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control is only effective when flash unit is available
(<code><a href="#static_android.flash.info.available">android.flash.info.available</a> == true</code>).
When this control is used, the <a href="#controls_android.control.aeMode">android.control.aeMode</a> must be set to ON or OFF.
Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH,
ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.
When set to OFF, the camera device will not fire flash for this capture.
When set to SINGLE, the camera device will fire flash regardless of the camera
device's auto-exposure routine's result. When used in still capture case, this
control should be used along with auto-exposure (AE) precapture metering sequence
(<a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>), otherwise, the image may be incorrectly exposed.
When set to TORCH, the flash will be on continuously. This mode can be used
for use cases such as preview, auto-focus assist, still capture, or video recording.
The flash status will be reported by <a href="#dynamic_android.flash.state">android.flash.state</a> in the capture result metadata.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.flash.info.available">
 <td class="entry_name
 " rowspan="3">
 android.flash.info.available
 </td>
 <td class="entry_type">
 byte

[public as boolean]

[legacy]

<ul class="entry_type_enum">
 <li>
 FALSE
 </li>
 <li>
 TRUE
 </li>
 </ul>

</td>

<td class="entry_description">
 Whether this camera device has a
flash unit.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Will be <code>false</code> if no flash is available.
If there is no flash unit, none of the flash controls do
anything.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.flash.info.chargeDuration">
 <td class="entry_name
 " rowspan="3">
 android.flash.info.chargeDuration
 </td>
 <td class="entry_type">
 int64

[system]

</td>

<td class="entry_description">
 Time taken before flash can fire
again
 </td>

<td class="entry_units">
 nanoseconds
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 1 second too long/too short for recharge? Should
this be power-dependent?
 </td>
 </tr>

<tr class="entry" id="static_android.flash.colorTemperature">
 <td class="entry_name
 " rowspan="1">
 android.flash.colorTemperature
 </td>
 <td class="entry_type">
 byte

[system]

</td>

<td class="entry_description">
 The x,y whitepoint of the
flash
 </td>

<td class="entry_units">
 pair of floats
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.flash.maxEnergy">
 <td class="entry_name
 " rowspan="1">
 android.flash.maxEnergy
 </td>
 <td class="entry_type">
 byte

[system]

</td>

<td class="entry_description">
 Max energy output of the flash for a full
power single flash
 </td>

<td class="entry_units">
 lumen-seconds
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.flash.firingPower">
 <td class="entry_name
 " rowspan="3">
 android.flash.firingPower
 </td>
 <td class="entry_type">
 byte

[system]

</td>

<td class="entry_description">
 Power for flash firing/torch
 </td>

<td class="entry_units">
 10 is max power; 0 is no flash. Linear
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.flash.firingTime">
 <td class="entry_name
 " rowspan="3">
 android.flash.firingTime
 </td>
 <td class="entry_type">
 int64

[system]

</td>

<td class="entry_description">
 Firing time of flash relative to start of
exposure
 </td>

<td class="entry_units">
 nanoseconds
 </td>

<td class="entry_range">
 0-(exposure time-flash duration)
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.flash.mode">
 <td class="entry_name
 " rowspan="3">
 android.flash.mode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 The desired mode for for the camera device's flash control.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control is only effective when flash unit is available
(<code><a href="#static_android.flash.info.available">android.flash.info.available</a> == true</code>).
When this control is used, the <a href="#controls_android.control.aeMode">android.control.aeMode</a> must be set to ON or OFF.
Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH,
ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.
When set to OFF, the camera device will not fire flash for this capture.
When set to SINGLE, the camera device will fire flash regardless of the camera
device's auto-exposure routine's result. When used in still capture case, this
control should be used along with auto-exposure (AE) precapture metering sequence
(<a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>), otherwise, the image may be incorrectly exposed.
When set to TORCH, the flash will be on continuously. This mode can be used
for use cases such as preview, auto-focus assist, still capture, or video recording.
The flash status will be reported by <a href="#dynamic_android.flash.state">android.flash.state</a> in the capture result metadata.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.flash.state">
 <td class="entry_name
 " rowspan="3">
 android.flash.state
 </td>
 <td class="entry_type">
 byte

[public]

[limited]

<ul class="entry_type_enum">
 <li>
 UNAVAILABLE
 No flash on camera.
 </li>
 <li>
 CHARGING
 Flash is charging and cannot be fired.
 </li>
 <li>
 READY
 Flash is ready to fire.
 </li>
 <li>
 FIRED
 Flash fired for this capture.
 </li>
 <li>
 PARTIAL
 Flash partially illuminated this frame.
This is usually due to the next or previous frame having
the flash fire, and the flash spilling into this capture
due to hardware limitations.
 </li>
 </ul>

</td>

<td class="entry_description">
 Current state of the flash
unit.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When the camera device doesn't have flash unit
(i.e. <code><a href="#static_android.flash.info.available">android.flash.info.available</a> == false</code>), this state will always be UNAVAILABLE.
Other states indicate the current flash status.
In certain conditions, this will be available on LEGACY devices:
<ul>
<li>Flash-less cameras always return UNAVAILABLE.</li>
<li>Using <a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>==</code> ON_ALWAYS_FLASH
 will always return FIRED.</li>
<li>Using <a href="#controls_android.flash.mode">android.flash.mode</a> <code>==</code> TORCH
 will always return FIRED.</li>
</ul>
In all other conditions the state will not be available on
LEGACY devices (i.e. it will be <code>null</code>).
 </td>
 </tr>

</tbody>

<tr><td colspan="6" id="section_hotPixel" class="section">hotPixel</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.hotPixel.mode">
 <td class="entry_name
 " rowspan="3">
 android.hotPixel.mode
 </td>
 <td class="entry_type">
 byte

[public]

<ul class="entry_type_enum">
 <li>
 OFF
 No hot pixel correction is applied.
The frame rate must not be reduced relative to sensor raw output
for this option.
The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a>.
 </li>
 <li>
 FAST
 Hot pixel correction is applied, without reducing frame
rate relative to sensor raw output.
The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a>.
 </li>
 <li>
 HIGH_QUALITY
 High-quality hot pixel correction is applied, at a cost
of reducing frame rate relative to sensor raw output.
The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a>.
 </li>
 </ul>

</td>

<td class="entry_description">
 Operational mode for hot pixel correction.
 </td>

<td class="entry_range">
 <a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Hotpixel correction interpolates out, or otherwise removes, pixels
that do not accurately measure the incoming light (i.e. pixels that
are stuck at an arbitrary value or are oversensitive).
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.hotPixel.availableHotPixelModes">
 <td class="entry_name
 " rowspan="5">
 android.hotPixel.availableHotPixelModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

<div class="entry_type_notes">list of enums</div>

</td>

<td class="entry_description">
 List of hot pixel correction modes for <a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a> that are supported by this
camera device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 FULL mode camera devices will always support FAST.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 To avoid performance issues, there will be significantly fewer hot
pixels than actual pixels on the camera sensor.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.hotPixel.mode">
 <td class="entry_name
 " rowspan="3">
 android.hotPixel.mode
 </td>
 <td class="entry_type">
 byte

[public]

</td>

<td class="entry_description">
 Operational mode for hot pixel correction.
 </td>

</tbody>

<tr><td colspan="6" id="section_jpeg" class="section">jpeg</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.jpeg.gpsLocation">
 <td class="entry_name
 " rowspan="3">
 android.jpeg.gpsLocation
 </td>
 <td class="entry_type">
 byte

[public as location]

[synthetic]

[legacy]

</td>

<td class="entry_description">
 A location object to use when generating image GPS metadata.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Setting a location object in a request will include the GPS coordinates of the location
into any JPEG images captured based on the request. These coordinates can then be
viewed by anyone who receives the JPEG image.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.jpeg.gpsCoordinates">
 <td class="entry_name
 " rowspan="1">
 android.jpeg.gpsCoordinates
 </td>
 <td class="entry_type">
 double
 x

3
 
 [hidden]

[legacy]

<div class="entry_type_notes">latitude, longitude, altitude. First two in degrees, the third in meters</div>

</td>

<td class="entry_description">
 GPS coordinates to include in output JPEG
EXIF.
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.jpeg.gpsProcessingMethod">
 <td class="entry_name
 " rowspan="1">
 android.jpeg.gpsProcessingMethod
 </td>
 <td class="entry_type">
 byte

[hidden as string]

[legacy]

</td>

<td class="entry_description">
 32 characters describing GPS algorithm to
include in EXIF.
 </td>

<td class="entry_units">
 UTF-8 null-terminated string
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.jpeg.gpsTimestamp">
 <td class="entry_name
 " rowspan="1">
 android.jpeg.gpsTimestamp
 </td>
 <td class="entry_type">
 int64

[hidden]

[legacy]

</td>

<td class="entry_description">
 Time GPS fix was made to include in
EXIF.
 </td>

<td class="entry_units">
 UTC in seconds since January 1, 1970
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.jpeg.orientation">
 <td class="entry_name
 " rowspan="3">
 android.jpeg.orientation
 </td>
 <td class="entry_type">
 int32

[public]

[legacy]

</td>

<td class="entry_description">
 The orientation for a JPEG image.
 </td>

<td class="entry_units">
 Degrees in multiples of 90
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The clockwise rotation angle in degrees, relative to the orientation
to the camera, that the JPEG picture needs to be rotated by, to be viewed
upright.
Camera devices may either encode this value into the JPEG EXIF header, or
rotate the image data to match this orientation.
Note that this orientation is relative to the orientation of the camera sensor, given
by <a href="#static_android.sensor.orientation">android.sensor.orientation</a>.
To translate from the device orientation given by the Android sensor APIs, the following
sample code may be used:
<pre><code>private int getJpegOrientation(CameraCharacteristics c, int deviceOrientation) {
 if (deviceOrientation == android.view.OrientationEventListener.ORIENTATION_UNKNOWN) return 0;
 int sensorOrientation = c.get(CameraCharacteristics.SENSOR_ORIENTATION);

// Round device orientation to a multiple of 90
 deviceOrientation = (deviceOrientation + 45) / 90 * 90;

// Reverse device orientation for front-facing cameras
 boolean facingFront = c.get(CameraCharacteristics.LENS_FACING) == CameraCharacteristics.LENS_FACING_FRONT;
 if (facingFront) deviceOrientation = -deviceOrientation;

// Calculate desired JPEG orientation relative to camera orientation to make
 // the image upright relative to the device orientation
 int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360;

return jpegOrientation;
}
</code></pre>
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.jpeg.quality">
 <td class="entry_name
 " rowspan="3">
 android.jpeg.quality
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 Compression quality of the final JPEG
image.
 </td>

<td class="entry_range">
 1-100; larger is higher quality
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 85-95 is typical usage range.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.jpeg.thumbnailQuality">
 <td class="entry_name
 " rowspan="1">
 android.jpeg.thumbnailQuality
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 Compression quality of JPEG
thumbnail.
 </td>

<td class="entry_range">
 1-100; larger is higher quality
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.jpeg.thumbnailSize">
 <td class="entry_name
 " rowspan="5">
 android.jpeg.thumbnailSize
 </td>
 <td class="entry_type">
 int32
 x

2
 
 [public as size]

[legacy]

</td>

<td class="entry_description">
 Resolution of embedded JPEG thumbnail.
 </td>

<td class="entry_range">
 <a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When set to (0, 0) value, the JPEG EXIF will not contain thumbnail,
but the captured JPEG will still be a valid image.
For best results, when issuing a request for a JPEG image, the thumbnail size selected
should have the same aspect ratio as the main JPEG output.
If the thumbnail image aspect ratio differs from the JPEG primary image aspect
ratio, the camera device creates the thumbnail by cropping it from the primary image.
For example, if the primary image has 4:3 aspect ratio, the thumbnail image has
16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to
generate the thumbnail image. The thumbnail image will always have a smaller Field
Of View (FOV) than the primary image when aspect ratios differ.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The HAL must not squeeze or stretch the downscaled primary image to generate thumbnail.
The cropping must be done on the primary jpeg image rather than the sensor active array.
The stream cropping rule specified by "S5. Cropping" in camera3.h doesn't apply to the
thumbnail image cropping.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.jpeg.availableThumbnailSizes">
 <td class="entry_name
 " rowspan="3">
 android.jpeg.availableThumbnailSizes
 </td>
 <td class="entry_type">
 int32
 x

2 x n
 
 [public as size]

[legacy]

</td>

<td class="entry_description">
 List of JPEG thumbnail sizes for <a href="#controls_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a> supported by this
camera device.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This list will include at least one non-zero resolution, plus <code>(0,0)</code> for indicating no
thumbnail should be generated.
Below condiditions will be satisfied for this size list:
<ul>
<li>The sizes will be sorted by increasing pixel area (width x height).
If several resolutions have the same area, they will be sorted by increasing width.</li>
<li>The aspect ratio of the largest thumbnail size will be same as the
aspect ratio of largest JPEG output size in <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a>.
The largest size is defined as the size that has the largest pixel area
in a given size list.</li>
<li>Each output JPEG size in <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a> will have at least
one corresponding size that has the same aspect ratio in availableThumbnailSizes,
and vice versa.</li>
<li>All non-<code>(0, 0)</code> sizes will have non-zero widths and heights.</li>
</ul>
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.jpeg.maxSize">
 <td class="entry_name
 " rowspan="3">
 android.jpeg.maxSize
 </td>
 <td class="entry_type">
 int32

[system]

</td>

<td class="entry_description">
 Maximum size in bytes for the compressed
JPEG buffer
 </td>

<td class="entry_range">
 Must be large enough to fit any JPEG produced by
the camera
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This is used for sizing the gralloc buffers for
JPEG
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.jpeg.gpsLocation">
 <td class="entry_name
 " rowspan="3">
 android.jpeg.gpsLocation
 </td>
 <td class="entry_type">
 byte

[public as location]

[synthetic]

[legacy]

</td>

<td class="entry_description">
 A location object to use when generating image GPS metadata.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.jpeg.gpsCoordinates">
 <td class="entry_name
 " rowspan="1">
 android.jpeg.gpsCoordinates
 </td>
 <td class="entry_type">
 double
 x

3
 
 [hidden]

[legacy]

<div class="entry_type_notes">latitude, longitude, altitude. First two in degrees, the third in meters</div>

</td>

<td class="entry_description">
 GPS coordinates to include in output JPEG
EXIF.
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.jpeg.gpsProcessingMethod">
 <td class="entry_name
 " rowspan="1">
 android.jpeg.gpsProcessingMethod
 </td>
 <td class="entry_type">
 byte

[hidden as string]

[legacy]

</td>

<td class="entry_description">
 32 characters describing GPS algorithm to
include in EXIF.
 </td>

<td class="entry_units">
 UTF-8 null-terminated string
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.jpeg.gpsTimestamp">
 <td class="entry_name
 " rowspan="1">
 android.jpeg.gpsTimestamp
 </td>
 <td class="entry_type">
 int64

[hidden]

[legacy]

</td>

<td class="entry_description">
 Time GPS fix was made to include in
EXIF.
 </td>

<td class="entry_units">
 UTC in seconds since January 1, 1970
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.jpeg.orientation">
 <td class="entry_name
 " rowspan="3">
 android.jpeg.orientation
 </td>
 <td class="entry_type">
 int32

[public]

[legacy]

</td>

<td class="entry_description">
 The orientation for a JPEG image.
 </td>

<td class="entry_units">
 Degrees in multiples of 90
 </td>

// Round device orientation to a multiple of 90
 deviceOrientation = (deviceOrientation + 45) / 90 * 90;

return jpegOrientation;
}
</code></pre>
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.jpeg.quality">
 <td class="entry_name
 " rowspan="3">
 android.jpeg.quality
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 Compression quality of the final JPEG
image.
 </td>

<td class="entry_range">
 1-100; larger is higher quality
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.jpeg.size">
 <td class="entry_name
 " rowspan="3">
 android.jpeg.size
 </td>
 <td class="entry_type">
 int32

[system]

</td>

<td class="entry_description">
 The size of the compressed JPEG image, in
bytes
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If no JPEG output is produced for the request,
this must be 0.
Otherwise, this describes the real size of the compressed
JPEG image placed in the output stream. More specifically,
if <a href="#static_android.jpeg.maxSize">android.jpeg.maxSize</a> = 1000000, and a specific capture
has <a href="#dynamic_android.jpeg.size">android.jpeg.size</a> = 500000, then the output buffer from
the JPEG stream will be 1000000 bytes, of which the first
500000 make up the real data.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.jpeg.thumbnailQuality">
 <td class="entry_name
 " rowspan="1">
 android.jpeg.thumbnailQuality
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 Compression quality of JPEG
thumbnail.
 </td>

<td class="entry_range">
 1-100; larger is higher quality
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.jpeg.thumbnailSize">
 <td class="entry_name
 " rowspan="5">
 android.jpeg.thumbnailSize
 </td>
 <td class="entry_type">
 int32
 x

2
 
 [public as size]

[legacy]

</td>

<td class="entry_description">
 Resolution of embedded JPEG thumbnail.
 </td>

<td class="entry_range">
 <a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When set to (0, 0) value, the JPEG EXIF will not contain thumbnail,
but the captured JPEG will still be a valid image.
For best results, when issuing a request for a JPEG image, the thumbnail size selected
should have the same aspect ratio as the main JPEG output.
If the thumbnail image aspect ratio differs from the JPEG primary image aspect
ratio, the camera device creates the thumbnail by cropping it from the primary image.
For example, if the primary image has 4:3 aspect ratio, the thumbnail image has
16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to
generate the thumbnail image. The thumbnail image will always have a smaller Field
Of View (FOV) than the primary image when aspect ratios differ.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The HAL must not squeeze or stretch the downscaled primary image to generate thumbnail.
The cropping must be done on the primary jpeg image rather than the sensor active array.
The stream cropping rule specified by "S5. Cropping" in camera3.h doesn't apply to the
thumbnail image cropping.
 </td>
 </tr>

</tbody>

<tr><td colspan="6" id="section_lens" class="section">lens</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.lens.aperture">
 <td class="entry_name
 " rowspan="3">
 android.lens.aperture
 </td>
 <td class="entry_type">
 float

[public]

[full]

</td>

<td class="entry_description">
 The desired lens aperture size, as a ratio of lens focal length to the
effective aperture diameter.
 </td>

<td class="entry_units">
 The f-number (f/N)
 </td>

<td class="entry_range">
 <a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Setting this value is only supported on the camera devices that have a variable
aperture lens.
When this is supported and <a href="#controls_android.control.aeMode">android.control.aeMode</a> is OFF,
this can be set along with <a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,
<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, and <a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a>
to achieve manual exposure control.
The requested aperture value may take several frames to reach the
requested value; the camera device will report the current (intermediate)
aperture size in capture result metadata while the aperture is changing.
While the aperture is still changing, <a href="#dynamic_android.lens.state">android.lens.state</a> will be set to MOVING.
When this is supported and <a href="#controls_android.control.aeMode">android.control.aeMode</a> is one of
the ON modes, this will be overridden by the camera device
auto-exposure algorithm, the overridden values are then provided
back to the user in the corresponding result.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.lens.filterDensity">
 <td class="entry_name
 " rowspan="3">
 android.lens.filterDensity
 </td>
 <td class="entry_type">
 float

[public]

[full]

</td>

<td class="entry_description">
 The desired setting for the lens neutral density filter(s).
 </td>

<td class="entry_units">
 Exposure Value (EV)
 </td>

<td class="entry_range">
 <a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control will not be supported on most camera devices.
Lens filters are typically used to lower the amount of light the
sensor is exposed to (measured in steps of EV). As used here, an EV
step is the standard logarithmic representation, which are
non-negative, and inversely proportional to the amount of light
hitting the sensor. For example, setting this to 0 would result
in no reduction of the incoming light, and setting this to 2 would
mean that the filter is set to reduce incoming light by two stops
(allowing 1/4 of the prior amount of light to the sensor).
It may take several frames before the lens filter density changes
to the requested value. While the filter density is still changing,
<a href="#dynamic_android.lens.state">android.lens.state</a> will be set to MOVING.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.lens.focalLength">
 <td class="entry_name
 " rowspan="3">
 android.lens.focalLength
 </td>
 <td class="entry_type">
 float

[public]

[legacy]

</td>

<td class="entry_description">
 The desired lens focal length; used for optical zoom.
 </td>

<td class="entry_units">
 Millimeters
 </td>

<td class="entry_range">
 <a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This setting controls the physical focal length of the camera
device's lens. Changing the focal length changes the field of
view of the camera device, and is usually used for optical zoom.
Like <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> and <a href="#controls_android.lens.aperture">android.lens.aperture</a>, this
setting won't be applied instantaneously, and it may take several
frames before the lens can change to the requested focal length.
While the focal length is still changing, <a href="#dynamic_android.lens.state">android.lens.state</a> will
be set to MOVING.
Optical zoom will not be supported on most devices.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.lens.focusDistance">
 <td class="entry_name
 " rowspan="3">
 android.lens.focusDistance
 </td>
 <td class="entry_type">
 float

[public]

[full]

</td>

<td class="entry_description">
 Desired distance to plane of sharpest focus,
measured from frontmost surface of the lens.
 </td>

<td class="entry_units">
 See android.lens.info.focusDistanceCalibration for details
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control can be used for setting manual focus, on devices that support
the MANUAL_SENSOR capability and have a variable-focus lens (see
<a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a>).
A value of <code>0.0f</code> means infinity focus. The value set will be clamped to
<code>[0.0f, <a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a>]</code>.
Like <a href="#controls_android.lens.focalLength">android.lens.focalLength</a>, this setting won't be applied
instantaneously, and it may take several frames before the lens
can move to the requested focus distance. While the lens is still moving,
<a href="#dynamic_android.lens.state">android.lens.state</a> will be set to MOVING.
LEGACY devices support at most setting this to <code>0.0f</code>
for infinity focus.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.lens.opticalStabilizationMode">
 <td class="entry_name
 " rowspan="3">
 android.lens.opticalStabilizationMode
 </td>
 <td class="entry_type">
 byte

[public]

[limited]

<ul class="entry_type_enum">
 <li>
 OFF
 Optical stabilization is unavailable.
 </li>
 <li>
 ON
 [optional]
 Optical stabilization is enabled.
 </li>
 </ul>

</td>

<td class="entry_description">
 Sets whether the camera device uses optical image stabilization (OIS)
when capturing images.
 </td>

<td class="entry_range">
 <a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 OIS is used to compensate for motion blur due to small
movements of the camera during capture. Unlike digital image
stabilization (<a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a>), OIS
makes use of mechanical elements to stabilize the camera
sensor, and thus allows for longer exposure times before
camera shake becomes apparent.
Switching between different optical stabilization modes may take several
frames to initialize, the camera device will report the current mode in
capture result metadata. For example, When "ON" mode is requested, the
optical stabilization modes in the first several capture results may still
be "OFF", and it will become "ON" when the initialization is done.
If a camera device supports both OIS and digital image stabilization
(<a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a>), turning both modes on may produce undesirable
interaction, so it is recommended not to enable both at the same time.
Not all devices will support OIS; see
<a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a> for
available controls.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.lens.info.availableApertures">
 <td class="entry_name
 " rowspan="3">
 android.lens.info.availableApertures
 </td>
 <td class="entry_type">
 float
 x

n
 
 [public]

[full]

</td>

<td class="entry_description">
 List of aperture size values for <a href="#controls_android.lens.aperture">android.lens.aperture</a> that are
supported by this camera device.
 </td>

<td class="entry_units">
 The aperture f-number
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If the camera device doesn't support a variable lens aperture,
this list will contain only one value, which is the fixed aperture size.
If the camera device supports a variable aperture, the aperture values
in this list will be sorted in ascending order.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.lens.info.availableFilterDensities">
 <td class="entry_name
 " rowspan="3">
 android.lens.info.availableFilterDensities
 </td>
 <td class="entry_type">
 float
 x

n
 
 [public]

[full]

</td>

<td class="entry_description">
 List of neutral density filter values for
<a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> that are supported by this camera device.
 </td>

<td class="entry_units">
 Exposure value (EV)
 </td>

<td class="entry_range">
 Values are >= 0
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If a neutral density filter is not supported by this camera device,
this list will contain only 0. Otherwise, this list will include every
filter density supported by the camera device, in ascending order.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.lens.info.availableFocalLengths">
 <td class="entry_name
 " rowspan="3">
 android.lens.info.availableFocalLengths
 </td>
 <td class="entry_type">
 float
 x

n
 
 [public]

[legacy]

<div class="entry_type_notes">The list of available focal lengths</div>

</td>

<td class="entry_description">
 List of focal lengths for <a href="#controls_android.lens.focalLength">android.lens.focalLength</a> that are supported by this camera
device.
 </td>

<td class="entry_units">
 Millimeters
 </td>

<td class="entry_range">
 Values are > 0
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If optical zoom is not supported, this list will only contain
a single value corresponding to the fixed focal length of the
device. Otherwise, this list will include every focal length supported
by the camera device, in ascending order.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.lens.info.availableOpticalStabilization">
 <td class="entry_name
 " rowspan="3">
 android.lens.info.availableOpticalStabilization
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[limited]

<div class="entry_type_notes">list of enums</div>

</td>

<td class="entry_description">
 List of optical image stabilization (OIS) modes for
<a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> that are supported by this camera device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If OIS is not supported by a given camera device, this list will
contain only OFF.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.lens.info.hyperfocalDistance">
 <td class="entry_name
 " rowspan="3">
 android.lens.info.hyperfocalDistance
 </td>
 <td class="entry_type">
 float

[public]

[limited]

</td>

<td class="entry_description">
 Hyperfocal distance for this lens.
 </td>

<td class="entry_units">
 See android.lens.info.focusDistanceCalibration for details
 </td>

<td class="entry_range">
 If lens is fixed focus, >= 0. If lens has focuser unit, the value is
within <code>(0.0f, <a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a>]</code>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If the lens is not fixed focus, the camera device will report this
field when <a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a> is APPROXIMATE or CALIBRATED.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.lens.info.minimumFocusDistance">
 <td class="entry_name
 " rowspan="5">
 android.lens.info.minimumFocusDistance
 </td>
 <td class="entry_type">
 float

[public]

[limited]

</td>

<td class="entry_description">
 Shortest distance from frontmost surface
of the lens that can be brought into sharp focus.
 </td>

<td class="entry_units">
 See android.lens.info.focusDistanceCalibration for details
 </td>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Mandatory for FULL devices; LIMITED devices
must always set this value to 0 for fixed-focus; and may omit
the minimum focus distance otherwise.
This field is also mandatory for all devices advertising
the MANUAL_SENSOR capability.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.lens.info.shadingMapSize">
 <td class="entry_name
 " rowspan="3">
 android.lens.info.shadingMapSize
 </td>
 <td class="entry_type">
 int32
 x

2
 
 [hidden as size]

[full]

<div class="entry_type_notes">width and height (N, M) of lens shading map provided by the camera device.</div>

</td>

<td class="entry_description">
 Dimensions of lens shading map.
 </td>

<td class="entry_range">
 Both values >= 1
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The map should be on the order of 30-40 rows and columns, and
must be smaller than 64x64.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.lens.info.focusDistanceCalibration">
 <td class="entry_name
 " rowspan="5">
 android.lens.info.focusDistanceCalibration
 </td>
 <td class="entry_type">
 byte

[public]

[limited]

<ul class="entry_type_enum">
 <li>
 UNCALIBRATED
 The lens focus distance is not accurate, and the units used for
<a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> do not correspond to any physical units.
Setting the lens to the same focus distance on separate occasions may
result in a different real focus distance, depending on factors such
as the orientation of the device, the age of the focusing mechanism,
and the device temperature. The focus distance value will still be
in the range of <code>[0, <a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a>]</code>, where 0
represents the farthest focus.
 </li>
 <li>
 APPROXIMATE
 The lens focus distance is measured in diopters.
However, setting the lens to the same focus distance
on separate occasions may result in a different real
focus distance, depending on factors such as the
orientation of the device, the age of the focusing
mechanism, and the device temperature.
 </li>
 <li>
 CALIBRATED
 The lens focus distance is measured in diopters, and
is calibrated.
The lens mechanism is calibrated so that setting the
same focus distance is repeatable on multiple
occasions with good accuracy, and the focus distance
corresponds to the real physical distance to the plane
of best focus.
 </li>
 </ul>

</td>

<td class="entry_description">
 The lens focus distance calibration quality.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The lens focus distance calibration quality determines the reliability of
focus related metadata entries, i.e. <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a>,
<a href="#dynamic_android.lens.focusRange">android.lens.focusRange</a>, <a href="#static_android.lens.info.hyperfocalDistance">android.lens.info.hyperfocalDistance</a>, and
<a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a>.
APPROXIMATE and CALIBRATED devices report the focus metadata in
units of diopters (1/meter), so <code>0.0f</code> represents focusing at infinity,
and increasing positive numbers represent focusing closer and closer
to the camera device. The focus distance control also uses diopters
on these devices.
UNCALIBRATED devices do not use units that are directly comparable
to any real physical measurement, but <code>0.0f</code> still represents farthest
focus, and <a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> represents the
nearest focus the device can achieve.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For devices advertise APPROXIMATE quality or higher, diopters 0 (infinity
focus) must work. When autofocus is disabled (<a href="#controls_android.control.afMode">android.control.afMode</a> == OFF)
and the lens focus distance is set to 0 diopters
(<a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> == 0), the lens will move to focus at infinity
and is stably focused at infinity even if the device tilts. It may take the
lens some time to move; during the move the lens state should be MOVING and
the output diopter value should be changing toward 0.
 </td>
 </tr>

<tr class="entry" id="static_android.lens.facing">
 <td class="entry_name
 " rowspan="1">
 android.lens.facing
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 FRONT
 The camera device faces the same direction as the device's screen.
 </li>
 <li>
 BACK
 The camera device faces the opposite direction as the device's screen.
 </li>
 </ul>

</td>

<td class="entry_description">
 Direction the camera faces relative to
device screen.
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.lens.opticalAxisAngle">
 <td class="entry_name
 " rowspan="3">
 android.lens.opticalAxisAngle
 </td>
 <td class="entry_type">
 float
 x

2
 
 [system]

<div class="entry_type_notes">degrees. First defines the angle of separation between the perpendicular to the screen and the camera optical axis. The second then defines the clockwise rotation of the optical axis from native device up.</div>

</td>

<td class="entry_description">
 Relative angle of camera optical axis to the
perpendicular axis from the display
 </td>

<td class="entry_range">
 [0-90) for first angle, [0-360) for second
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Examples:
(0,0) means that the camera optical axis
is perpendicular to the display surface;
(45,0) means that the camera points 45 degrees up when
device is held upright;
(45,90) means the camera points 45 degrees to the right when
the device is held upright.
Use FACING field to determine perpendicular outgoing
direction
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.lens.position">
 <td class="entry_name
 " rowspan="1">
 android.lens.position
 </td>
 <td class="entry_type">
 float
 x

3, location in mm, in the sensor coordinate
 system
 
 [system]

</td>

<td class="entry_description">
 Coordinates of camera optical axis on
device
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.lens.aperture">
 <td class="entry_name
 " rowspan="3">
 android.lens.aperture
 </td>
 <td class="entry_type">
 float

[public]

[full]

</td>

<td class="entry_description">
 The desired lens aperture size, as a ratio of lens focal length to the
effective aperture diameter.
 </td>

<td class="entry_units">
 The f-number (f/N)
 </td>

<td class="entry_range">
 <a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a>
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.lens.filterDensity">
 <td class="entry_name
 " rowspan="3">
 android.lens.filterDensity
 </td>
 <td class="entry_type">
 float

[public]

[full]

</td>

<td class="entry_description">
 The desired setting for the lens neutral density filter(s).
 </td>

<td class="entry_units">
 Exposure Value (EV)
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control will not be supported on most camera devices.
Lens filters are typically used to lower the amount of light the
sensor is exposed to (measured in steps of EV). As used here, an EV
step is the standard logarithmic representation, which are
non-negative, and inversely proportional to the amount of light
hitting the sensor. For example, setting this to 0 would result
in no reduction of the incoming light, and setting this to 2 would
mean that the filter is set to reduce incoming light by two stops
(allowing 1/4 of the prior amount of light to the sensor).
It may take several frames before the lens filter density changes
to the requested value. While the filter density is still changing,
<a href="#dynamic_android.lens.state">android.lens.state</a> will be set to MOVING.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.lens.focalLength">
 <td class="entry_name
 " rowspan="3">
 android.lens.focalLength
 </td>
 <td class="entry_type">
 float

[public]

[legacy]

</td>

<td class="entry_description">
 The desired lens focal length; used for optical zoom.
 </td>

<td class="entry_units">
 Millimeters
 </td>

<td class="entry_range">
 <a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a>
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.lens.focusDistance">
 <td class="entry_name
 " rowspan="3">
 android.lens.focusDistance
 </td>
 <td class="entry_type">
 float

[public]

[full]

</td>

<td class="entry_description">
 Desired distance to plane of sharpest focus,
measured from frontmost surface of the lens.
 </td>

<td class="entry_units">
 See android.lens.info.focusDistanceCalibration for details
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Should be zero for fixed-focus cameras
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.lens.focusRange">
 <td class="entry_name
 " rowspan="3">
 android.lens.focusRange
 </td>
 <td class="entry_type">
 float
 x

2
 
 [public as pairFloatFloat]

[limited]

<div class="entry_type_notes">Range of scene distances that are in focus</div>

</td>

<td class="entry_description">
 The range of scene distances that are in
sharp focus (depth of field).
 </td>

<td class="entry_units">
 A pair of focus distances in diopters: (near,
 far); see android.lens.info.focusDistanceCalibration for details.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If variable focus not supported, can still report
fixed depth of field range
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.lens.opticalStabilizationMode">
 <td class="entry_name
 " rowspan="3">
 android.lens.opticalStabilizationMode
 </td>
 <td class="entry_type">
 byte

[public]

[limited]

</td>

<td class="entry_description">
 Sets whether the camera device uses optical image stabilization (OIS)
when capturing images.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.lens.state">
 <td class="entry_name
 " rowspan="3">
 android.lens.state
 </td>
 <td class="entry_type">
 byte

[public]

[limited]

<ul class="entry_type_enum">
 <li>
 STATIONARY
 The lens parameters (<a href="#controls_android.lens.focalLength">android.lens.focalLength</a>, <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a>,
<a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> and <a href="#controls_android.lens.aperture">android.lens.aperture</a>) are not changing.
 </li>
 <li>
 MOVING
 One or several of the lens parameters
(<a href="#controls_android.lens.focalLength">android.lens.focalLength</a>, <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a>,
<a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> or <a href="#controls_android.lens.aperture">android.lens.aperture</a>) is
currently changing.
 </li>
 </ul>

</td>

<td class="entry_description">
 Current lens status.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For lens parameters <a href="#controls_android.lens.focalLength">android.lens.focalLength</a>, <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a>,
<a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> and <a href="#controls_android.lens.aperture">android.lens.aperture</a>, when changes are requested,
they may take several frames to reach the requested values. This state indicates
the current status of the lens parameters.
When the state is STATIONARY, the lens parameters are not changing. This could be
either because the parameters are all fixed, or because the lens has had enough
time to reach the most recently-requested values.
If all these lens parameters are not changable for a camera device, as listed below:
<ul>
<li>Fixed focus (<code><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> == 0</code>), which means
<a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> parameter will always be 0.</li>
<li>Fixed focal length (<a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a> contains single value),
which means the optical zoom is not supported.</li>
<li>No ND filter (<a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a> contains only 0).</li>
<li>Fixed aperture (<a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a> contains single value).</li>
</ul>
Then this state will always be STATIONARY.
When the state is MOVING, it indicates that at least one of the lens parameters
is changing.
 </td>
 </tr>

</tbody>

<tr><td colspan="6" id="section_noiseReduction" class="section">noiseReduction</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.noiseReduction.mode">
 <td class="entry_name
 " rowspan="3">
 android.noiseReduction.mode
 </td>
 <td class="entry_type">
 byte

[public]

[full]

<ul class="entry_type_enum">
 <li>
 OFF
 No noise reduction is applied.
 </li>
 <li>
 FAST
 Noise reduction is applied without reducing frame rate relative to sensor
output.
 </li>
 <li>
 HIGH_QUALITY
 High-quality noise reduction is applied, at the cost of reducing frame rate
relative to sensor output.
 </li>
 </ul>

</td>

<td class="entry_description">
 Mode of operation for the noise reduction algorithm.
 </td>

<td class="entry_range">
 <a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The noise reduction algorithm attempts to improve image quality by removing
excessive noise added by the capture process, especially in dark conditions.
OFF means no noise reduction will be applied by the camera device.
FAST/HIGH_QUALITY both mean camera device determined noise filtering
will be applied. HIGH_QUALITY mode indicates that the camera device
will use the highest-quality noise filtering algorithms,
even if it slows down capture rate. FAST means the camera device will not
slow down capture rate when applying noise filtering.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.noiseReduction.strength">
 <td class="entry_name
 " rowspan="1">
 android.noiseReduction.strength
 </td>
 <td class="entry_type">
 byte

[system]

</td>

<td class="entry_description">
 Control the amount of noise reduction
applied to the images
 </td>

<td class="entry_units">
 1-10; 10 is max noise reduction
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.noiseReduction.availableNoiseReductionModes">
 <td class="entry_name
 " rowspan="3">
 android.noiseReduction.availableNoiseReductionModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[limited]

<div class="entry_type_notes">list of enums</div>

</td>

<td class="entry_description">
 List of noise reduction modes for <a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a> that are supported
by this camera device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Full-capability camera devices will always support OFF and FAST.
Legacy-capability camera devices will only support FAST mode.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.noiseReduction.mode">
 <td class="entry_name
 " rowspan="3">
 android.noiseReduction.mode
 </td>
 <td class="entry_type">
 byte

[public]

[full]

</td>

<td class="entry_description">
 Mode of operation for the noise reduction algorithm.
 </td>

</tbody>

<tr><td colspan="6" id="section_quirks" class="section">quirks</td></tr>

<tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.quirks.meteringCropRegion">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.quirks.meteringCropRegion
 </td>
 <td class="entry_type">
 byte

[system]

[deprecated]

</td>

<td class="entry_description">
 If set to 1, the camera service does not
scale 'normalized' coordinates with respect to the crop
region. This applies to metering input (a{e,f,wb}Region
and output (face rectangles).
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Normalized coordinates refer to those in the
(-1000,1000) range mentioned in the
android.hardware.Camera API.
HAL implementations should instead always use and emit
sensor array-relative coordinates for all region data. Does
not need to be listed in static metadata. Support will be
removed in future versions of camera service.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.quirks.triggerAfWithAuto">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.quirks.triggerAfWithAuto
 </td>
 <td class="entry_type">
 byte

[system]

[deprecated]

</td>

<td class="entry_description">
 If set to 1, then the camera service always
switches to FOCUS_MODE_AUTO before issuing a AF
trigger.
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 HAL implementations should implement AF trigger
modes for AUTO, MACRO, CONTINUOUS_FOCUS, and
CONTINUOUS_PICTURE modes instead of using this flag. Does
not need to be listed in static metadata. Support will be
removed in future versions of camera service
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.quirks.useZslFormat">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.quirks.useZslFormat
 </td>
 <td class="entry_type">
 byte

[system]

[deprecated]

</td>

<td class="entry_description">
 If set to 1, the camera service uses
CAMERA2_PIXEL_FORMAT_ZSL instead of
HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED for the zero
shutter lag stream
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 HAL implementations should use gralloc usage flags
to determine that a stream will be used for
zero-shutter-lag, instead of relying on an explicit
format setting. Does not need to be listed in static
metadata. Support will be removed in future versions of
camera service.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.quirks.usePartialResult">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="5">
 android.quirks.usePartialResult
 </td>
 <td class="entry_type">
 byte

[hidden]

[deprecated]

</td>

<td class="entry_description">
 If set to 1, the HAL will always split result
metadata for a single capture into multiple buffers,
returned using multiple process_capture_result calls.
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Does not need to be listed in static
metadata. Support for partial results will be reworked in
future versions of camera service. This quirk will stop
working at that point; DO NOT USE without careful
consideration of future support.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Refer to <code>camera3_capture_result::partial_result</code>
for information on how to implement partial results.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.quirks.partialResult">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="5">
 android.quirks.partialResult
 </td>
 <td class="entry_type">
 byte

[hidden as boolean]

[deprecated]

<ul class="entry_type_enum">
 <li>
 FINAL
 The last or only metadata result buffer
for this capture.
 </li>
 <li>
 PARTIAL
 A partial buffer of result metadata for this
capture. More result buffers for this capture will be sent
by the camera device, the last of which will be marked
FINAL.
 </li>
 </ul>

</td>

<td class="entry_description">
 Whether a result given to the framework is the
final one for the capture, or only a partial that contains a
subset of the full set of dynamic metadata
values.
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 Optional. Default value is FINAL.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The entries in the result metadata buffers for a
single capture may not overlap, except for this entry. The
FINAL buffers must retain FIFO ordering relative to the
requests that generate them, so the FINAL buffer for frame 3 must
always be sent to the framework after the FINAL buffer for frame 2, and
before the FINAL buffer for frame 4. PARTIAL buffers may be returned
in any order relative to other frames, but all PARTIAL buffers for a given
capture must arrive before the FINAL buffer for that capture. This entry may
only be used by the camera device if quirks.usePartialResult is set to 1.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Refer to <code>camera3_capture_result::partial_result</code>
for information on how to implement partial results.
 </td>
 </tr>

</tbody>

<tr><td colspan="6" id="section_request" class="section">request</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.request.frameCount">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="1">
 android.request.frameCount
 </td>
 <td class="entry_type">
 int32

[system]

[deprecated]

</td>

<td class="entry_description">
 A frame counter set by the framework. Must
be maintained unchanged in output frame. This value monotonically
increases with every new result (that is, each new result has a unique
frameCount value).
 </td>

<td class="entry_units">
 incrementing integer
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 Any int.
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.request.id">
 <td class="entry_name
 " rowspan="1">
 android.request.id
 </td>
 <td class="entry_type">
 int32

[hidden]

</td>

<td class="entry_description">
 An application-specified ID for the current
request. Must be maintained unchanged in output
frame
 </td>

<td class="entry_units">
 arbitrary integer assigned by application
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.request.inputStreams">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.request.inputStreams
 </td>
 <td class="entry_type">
 int32
 x

n
 
 [system]

[deprecated]

</td>

<td class="entry_description">
 List which camera reprocess stream is used
for the source of reprocessing data.
 </td>

<td class="entry_units">
 List of camera reprocess stream IDs
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 Typically, only one entry allowed, must be a valid reprocess stream ID.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Only meaningful when <a href="#controls_android.request.type">android.request.type</a> ==
REPROCESS. Ignored otherwise
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.request.metadataMode">
 <td class="entry_name
 " rowspan="1">
 android.request.metadataMode
 </td>
 <td class="entry_type">
 byte

[system]

<ul class="entry_type_enum">
 <li>
 NONE
 No metadata should be produced on output, except
for application-bound buffer data. If no
application-bound streams exist, no frame should be
placed in the output frame queue. If such streams
exist, a frame should be placed on the output queue
with null metadata but with the necessary output buffer
information. Timestamp information should still be
included with any output stream buffers
 </li>
 <li>
 FULL
 All metadata should be produced. Statistics will
only be produced if they are separately
enabled
 </li>
 </ul>

</td>

<td class="entry_description">
 How much metadata to produce on
output
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.request.outputStreams">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.request.outputStreams
 </td>
 <td class="entry_type">
 int32
 x

n
 
 [system]

[deprecated]

</td>

<td class="entry_description">
 Lists which camera output streams image data
from this capture must be sent to
 </td>

<td class="entry_units">
 List of camera stream IDs
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 List must only include streams that have been
created
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If no output streams are listed, then the image
data should simply be discarded. The image data must
still be captured for metadata and statistics production,
and the lens and flash must operate as requested.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.request.type">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="1">
 android.request.type
 </td>
 <td class="entry_type">
 byte

[system]

[deprecated]

<ul class="entry_type_enum">
 <li>
 CAPTURE
 Capture a new image from the imaging hardware,
and process it according to the
settings
 </li>
 <li>
 REPROCESS
 Process previously captured data; the
<a href="#controls_android.request.inputStreams">android.request.inputStreams</a> parameter determines the
source reprocessing stream. TODO: Mark dynamic metadata
needed for reprocessing with [RP]
 </li>
 </ul>

</td>

<td class="entry_description">
 The type of the request; either CAPTURE or
REPROCESS. For HAL3, this tag is redundant.
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.request.maxNumOutputStreams">
 <td class="entry_name
 " rowspan="3">
 android.request.maxNumOutputStreams
 </td>
 <td class="entry_type">
 int32
 x

3
 
 [hidden]

[legacy]

</td>

<td class="entry_description">
 The maximum numbers of different types of output streams
that can be configured and used simultaneously by a camera device.
 </td>

<td class="entry_range">
 For processed (and stalling) format streams, >= 1.
For Raw format (either stalling or non-stalling) streams, >= 0.
For processed (but not stalling) format streams, >= 3
for FULL mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL</code>);
>= 2 for LIMITED mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == LIMITED</code>).
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This is a 3 element tuple that contains the max number of output simultaneous
streams for raw sensor, processed (but not stalling), and processed (and stalling)
formats respectively. For example, assuming that JPEG is typically a processed and
stalling stream, if max raw sensor format output stream number is 1, max YUV streams
number is 3, and max JPEG stream number is 2, then this tuple should be <code>(1, 3, 2)</code>.
This lists the upper bound of the number of output streams supported by
the camera device. Using more streams simultaneously may require more hardware and
CPU resources that will consume more power. The image format for an output stream can
be any supported format provided by <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a>.
The formats defined in <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a> can be catergorized
into the 3 stream types as below:
<ul>
<li>Processed (but stalling): any non-RAW format with a stallDurations > 0.
Typically JPEG format (ImageFormat#JPEG).</li>
<li>Raw formats: ImageFormat#RAW_SENSOR, ImageFormat#RAW10 and ImageFormat#RAW_OPAQUE.</li>
<li>Processed (but not-stalling): any non-RAW format without a stall duration.
Typically ImageFormat#YUV_420_888, ImageFormat#NV21, ImageFormat#YV12.</li>
</ul>
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.request.maxNumOutputRaw">
 <td class="entry_name
 " rowspan="3">
 android.request.maxNumOutputRaw
 </td>
 <td class="entry_type">
 int32

[public]

[synthetic]

[legacy]

</td>

<td class="entry_description">
 The maximum numbers of different types of output streams
that can be configured and used simultaneously by a camera device
for any <code>RAW</code> formats.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This value contains the max number of output simultaneous
streams from the raw sensor.
This lists the upper bound of the number of output streams supported by
the camera device. Using more streams simultaneously may require more hardware and
CPU resources that will consume more power. The image format for this kind of an output stream can
be any <code>RAW</code> and supported format provided by <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a>.
In particular, a <code>RAW</code> format is typically one of:
<ul>
<li>ImageFormat#RAW_SENSOR</li>
<li>ImageFormat#RAW10</li>
<li>Opaque <code>RAW</code></li>
</ul>
LEGACY mode devices (<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> <code>==</code> LEGACY)
never support raw streams.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.request.maxNumOutputProc">
 <td class="entry_name
 " rowspan="3">
 android.request.maxNumOutputProc
 </td>
 <td class="entry_type">
 int32

[public]

[synthetic]

[legacy]

</td>

<td class="entry_description">
 The maximum numbers of different types of output streams
that can be configured and used simultaneously by a camera device
for any processed (but not-stalling) formats.
 </td>

<td class="entry_range">
 >= 3
for FULL mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL</code>);
>= 2 for LIMITED mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == LIMITED</code>).
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This value contains the max number of output simultaneous
streams for any processed (but not-stalling) formats.
This lists the upper bound of the number of output streams supported by
the camera device. Using more streams simultaneously may require more hardware and
CPU resources that will consume more power. The image format for this kind of an output stream can
be any non-<code>RAW</code> and supported format provided by <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a>.
Processed (but not-stalling) is defined as any non-RAW format without a stall duration.
Typically:
<ul>
<li>ImageFormat#YUV_420_888</li>
<li>ImageFormat#NV21</li>
<li>ImageFormat#YV12</li>
<li>Implementation-defined formats, i.e. StreamConfiguration#isOutputSupportedFor(Class)</li>
</ul>
For full guarantees, query StreamConfigurationMap#getOutputStallDuration with
a processed format -- it will return 0 for a non-stalling stream.
LEGACY devices will support at least 2 processing/non-stalling streams.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.request.maxNumOutputProcStalling">
 <td class="entry_name
 " rowspan="3">
 android.request.maxNumOutputProcStalling
 </td>
 <td class="entry_type">
 int32

[public]

[synthetic]

[legacy]

</td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This value contains the max number of output simultaneous
streams for any processed (but not-stalling) formats.
This lists the upper bound of the number of output streams supported by
the camera device. Using more streams simultaneously may require more hardware and
CPU resources that will consume more power. The image format for this kind of an output stream can
be any non-<code>RAW</code> and supported format provided by <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a>.
A processed and stalling format is defined as any non-RAW format with a stallDurations > 0.
Typically only the <code>JPEG</code> format (ImageFormat#JPEG) is a stalling format.
For full guarantees, query StreamConfigurationMap#getOutputStallDuration with
a processed format -- it will return a non-0 value for a stalling stream.
LEGACY devices will support up to 1 processing/stalling stream.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.request.maxNumReprocessStreams">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.request.maxNumReprocessStreams
 </td>
 <td class="entry_type">
 int32
 x

1
 
 [system]

[deprecated]

</td>

<td class="entry_description">
 How many reprocessing streams of any type
can be allocated at the same time.
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 >= 0
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Only used by HAL2.x.
When set to 0, it means no reprocess stream is supported.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.request.maxNumInputStreams">
 <td class="entry_name
 " rowspan="3">
 android.request.maxNumInputStreams
 </td>
 <td class="entry_type">
 int32

[hidden]

[full]

</td>

<td class="entry_description">
 The maximum numbers of any type of input streams
that can be configured and used simultaneously by a camera device.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When set to 0, it means no input stream is supported.
The image format for a input stream can be any supported
format provided by
<a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a>. When using an
input stream, there must be at least one output stream
configured to to receive the reprocessed images.
For example, for Zero Shutter Lag (ZSL) still capture use case, the input
stream image format will be RAW_OPAQUE, the associated output stream image format
should be JPEG.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.request.pipelineMaxDepth">
 <td class="entry_name
 " rowspan="5">
 android.request.pipelineMaxDepth
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 Specifies the number of maximum pipeline stages a frame
has to go through from when it's exposed to when it's available
to the framework.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 A typical minimum value for this is 2 (one stage to expose,
one stage to readout) from the sensor. The ISP then usually adds
its own stages to do custom HW processing. Further stages may be
added by SW processing.
Depending on what settings are used (e.g. YUV, JPEG) and what
processing is enabled (e.g. face detection), the actual pipeline
depth (specified by <a href="#dynamic_android.request.pipelineDepth">android.request.pipelineDepth</a>) may be less than
the max pipeline depth.
A pipeline depth of X stages is equivalent to a pipeline latency of
X frame intervals.
This value will be 8 or less.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.request.partialResultCount">
 <td class="entry_name
 " rowspan="3">
 android.request.partialResultCount
 </td>
 <td class="entry_type">
 int32

[public]

</td>

<td class="entry_description">
 Defines how many sub-components
a result will be composed of.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 In order to combat the pipeline latency, partial results
may be delivered to the application layer from the camera device as
soon as they are available.
Optional; defaults to 1. A value of 1 means that partial
results are not supported, and only the final TotalCaptureResult will
be produced by the camera device.
A typical use case for this might be: after requesting an
auto-focus (AF) lock the new AF state might be available 50%
of the way through the pipeline. The camera device could
then immediately dispatch this state via a partial result to
the application, and the rest of the metadata via later
partial results.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.request.availableCapabilities">
 <td class="entry_name
 " rowspan="5">
 android.request.availableCapabilities
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public]

[legacy]

<ul class="entry_type_enum">
 <li>
 BACKWARD_COMPATIBLE
 The minimal set of capabilities that every camera
device (regardless of <a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a>)
supports.
This capability is listed by all devices, and
indicates that the camera device has a feature set
that's comparable to the baseline requirements for the
older android.hardware.Camera API.
 </li>
 <li>
 MANUAL_SENSOR
 [optional]
 The camera device can be manually controlled (3A algorithms such
as auto-exposure, and auto-focus can be bypassed).
The camera device supports basic manual control of the sensor image
acquisition related stages. This means the following controls are
guaranteed to be supported:
<ul>
<li>Manual frame duration control<ul>
<li><a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a></li>
<li><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a></li>
</ul>
</li>
<li>Manual exposure control<ul>
<li><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a></li>
<li><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a></li>
</ul>
</li>
<li>Manual sensitivity control<ul>
<li><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a></li>
<li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a></li>
</ul>
</li>
<li>Manual lens control (if the lens is adjustable)<ul>
<li>android.lens.*</li>
</ul>
</li>
<li>Manual flash control (if a flash unit is present)<ul>
<li>android.flash.*</li>
</ul>
</li>
<li>Manual black level locking<ul>
<li><a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a></li>
</ul>
</li>
</ul>
If any of the above 3A algorithms are enabled, then the camera
device will accurately report the values applied by 3A in the
result.
A given camera device may also support additional manual sensor controls,
but this capability only covers the above list of controls.
If this is supported, <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a> will
additionally return a min frame duration that is greater than
zero for each supported size-format combination.
 </li>
 <li>
 MANUAL_POST_PROCESSING
 [optional]
 The camera device post-processing stages can be manually controlled.
The camera device supports basic manual control of the image post-processing
stages. This means the following controls are guaranteed to be supported:
<ul>
<li>Manual tonemap control<ul>
<li><a href="#controls_android.tonemap.curve">android.tonemap.curve</a></li>
<li><a href="#controls_android.tonemap.mode">android.tonemap.mode</a></li>
<li><a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></li>
</ul>
</li>
<li>Manual white balance control<ul>
<li><a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a></li>
<li><a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a></li>
</ul>
</li>
<li>Manual lens shading map control<ul>
<li><a href="#controls_android.shading.mode">android.shading.mode</a></li>
<li><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a></li>
<li><a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a></li>
<li><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a></li>
</ul>
</li>
<li>Manual aberration correction control (if aberration correction is supported)<ul>
<li><a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a></li>
<li><a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a></li>
</ul>
</li>
</ul>
If auto white balance is enabled, then the camera device
will accurately report the values applied by AWB in the result.
A given camera device may also support additional post-processing
controls, but this capability only covers the above list of controls.
 </li>
 <li>
 RAW
 [optional]
 The camera device supports outputting RAW buffers and
metadata for interpreting them.
Devices supporting the RAW capability allow both for
saving DNG files, and for direct application processing of
raw sensor images.
<ul>
<li>RAW_SENSOR is supported as an output format.</li>
<li>The maximum available resolution for RAW_SENSOR streams
 will match either the value in
 <a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> or
 <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.</li>
<li>All DNG-related optional metadata entries are provided
 by the camera device.</li>
</ul>
 </li>
 <li>
 ZSL
 [optional]
 [hidden]
 The camera device supports the Zero Shutter Lag use case.
<ul>
<li>At least one input stream can be used.</li>
<li>RAW_OPAQUE is supported as an output/input format</li>
<li>Using RAW_OPAQUE does not cause a frame rate drop
 relative to the sensor's maximum capture rate (at that
 resolution).</li>
<li>RAW_OPAQUE will be reprocessable into both YUV_420_888
 and JPEG formats.</li>
<li>The maximum available resolution for RAW_OPAQUE streams
 (both input/output) will match the maximum available
 resolution of JPEG streams.</li>
</ul>
 </li>
 <li>
 READ_SENSOR_SETTINGS
 [optional]
 The camera device supports accurately reporting the sensor settings for many of
the sensor controls while the built-in 3A algorithm is running. This allows
reporting of sensor settings even when these settings cannot be manually changed.
The values reported for the following controls are guaranteed to be available
in the CaptureResult, including when 3A is enabled:
<ul>
<li>Exposure control<ul>
<li><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a></li>
</ul>
</li>
<li>Sensitivity control<ul>
<li><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a></li>
</ul>
</li>
<li>Lens controls (if the lens is adjustable)<ul>
<li><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a></li>
<li><a href="#controls_android.lens.aperture">android.lens.aperture</a></li>
</ul>
</li>
</ul>
This capability is a subset of the MANUAL_SENSOR control capability, and will
always be included if the MANUAL_SENSOR capability is available.
 </li>
 <li>
 BURST_CAPTURE
 [optional]
 The camera device supports capturing maximum-resolution
images at >= 20 frames per second, in at least the
uncompressed YUV format, when post-processing settings
are set to FAST.
More specifically, this means that a size matching the
camera device's active array size is listed as a
supported size for the YUV_420_888 format in
<a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a>, the minimum frame
duration for that format and size is <= 1/20 s, and
the <a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a> entry
lists at least one FPS range where the minimum FPS is
<blockquote>
= 1 / minimumFrameDuration for the maximum-size
YUV_420_888 format.
</blockquote>
In addition, the <a href="#static_android.sync.maxLatency">android.sync.maxLatency</a> field is
guaranted to have a value between 0 and 4, inclusive.
 </li>
 </ul>

</td>

<td class="entry_description">
 List of capabilities that this camera device
advertises as fully supporting.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 A capability is a contract that the camera device makes in order
to be able to satisfy one or more use cases.
Listing a capability guarantees that the whole set of features
required to support a common use will all be available.
Using a subset of the functionality provided by an unsupported
capability may be possible on a specific camera device implementation;
to do this query each of <a href="#static_android.request.availableRequestKeys">android.request.availableRequestKeys</a>,
<a href="#static_android.request.availableResultKeys">android.request.availableResultKeys</a>,
<a href="#static_android.request.availableCharacteristicsKeys">android.request.availableCharacteristicsKeys</a>.
The following capabilities are guaranteed to be available on
<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> <code>==</code> FULL devices:
<ul>
<li>MANUAL_SENSOR</li>
<li>MANUAL_POST_PROCESSING</li>
</ul>
Other capabilities may be available on either FULL or LIMITED
devices, but the application should query this key to be sure.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Additional constraint details per-capability will be available
in the Compatibility Test Suite.
Minimum baseline requirements required for the
BACKWARD_COMPATIBLE capability are not explicitly listed.
Instead refer to "BC" tags and the camera CTS tests in the
android.hardware.camera2.cts package.
Listed controls that can be either request or result (e.g.
<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>) must be available both in the
request and the result in order to be considered to be
capability-compliant.
For example, if the HAL claims to support MANUAL control,
then exposure time must be configurable via the request and
the actual exposure applied must be available via
the result.
If MANUAL_SENSOR is omitted, the HAL may choose to omit the
<a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a> static property entirely.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.request.availableRequestKeys">
 <td class="entry_name
 " rowspan="5">
 android.request.availableRequestKeys
 </td>
 <td class="entry_type">
 int32
 x

n
 
 [hidden]

[legacy]

</td>

<td class="entry_description">
 A list of all keys that the camera device has available
to use with CaptureRequest.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Attempting to set a key into a CaptureRequest that is not
listed here will result in an invalid request and will be rejected
by the camera device.
This field can be used to query the feature set of a camera device
at a more granular level than capabilities. This is especially
important for optional keys that are not listed under any capability
in <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Vendor tags must not be listed here. Use the vendor tag metadata
extensions C api instead (refer to camera3.h for more details).
Setting/getting vendor tags will be checked against the metadata
vendor extensions API and not against this field.
The HAL must not consume any request tags that are not listed either
here or in the vendor tag list.
The public camera2 API will always make the vendor tags visible
via CameraCharacteristics#getAvailableCaptureRequestKeys.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.request.availableResultKeys">
 <td class="entry_name
 " rowspan="5">
 android.request.availableResultKeys
 </td>
 <td class="entry_type">
 int32
 x

n
 
 [hidden]

[legacy]

</td>

<td class="entry_description">
 A list of all keys that the camera device has available
to use with CaptureResult.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Attempting to get a key from a CaptureResult that is not
listed here will always return a <code>null</code> value. Getting a key from
a CaptureResult that is listed here will generally never return a <code>null</code>
value.
The following keys may return <code>null</code> unless they are enabled:
<ul>
<li><a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a> (non-null iff <a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> == ON)</li>
</ul>
(Those sometimes-null keys will nevertheless be listed here
if they are available.)
This field can be used to query the feature set of a camera device
at a more granular level than capabilities. This is especially
important for optional keys that are not listed under any capability
in <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Tags listed here must always have an entry in the result metadata,
even if that size is 0 elements. Only array-type tags (e.g. lists,
matrices, strings) are allowed to have 0 elements.
Vendor tags must not be listed here. Use the vendor tag metadata
extensions C api instead (refer to camera3.h for more details).
Setting/getting vendor tags will be checked against the metadata
vendor extensions API and not against this field.
The HAL must not produce any result tags that are not listed either
here or in the vendor tag list.
The public camera2 API will always make the vendor tags visible
via CameraCharacteristics#getAvailableCaptureResultKeys.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.request.availableCharacteristicsKeys">
 <td class="entry_name
 " rowspan="5">
 android.request.availableCharacteristicsKeys
 </td>
 <td class="entry_type">
 int32
 x

n
 
 [hidden]

[legacy]

</td>

<td class="entry_description">
 A list of all keys that the camera device has available
to use with CameraCharacteristics.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This entry follows the same rules as
<a href="#static_android.request.availableResultKeys">android.request.availableResultKeys</a> (except that it applies for
CameraCharacteristics instead of CaptureResult). See above for more
details.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Keys listed here must always have an entry in the static info metadata,
even if that size is 0 elements. Only array-type tags (e.g. lists,
matrices, strings) are allowed to have 0 elements.
Vendor tags must not be listed here. Use the vendor tag metadata
extensions C api instead (refer to camera3.h for more details).
Setting/getting vendor tags will be checked against the metadata
vendor extensions API and not against this field.
The HAL must not have any tags in its static info that are not listed
either here or in the vendor tag list.
The public camera2 API will always make the vendor tags visible
via CameraCharacteristics#getKeys.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.request.frameCount">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.request.frameCount
 </td>
 <td class="entry_type">
 int32

[hidden]

[deprecated]

</td>

<td class="entry_description">
 A frame counter set by the framework. This value monotonically
increases with every new result (that is, each new result has a unique
frameCount value).
 </td>

<td class="entry_units">
 count of frames
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 > 0
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Reset on release()
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.request.id">
 <td class="entry_name
 " rowspan="1">
 android.request.id
 </td>
 <td class="entry_type">
 int32

[hidden]

</td>

<td class="entry_description">
 An application-specified ID for the current
request. Must be maintained unchanged in output
frame
 </td>

<td class="entry_units">
 arbitrary integer assigned by application
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.request.metadataMode">
 <td class="entry_name
 " rowspan="1">
 android.request.metadataMode
 </td>
 <td class="entry_type">
 byte

[system]

</td>

<td class="entry_description">
 How much metadata to produce on
output
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.request.outputStreams">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.request.outputStreams
 </td>
 <td class="entry_type">
 int32
 x

n
 
 [system]

[deprecated]

</td>

<td class="entry_description">
 Lists which camera output streams image data
from this capture must be sent to
 </td>

<td class="entry_units">
 List of camera stream IDs
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.request.pipelineDepth">
 <td class="entry_name
 " rowspan="5">
 android.request.pipelineDepth
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 Specifies the number of pipeline stages the frame went
through from when it was exposed to when the final completed result
was available to the framework.
 </td>

<td class="entry_range">
 <= <a href="#static_android.request.pipelineMaxDepth">android.request.pipelineMaxDepth</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Depending on what settings are used in the request, and
what streams are configured, the data may undergo less processing,
and some pipeline stages skipped.
See <a href="#static_android.request.pipelineMaxDepth">android.request.pipelineMaxDepth</a> for more details.
 </td>
 </tr>

</tbody>

<tr><td colspan="6" id="section_scaler" class="section">scaler</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.scaler.cropRegion">
 <td class="entry_name
 " rowspan="5">
 android.scaler.cropRegion
 </td>
 <td class="entry_type">
 int32
 x

4
 
 [public as rectangle]

[legacy]

</td>

<td class="entry_description">
 The desired region of the sensor to read out for this capture.
 </td>

<td class="entry_units">
 Pixel coordinates relative to
 android.sensor.info.activeArraySize
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control can be used to implement digital zoom.
The crop region coordinate system is based off
<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with <code>(0, 0)</code> being the
top-left corner of the sensor active array.
Output streams use this rectangle to produce their output,
cropping to a smaller region if necessary to maintain the
stream's aspect ratio, then scaling the sensor input to
match the output's configured resolution.
The crop region is applied after the RAW to other color
space (e.g. YUV) conversion. Since raw streams
(e.g. RAW16) don't have the conversion stage, they are not
croppable. The crop region will be ignored by raw streams.
For non-raw streams, any additional per-stream cropping will
be done to maximize the final pixel area of the stream.
For example, if the crop region is set to a 4:3 aspect
ratio, then 4:3 streams will use the exact crop
region. 16:9 streams will further crop vertically
(letterbox).
Conversely, if the crop region is set to a 16:9, then 4:3
outputs will crop horizontally (pillarbox), and 16:9
streams will match exactly. These additional crops will
be centered within the crop region.
The width and height of the crop region cannot
be set to be smaller than
<code>floor( activeArraySize.width / <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> )</code> and
<code>floor( activeArraySize.height / <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> )</code>, respectively.
The camera device may adjust the crop region to account
for rounding and other hardware requirements; the final
crop region used will be included in the output capture
result.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The output streams must maintain square pixels at all
times, no matter what the relative aspect ratios of the
crop region and the stream are. Negative values for
corner are allowed for raw output if full pixel array is
larger than active pixel array. Width and height may be
rounded to nearest larger supportable width, especially
for raw output, where only a few fixed scales may be
possible.
HAL2.x uses only (x, y, width)
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.scaler.availableFormats">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="5">
 android.scaler.availableFormats
 </td>
 <td class="entry_type">
 int32
 x

n
 
 [hidden as imageFormat]

[deprecated]

<ul class="entry_type_enum">
 <li>
 RAW16
 [optional]
 0x20
 RAW16 is a standard, cross-platform format for raw image
buffers with 16-bit pixels.
Buffers of this format are typically expected to have a
Bayer Color Filter Array (CFA) layout, which is given in
<a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a>. Sensors with
CFAs that are not representable by a format in
<a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a> should not
use this format.
Buffers of this format will also follow the constraints given for
RAW_OPAQUE buffers, but with relaxed performance constraints.
See <a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a> for
the full set of performance guarantees.
 </li>
 <li>
 RAW_OPAQUE
 [optional]
 0x24
 RAW_OPAQUE is a format for raw image buffers coming from an
image sensor.
The actual structure of buffers of this format is
platform-specific, but must follow several constraints:
<ol>
<li>No image post-processing operations may have been applied to
buffers of this type. These buffers contain raw image data coming
directly from the image sensor.</li>
<li>If a buffer of this format is passed to the camera device for
reprocessing, the resulting images will be identical to the images
produced if the buffer had come directly from the sensor and was
processed with the same settings.</li>
</ol>
The intended use for this format is to allow access to the native
raw format buffers coming directly from the camera sensor without
any additional conversions or decrease in framerate.
See <a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a> for the full set of
performance guarantees.
 </li>
 <li>
 YV12
 [optional]
 0x32315659
 YCrCb 4:2:0 Planar
 </li>
 <li>
 YCrCb_420_SP
 [optional]
 0x11
 NV21
 </li>
 <li>
 IMPLEMENTATION_DEFINED
 0x22
 System internal format, not application-accessible
 </li>
 <li>
 YCbCr_420_888
 0x23
 Flexible YUV420 Format
 </li>
 <li>
 BLOB
 0x21
 JPEG format
 </li>
 </ul>

</td>

<td class="entry_description">
 The list of image formats that are supported by this
camera device for output streams.
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 All camera devices will support JPEG and YUV_420_888 formats.
When set to YUV_420_888, application can access the YUV420 data directly.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 These format values are from HAL_PIXEL_FORMAT_* in
system/core/include/system/graphics.h.
When IMPLEMENTATION_DEFINED is used, the platform
gralloc module will select a format based on the usage flags provided
by the camera HAL device and the other endpoint of the stream. It is
usually used by preview and recording streams, where the application doesn't
need access the image data.
YCbCr_420_888 format must be supported by the HAL. When an image stream
needs CPU/application direct access, this format will be used.
The BLOB format must be supported by the HAL. This is used for the JPEG stream.
A RAW_OPAQUE buffer should contain only pixel data. It is strongly
recommended that any information used by the camera device when
processing images is fully expressed by the result metadata
for that image buffer.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.availableJpegMinDurations">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.scaler.availableJpegMinDurations
 </td>
 <td class="entry_type">
 int64
 x

n
 
 [hidden]

[deprecated]

</td>

<td class="entry_description">
 The minimum frame duration that is supported
for each resolution in <a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a>.
 </td>

<td class="entry_units">
 Nanoseconds
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 TODO: Remove property.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This corresponds to the minimum steady-state frame duration when only
that JPEG stream is active and captured in a burst, with all
processing (typically in android.*.mode) set to FAST.
When multiple streams are configured, the minimum
frame duration will be >= max(individual stream min
durations)
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.availableJpegSizes">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="5">
 android.scaler.availableJpegSizes
 </td>
 <td class="entry_type">
 int32
 x

n x 2
 
 [hidden as size]

[deprecated]

</td>

<td class="entry_description">
 The JPEG resolutions that are supported by this camera device.
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 TODO: Remove property.
 </td>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The HAL must include sensor maximum resolution
(defined by <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>),
and should include half/quarter of sensor maximum resolution.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.availableMaxDigitalZoom">
 <td class="entry_name
 " rowspan="3">
 android.scaler.availableMaxDigitalZoom
 </td>
 <td class="entry_type">
 float

[public]

[legacy]

</td>

<td class="entry_description">
 The maximum ratio between both active area width
and crop region width, and active area height and
crop region height, for <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>.
 </td>

<td class="entry_units">
 Zoom scale factor
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This represents the maximum amount of zooming possible by
the camera device, or equivalently, the minimum cropping
window size.
Crop regions that have a width or height that is smaller
than this ratio allows will be rounded up to the minimum
allowed size by the camera device.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.availableProcessedMinDurations">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.scaler.availableProcessedMinDurations
 </td>
 <td class="entry_type">
 int64
 x

n
 
 [hidden]

[deprecated]

</td>

<td class="entry_description">
 For each available processed output size (defined in
<a href="#static_android.scaler.availableProcessedSizes">android.scaler.availableProcessedSizes</a>), this property lists the
minimum supportable frame duration for that size.
 </td>

<td class="entry_units">
 Nanoseconds
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.availableProcessedSizes">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="5">
 android.scaler.availableProcessedSizes
 </td>
 <td class="entry_type">
 int32
 x

n x 2
 
 [hidden as size]

[deprecated]

</td>

<td class="entry_description">
 The resolutions available for use with
processed output streams, such as YV12, NV12, and
platform opaque YUV/RGB streams to the GPU or video
encoders.
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The resolutions are listed as <code>(width, height)</code> pairs.
For a given use case, the actual maximum supported resolution
may be lower than what is listed here, depending on the destination
Surface for the image data. For example, for recording video,
the video encoder chosen may have a maximum size limit (e.g. 1080p)
smaller than what the camera (e.g. maximum resolution is 3264x2448)
can provide.
Please reference the documentation for the image data destination to
check if it limits the maximum size for image data.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For FULL capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL</code>),
the HAL must include all JPEG sizes listed in <a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a>
and each below resolution if it is smaller than or equal to the sensor
maximum resolution (if they are not listed in JPEG sizes already):
<ul>
<li>240p (320 x 240)</li>
<li>480p (640 x 480)</li>
<li>720p (1280 x 720)</li>
<li>1080p (1920 x 1080)</li>
</ul>
For LIMITED capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == LIMITED</code>),
the HAL only has to list up to the maximum video size supported by the devices.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.availableRawMinDurations">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.scaler.availableRawMinDurations
 </td>
 <td class="entry_type">
 int64
 x

n
 
 [system]

[deprecated]

</td>

<td class="entry_description">
 For each available raw output size (defined in
<a href="#static_android.scaler.availableRawSizes">android.scaler.availableRawSizes</a>), this property lists the minimum
supportable frame duration for that size.
 </td>

<td class="entry_units">
 Nanoseconds
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Should correspond to the frame duration when only the raw stream is
active.
When multiple streams are configured, the minimum
frame duration will be >= max(individual stream min
durations)
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.availableRawSizes">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="1">
 android.scaler.availableRawSizes
 </td>
 <td class="entry_type">
 int32
 x

n x 2
 
 [system as size]

[deprecated]

</td>

<td class="entry_description">
 The resolutions available for use with raw
sensor output streams, listed as width,
height
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.availableInputOutputFormatsMap">
 <td class="entry_name
 " rowspan="5">
 android.scaler.availableInputOutputFormatsMap
 </td>
 <td class="entry_type">
 int32
 x

n
 
 [hidden as imageFormat]

[full]

</td>

<td class="entry_description">
 The mapping of image formats that are supported by this
camera device for input streams, to their corresponding output formats.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 All camera devices with at least 1
<a href="#static_android.request.maxNumInputStreams">android.request.maxNumInputStreams</a> will have at least one
available input format.
The camera device will support the following map of formats,
if its dependent capability is supported:
<table>
<thead>
<tr>
<th align="left">Input Format</th>
<th align="left">Output Format</th>
<th align="left">Capability</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">RAW_OPAQUE</td>
<td align="left">JPEG</td>
<td align="left">ZSL</td>
</tr>
<tr>
<td align="left">RAW_OPAQUE</td>
<td align="left">YUV_420_888</td>
<td align="left">ZSL</td>
</tr>
<tr>
<td align="left">RAW_OPAQUE</td>
<td align="left">RAW16</td>
<td align="left">RAW</td>
</tr>
<tr>
<td align="left">RAW16</td>
<td align="left">YUV_420_888</td>
<td align="left">RAW</td>
</tr>
<tr>
<td align="left">RAW16</td>
<td align="left">JPEG</td>
<td align="left">RAW</td>
</tr>
</tbody>
</table>
For ZSL-capable camera devices, using the RAW_OPAQUE format
as either input or output will never hurt maximum frame rate (i.e.
StreamConfigurationMap#getOutputStallDuration(int,Size)
for a <code>format =</code> RAW_OPAQUE is always 0).
Attempting to configure an input stream with output streams not
listed as available in this map is not valid.
TODO: typedef to ReprocessFormatMap
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For the formats, see <code>system/core/include/system/graphics.h</code> for a definition
of the image format enumerations.
This value is encoded as a variable-size array-of-arrays.
The inner array always contains <code>[format, length, ...]</code> where
<code>...</code> has <code>length</code> elements. An inner array is followed by another
inner array if the total metadata entry size hasn't yet been exceeded.
A code sample to read/write this encoding (with a device that
supports reprocessing RAW_OPAQUE to RAW16, YUV_420_888, and JPEG,
and reprocessing RAW16 to YUV_420_888 and JPEG):
<pre><code>// reading
int32_t* contents = &entry.i32[0];
for (size_t i = 0; i < entry.count; ) {
 int32_t format = contents[i++];
 int32_t length = contents[i++];
 int32_t output_formats[length];
 memcpy(&output_formats[0], &contents[i],
 length * sizeof(int32_t));
 i += length;
}

// writing (static example, RAW+ZSL)
int32_t[] contents = {
 RAW_OPAQUE, 3, RAW16, YUV_420_888, BLOB,
 RAW16, 2, YUV_420_888, BLOB,
};
update_camera_metadata_entry(metadata, index, &contents[0],
 sizeof(contents)/sizeof(contents[0]), &updated_entry);
</code></pre>
If the HAL claims to support any of the capabilities listed in the
above details, then it must also support all the input-output
combinations listed for that capability. It can optionally support
additional formats if it so chooses.
Refer to <a href="#static_android.scaler.availableFormats">android.scaler.availableFormats</a> for the enum values
which correspond to HAL_PIXEL_FORMAT_* in
system/core/include/system/graphics.h.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.availableStreamConfigurations">
 <td class="entry_name
 " rowspan="5">
 android.scaler.availableStreamConfigurations
 </td>
 <td class="entry_type">
 int32
 x

n x 4
 
 [hidden as streamConfiguration]

[legacy]

<ul class="entry_type_enum">
 <li>
 OUTPUT
 </li>
 <li>
 INPUT
 </li>
 </ul>

</td>

<td class="entry_description">
 The available stream configurations that this
camera device supports
(i.e. format, width, height, output/input stream).
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The configurations are listed as <code>(format, width, height, input?)</code>
tuples.
For a given use case, the actual maximum supported resolution
may be lower than what is listed here, depending on the destination
Surface for the image data. For example, for recording video,
the video encoder chosen may have a maximum size limit (e.g. 1080p)
smaller than what the camera (e.g. maximum resolution is 3264x2448)
can provide.
Please reference the documentation for the image data destination to
check if it limits the maximum size for image data.
Not all output formats may be supported in a configuration with
an input stream of a particular format. For more details, see
<a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a>.
The following table describes the minimum required output stream
configurations based on the hardware level
(<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a>):
<table>
<thead>
<tr>
<th align="center">Format</th>
<th align="center">Size</th>
<th align="center">Hardware Level</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">JPEG</td>
<td align="center"><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a></td>
<td align="center">Any</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">1920x1080 (1080p)</td>
<td align="center">Any</td>
<td align="center">if 1080p <= activeArraySize</td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">1280x720 (720)</td>
<td align="center">Any</td>
<td align="center">if 720p <= activeArraySize</td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">640x480 (480p)</td>
<td align="center">Any</td>
<td align="center">if 480p <= activeArraySize</td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">320x240 (240p)</td>
<td align="center">Any</td>
<td align="center">if 240p <= activeArraySize</td>
</tr>
<tr>
<td align="center">YUV_420_888</td>
<td align="center">all output sizes available for JPEG</td>
<td align="center">FULL</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">YUV_420_888</td>
<td align="center">all output sizes available for JPEG, up to the maximum video size</td>
<td align="center">LIMITED</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">IMPLEMENTATION_DEFINED</td>
<td align="center">same as YUV_420_888</td>
<td align="center">Any</td>
<td align="center"></td>
</tr>
</tbody>
</table>
Refer to <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> for additional
mandatory stream configurations on a per-capability basis.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 It is recommended (but not mandatory) to also include half/quarter
of sensor maximum resolution for JPEG formats (regardless of hardware
level).
(The following is a rewording of the above required table):
For JPEG format, the sizes may be restricted by below conditions:
<ul>
<li>The HAL may choose the aspect ratio of each Jpeg size to be one of well known ones
(e.g. 4:3, 16:9, 3:2 etc.). If the sensor maximum resolution
(defined by <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>) has an aspect ratio other than these,
it does not have to be included in the supported JPEG sizes.</li>
<li>Some hardware JPEG encoders may have pixel boundary alignment requirements, such as
the dimensions being a multiple of 16.</li>
</ul>
Therefore, the maximum JPEG size may be smaller than sensor maximum resolution.
However, the largest JPEG size must be as close as possible to the sensor maximum
resolution given above constraints. It is required that after aspect ratio adjustments,
additional size reduction due to other issues must be less than 3% in area. For example,
if the sensor maximum resolution is 3280x2464, if the maximum JPEG size has aspect
ratio 4:3, the JPEG encoder alignment requirement is 16, the maximum JPEG size will be
3264x2448.
For FULL capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL</code>),
the HAL must include all YUV_420_888 sizes that have JPEG sizes listed
here as output streams.
It must also include each below resolution if it is smaller than or
equal to the sensor maximum resolution (for both YUV_420_888 and JPEG
formats), as output streams:
<ul>
<li>240p (320 x 240)</li>
<li>480p (640 x 480)</li>
<li>720p (1280 x 720)</li>
<li>1080p (1920 x 1080)</li>
</ul>
For LIMITED capability devices
(<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == LIMITED</code>),
the HAL only has to list up to the maximum video size
supported by the device.
Regardless of hardware level, every output resolution available for
YUV_420_888 must also be available for IMPLEMENTATION_DEFINED.
This supercedes the following fields, which are now deprecated:
<ul>
<li>availableFormats</li>
<li>available[Processed,Raw,Jpeg]Sizes</li>
</ul>
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.availableMinFrameDurations">
 <td class="entry_name
 " rowspan="3">
 android.scaler.availableMinFrameDurations
 </td>
 <td class="entry_type">
 int64
 x

4 x n
 
 [hidden as streamConfigurationDuration]

[legacy]

</td>

<td class="entry_description">
 This lists the minimum frame duration for each
format/size combination.
 </td>

<td class="entry_units">
 (format, width, height, ns) x n
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This should correspond to the frame duration when only that
stream is active, with all processing (typically in android.*.mode)
set to either OFF or FAST.
When multiple streams are used in a request, the minimum frame
duration will be max(individual stream min durations).
The minimum frame duration of a stream (of a particular format, size)
is the same regardless of whether the stream is input or output.
See <a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> and
<a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a> for more details about
calculating the max frame rate.
(Keep in sync with
StreamConfigurationMap#getOutputMinFrameDuration)
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.availableStallDurations">
 <td class="entry_name
 " rowspan="5">
 android.scaler.availableStallDurations
 </td>
 <td class="entry_type">
 int64
 x

4 x n
 
 [hidden as streamConfigurationDuration]

[legacy]

</td>

<td class="entry_description">
 This lists the maximum stall duration for each
format/size combination.
 </td>

<td class="entry_units">
 (format, width, height, ns) x n
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 A stall duration is how much extra time would get added
to the normal minimum frame duration for a repeating request
that has streams with non-zero stall.
For example, consider JPEG captures which have the following
characteristics:
<ul>
<li>JPEG streams act like processed YUV streams in requests for which
they are not included; in requests in which they are directly
referenced, they act as JPEG streams. This is because supporting a
JPEG stream requires the underlying YUV data to always be ready for
use by a JPEG encoder, but the encoder will only be used (and impact
frame duration) on requests that actually reference a JPEG stream.</li>
<li>The JPEG processor can run concurrently to the rest of the camera
pipeline, but cannot process more than 1 capture at a time.</li>
</ul>
In other words, using a repeating YUV request would result
in a steady frame rate (let's say it's 30 FPS). If a single
JPEG request is submitted periodically, the frame rate will stay
at 30 FPS (as long as we wait for the previous JPEG to return each
time). If we try to submit a repeating YUV + JPEG request, then
the frame rate will drop from 30 FPS.
In general, submitting a new request with a non-0 stall time
stream will not cause a frame rate drop unless there are still
outstanding buffers for that stream from previous requests.
Submitting a repeating request with streams (call this <code>S</code>)
is the same as setting the minimum frame duration from
the normal minimum frame duration corresponding to <code>S</code>, added with
the maximum stall duration for <code>S</code>.
If interleaving requests with and without a stall duration,
a request will stall by the maximum of the remaining times
for each can-stall stream with outstanding buffers.
This means that a stalling request will not have an exposure start
until the stall has completed.
This should correspond to the stall duration when only that stream is
active, with all processing (typically in android.*.mode) set to FAST
or OFF. Setting any of the processing modes to HIGH_QUALITY
effectively results in an indeterminate stall duration for all
streams in a request (the regular stall calculation rules are
ignored).
The following formats may always have a stall duration:
<ul>
<li>ImageFormat#JPEG</li>
<li>ImageFormat#RAW_SENSOR</li>
</ul>
The following formats will never have a stall duration:
<ul>
<li>ImageFormat#YUV_420_888</li>
</ul>
All other formats may or may not have an allowed stall duration on
a per-capability basis; refer to <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>
for more details.
See <a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> for more information about
calculating the max frame rate (absent stalls).
(Keep up to date with
StreamConfigurationMap#getOutputStallDuration(int, Size) )
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If possible, it is recommended that all non-JPEG formats
(such as RAW16) should not have a stall duration. RAW10, RAW_OPAQUE and
IMPLEMENTATION_DEFINED must not have stall durations.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.streamConfigurationMap">
 <td class="entry_name
 " rowspan="5">
 android.scaler.streamConfigurationMap
 </td>
 <td class="entry_type">
 int32

[public as streamConfigurationMap]

[synthetic]

[legacy]

</td>

<td class="entry_description">
 The available stream configurations that this
camera device supports; also includes the minimum frame durations
and the stall durations for each format/size combination.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 All camera devices will support sensor maximum resolution (defined by
<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>) for the JPEG format.
For a given use case, the actual maximum supported resolution
may be lower than what is listed here, depending on the destination
Surface for the image data. For example, for recording video,
the video encoder chosen may have a maximum size limit (e.g. 1080p)
smaller than what the camera (e.g. maximum resolution is 3264x2448)
can provide.
Please reference the documentation for the image data destination to
check if it limits the maximum size for image data.
The following table describes the minimum required output stream
configurations based on the hardware level
(<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a>):
<table>
<thead>
<tr>
<th align="center">Format</th>
<th align="center">Size</th>
<th align="center">Hardware Level</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">JPEG</td>
<td align="center"><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a></td>
<td align="center">Any</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">1920x1080 (1080p)</td>
<td align="center">Any</td>
<td align="center">if 1080p <= activeArraySize</td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">1280x720 (720)</td>
<td align="center">Any</td>
<td align="center">if 720p <= activeArraySize</td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">640x480 (480p)</td>
<td align="center">Any</td>
<td align="center">if 480p <= activeArraySize</td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">320x240 (240p)</td>
<td align="center">Any</td>
<td align="center">if 240p <= activeArraySize</td>
</tr>
<tr>
<td align="center">YUV_420_888</td>
<td align="center">all output sizes available for JPEG</td>
<td align="center">FULL</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">YUV_420_888</td>
<td align="center">all output sizes available for JPEG, up to the maximum video size</td>
<td align="center">LIMITED</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">IMPLEMENTATION_DEFINED</td>
<td align="center">same as YUV_420_888</td>
<td align="center">Any</td>
<td align="center"></td>
</tr>
</tbody>
</table>
Refer to <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> for additional
mandatory stream configurations on a per-capability basis.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Do not set this property directly
(it is synthetic and will not be available at the HAL layer);
set the <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a> instead.
Not all output formats may be supported in a configuration with
an input stream of a particular format. For more details, see
<a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a>.
It is recommended (but not mandatory) to also include half/quarter
of sensor maximum resolution for JPEG formats (regardless of hardware
level).
(The following is a rewording of the above required table):
The HAL must include sensor maximum resolution (defined by
<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>).
For FULL capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL</code>),
the HAL must include all YUV_420_888 sizes that have JPEG sizes listed
here as output streams.
It must also include each below resolution if it is smaller than or
equal to the sensor maximum resolution (for both YUV_420_888 and JPEG
formats), as output streams:
<ul>
<li>240p (320 x 240)</li>
<li>480p (640 x 480)</li>
<li>720p (1280 x 720)</li>
<li>1080p (1920 x 1080)</li>
</ul>
For LIMITED capability devices
(<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == LIMITED</code>),
the HAL only has to list up to the maximum video size
supported by the device.
Regardless of hardware level, every output resolution available for
YUV_420_888 must also be available for IMPLEMENTATION_DEFINED.
This supercedes the following fields, which are now deprecated:
<ul>
<li>availableFormats</li>
<li>available[Processed,Raw,Jpeg]Sizes</li>
</ul>
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.scaler.croppingType">
 <td class="entry_name
 " rowspan="3">
 android.scaler.croppingType
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 CENTER_ONLY
 The camera device only supports centered crop regions.
 </li>
 <li>
 FREEFORM
 The camera device supports arbitrarily chosen crop regions.
 </li>
 </ul>

</td>

<td class="entry_description">
 The crop type that this camera device supports.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When passing a non-centered crop region (<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>) to a camera
device that only supports CENTER_ONLY cropping, the camera device will move the
crop region to the center of the sensor active array (<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>)
and keep the crop region width and height unchanged. The camera device will return the
final used crop region in metadata result <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>.
Camera devices that support FREEFORM cropping will support any crop region that
is inside of the active array. The camera device will apply the same crop region and
return the final used crop region in capture result metadata <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>.
FULL capability devices (<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> <code>==</code> FULL) will support
FREEFORM cropping. LEGACY capability devices will only support CENTER_ONLY cropping.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.scaler.cropRegion">
 <td class="entry_name
 " rowspan="5">
 android.scaler.cropRegion
 </td>
 <td class="entry_type">
 int32
 x

4
 
 [public as rectangle]

[legacy]

</td>

<td class="entry_description">
 The desired region of the sensor to read out for this capture.
 </td>

<td class="entry_units">
 Pixel coordinates relative to
 android.sensor.info.activeArraySize
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This control can be used to implement digital zoom.
The crop region coordinate system is based off
<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with <code>(0, 0)</code> being the
top-left corner of the sensor active array.
Output streams use this rectangle to produce their output,
cropping to a smaller region if necessary to maintain the
stream's aspect ratio, then scaling the sensor input to
match the output's configured resolution.
The crop region is applied after the RAW to other color
space (e.g. YUV) conversion. Since raw streams
(e.g. RAW16) don't have the conversion stage, they are not
croppable. The crop region will be ignored by raw streams.
For non-raw streams, any additional per-stream cropping will
be done to maximize the final pixel area of the stream.
For example, if the crop region is set to a 4:3 aspect
ratio, then 4:3 streams will use the exact crop
region. 16:9 streams will further crop vertically
(letterbox).
Conversely, if the crop region is set to a 16:9, then 4:3
outputs will crop horizontally (pillarbox), and 16:9
streams will match exactly. These additional crops will
be centered within the crop region.
The width and height of the crop region cannot
be set to be smaller than
<code>floor( activeArraySize.width / <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> )</code> and
<code>floor( activeArraySize.height / <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> )</code>, respectively.
The camera device may adjust the crop region to account
for rounding and other hardware requirements; the final
crop region used will be included in the output capture
result.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The output streams must maintain square pixels at all
times, no matter what the relative aspect ratios of the
crop region and the stream are. Negative values for
corner are allowed for raw output if full pixel array is
larger than active pixel array. Width and height may be
rounded to nearest larger supportable width, especially
for raw output, where only a few fixed scales may be
possible.
HAL2.x uses only (x, y, width)
 </td>
 </tr>

</tbody>

<tr><td colspan="6" id="section_sensor" class="section">sensor</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.sensor.exposureTime">
 <td class="entry_name
 " rowspan="3">
 android.sensor.exposureTime
 </td>
 <td class="entry_type">
 int64

[public]

[full]

</td>

<td class="entry_description">
 Duration each pixel is exposed to
light.
 </td>

<td class="entry_units">
 Nanoseconds
 </td>

<td class="entry_range">
 <a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If the sensor can't expose this exact duration, it will shorten the
duration exposed to the nearest possible value (rather than expose longer).
The final exposure time used will be available in the output capture result.
This control is only effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> is set to
OFF; otherwise the auto-exposure algorithm will override this value.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.sensor.frameDuration">
 <td class="entry_name
 " rowspan="5">
 android.sensor.frameDuration
 </td>
 <td class="entry_type">
 int64

[public]

[full]

</td>

<td class="entry_description">
 Duration from start of frame exposure to
start of next frame exposure.
 </td>

<td class="entry_units">
 Nanoseconds
 </td>

<td class="entry_range">
 See <a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a>,
<a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a>. The duration
is capped to <code>max(duration, exposureTime + overhead)</code>.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The maximum frame rate that can be supported by a camera subsystem is
a function of many factors:
<ul>
<li>Requested resolutions of output image streams</li>
<li>Availability of binning / skipping modes on the imager</li>
<li>The bandwidth of the imager interface</li>
<li>The bandwidth of the various ISP processing blocks</li>
</ul>
Since these factors can vary greatly between different ISPs and
sensors, the camera abstraction tries to represent the bandwidth
restrictions with as simple a model as possible.
The model presented has the following characteristics:
<ul>
<li>The image sensor is always configured to output the smallest
resolution possible given the application's requested output stream
sizes. The smallest resolution is defined as being at least as large
as the largest requested output stream size; the camera pipeline must
never digitally upsample sensor data when the crop region covers the
whole sensor. In general, this means that if only small output stream
resolutions are configured, the sensor can provide a higher frame
rate.</li>
<li>Since any request may use any or all the currently configured
output streams, the sensor and ISP must be configured to support
scaling a single capture to all the streams at the same time. This
means the camera pipeline must be ready to produce the largest
requested output size without any delay. Therefore, the overall
frame rate of a given configured stream set is governed only by the
largest requested stream resolution.</li>
<li>Using more than one output stream in a request does not affect the
frame duration.</li>
<li>Certain format-streams may need to do additional background processing
before data is consumed/produced by that stream. These processors
can run concurrently to the rest of the camera pipeline, but
cannot process more than 1 capture at a time.</li>
</ul>
The necessary information for the application, given the model above,
is provided via the <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a> field
using StreamConfigurationMap#getOutputMinFrameDuration(int, Size).
These are used to determine the maximum frame rate / minimum frame
duration that is possible for a given stream configuration.
Specifically, the application can use the following rules to
determine the minimum frame duration it can request from the camera
device:
<ol>
<li>Let the set of currently configured input/output streams
be called <code>S</code>.</li>
<li>Find the minimum frame durations for each stream in <code>S</code>, by
looking it up in <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a> using
StreamConfigurationMap#getOutputMinFrameDuration(int, Size) (with
its respective size/format). Let this set of frame durations be called
<code>F</code>.</li>
<li>For any given request <code>R</code>, the minimum frame duration allowed
for <code>R</code> is the maximum out of all values in <code>F</code>. Let the streams
used in <code>R</code> be called <code>S_r</code>.</li>
</ol>
If none of the streams in <code>S_r</code> have a stall time (listed in
StreamConfigurationMap#getOutputStallDuration(int,Size) using its
respective size/format), then the frame duration in
<code>F</code> determines the steady state frame rate that the application will
get if it uses <code>R</code> as a repeating request. Let this special kind
of request be called <code>Rsimple</code>.
A repeating request <code>Rsimple</code> can be occasionally interleaved
by a single capture of a new request <code>Rstall</code> (which has at least
one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the
same minimum frame duration this will not cause a frame rate loss
if all buffers from the previous <code>Rstall</code> have already been
delivered.
For more details about stalling, see
StreamConfigurationMap#getOutputStallDuration(int,Size).
This control is only effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> is set to
OFF; otherwise the auto-exposure algorithm will override this value.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For more details about stalling, see
<a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a>.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.sensor.sensitivity">
 <td class="entry_name
 " rowspan="5">
 android.sensor.sensitivity
 </td>
 <td class="entry_type">
 int32

[public]

[full]

</td>

<td class="entry_description">
 The amount of gain applied to sensor data
before processing.
 </td>

<td class="entry_units">
 ISO arithmetic units
 </td>

<td class="entry_range">
 <a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The sensitivity is the standard ISO sensitivity value,
as defined in ISO 12232:2006.
The sensitivity must be within <a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a>, and
if if it less than <a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a>, the camera device
is guaranteed to use only analog amplification for applying the gain.
If the camera device cannot apply the exact sensitivity
requested, it will reduce the gain to the nearest supported
value. The final sensitivity used will be available in the
output capture result.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.sensor.testPatternData">
 <td class="entry_name
 " rowspan="5">
 android.sensor.testPatternData
 </td>
 <td class="entry_type">
 int32
 x

4
 
 [public]

</td>

<td class="entry_description">
 A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern
when <a href="#controls_android.sensor.testPatternMode">android.sensor.testPatternMode</a> is SOLID_COLOR.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Each color channel is treated as an unsigned 32-bit integer.
The camera device then uses the most significant X bits
that correspond to how many bits are in its Bayer raw sensor
output.
For example, a sensor with RAW10 Bayer output would use the
10 most significant bits from each color channel.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.sensor.testPatternMode">
 <td class="entry_name
 " rowspan="5">
 android.sensor.testPatternMode
 </td>
 <td class="entry_type">
 int32

[public]

<ul class="entry_type_enum">
 <li>
 OFF
 No test pattern mode is used, and the camera
device returns captures from the image sensor.
This is the default if the key is not set.
 </li>
 <li>
 SOLID_COLOR
 Each pixel in <code>[R, G_even, G_odd, B]</code> is replaced by its
respective color channel provided in
<a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a>.
For example:
<pre><code>android.testPatternData = [0, 0xFFFFFFFF, 0xFFFFFFFF, 0]
</code></pre>
All green pixels are 100% green. All red/blue pixels are black.
<pre><code>android.testPatternData = [0xFFFFFFFF, 0, 0xFFFFFFFF, 0]
</code></pre>
All red pixels are 100% red. Only the odd green pixels
are 100% green. All blue pixels are 100% black.
 </li>
 <li>
 COLOR_BARS
 All pixel data is replaced with an 8-bar color pattern.
The vertical bars (left-to-right) are as follows:
<ul>
<li>100% white</li>
<li>yellow</li>
<li>cyan</li>
<li>green</li>
<li>magenta</li>
<li>red</li>
<li>blue</li>
<li>black</li>
</ul>
In general the image would look like the following:
<pre><code>W Y C G M R B K
W Y C G M R B K
W Y C G M R B K
W Y C G M R B K
W Y C G M R B K
. . . . . . . .
. . . . . . . .
. . . . . . . .

(B = Blue, K = Black)
</code></pre>
Each bar should take up 1/8 of the sensor pixel array width.
When this is not possible, the bar size should be rounded
down to the nearest integer and the pattern can repeat
on the right side.
Each bar's height must always take up the full sensor
pixel array height.
Each pixel in this test pattern must be set to either
0% intensity or 100% intensity.
 </li>
 <li>
 COLOR_BARS_FADE_TO_GRAY
 The test pattern is similar to COLOR_BARS, except that
each bar should start at its specified color at the top,
and fade to gray at the bottom.
Furthermore each bar is further subdivided into a left and
right half. The left half should have a smooth gradient,
and the right half should have a quantized gradient.
In particular, the right half's should consist of blocks of the
same color for 1/16th active sensor pixel array width.
The least significant bits in the quantized gradient should
be copied from the most significant bits of the smooth gradient.
The height of each bar should always be a multiple of 128.
When this is not the case, the pattern should repeat at the bottom
of the image.
 </li>
 <li>
 PN9
 All pixel data is replaced by a pseudo-random sequence
generated from a PN9 512-bit sequence (typically implemented
in hardware with a linear feedback shift register).
The generator should be reset at the beginning of each frame,
and thus each subsequent raw frame with this test pattern should
be exactly the same as the last.
 </li>
 <li>
 CUSTOM1
 256
 The first custom test pattern. All custom patterns that are
available only on this camera device are at least this numeric
value.
All of the custom test patterns will be static
(that is the raw image must not vary from frame to frame).
 </li>
 </ul>

</td>

<td class="entry_description">
 When enabled, the sensor sends a test pattern instead of
doing a real exposure from the camera.
 </td>

<td class="entry_range">
 <a href="#static_android.sensor.availableTestPatternModes">android.sensor.availableTestPatternModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When a test pattern is enabled, all manual sensor controls specified
by android.sensor.* will be ignored. All other controls should
work as normal.
For example, if manual flash is enabled, flash firing should still
occur (and that the test pattern remain unmodified, since the flash
would not actually affect it).
Defaults to OFF.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 All test patterns are specified in the Bayer domain.
The HAL may choose to substitute test patterns from the sensor
with test patterns from on-device memory. In that case, it should be
indistinguishable to the ISP whether the data came from the
sensor interconnect bus (such as CSI2) or memory.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.sensor.info.activeArraySize">
 <td class="entry_name
 " rowspan="5">
 android.sensor.info.activeArraySize
 </td>
 <td class="entry_type">
 int32
 x

4
 
 [public as rectangle]

[legacy]

<div class="entry_type_notes">Four ints defining the active pixel rectangle</div>

</td>

<td class="entry_description">
 The area of the image sensor which corresponds to
active pixels.
 </td>

<td class="entry_units">
 Pixel coordinates on the image sensor
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This is the region of the sensor that actually receives light from the scene.
Therefore, the size of this region determines the maximum field of view and the maximum
number of pixels that an image from this sensor can contain.
The rectangle is defined in terms of the full pixel array; (0,0) is the top-left of the
full pixel array, and the size of the full pixel array is given by
<a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>.
Most other keys listing pixel coordinates have their coordinate systems based on the
active array, with <code>(0, 0)</code> being the top-left of the active array rectangle.
The active array may be smaller than the full pixel array, since the full array may
include black calibration pixels or other inactive regions.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This array contains <code>(xmin, ymin, width, height)</code>. The <code>(xmin, ymin)</code> must be
>= <code>(0,0)</code>.
The <code>(width, height)</code> must be <= <code><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a></code>.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.info.sensitivityRange">
 <td class="entry_name
 " rowspan="3">
 android.sensor.info.sensitivityRange
 </td>
 <td class="entry_type">
 int32
 x

2
 
 [public as rangeInt]

[full]

<div class="entry_type_notes">Range of supported sensitivities</div>

</td>

<td class="entry_description">
 Range of sensitivities for <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> supported by this
camera device.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.info.colorFilterArrangement">
 <td class="entry_name
 " rowspan="1">
 android.sensor.info.colorFilterArrangement
 </td>
 <td class="entry_type">
 byte

[public]

[full]

<ul class="entry_type_enum">
 <li>
 RGGB
 </li>
 <li>
 GRBG
 </li>
 <li>
 GBRG
 </li>
 <li>
 BGGR
 </li>
 <li>
 RGB
 Sensor is not Bayer; output has 3 16-bit
values for each pixel, instead of just 1 16-bit value
per pixel.
 </li>
 </ul>

</td>

<td class="entry_description">
 The arrangement of color filters on sensor;
represents the colors in the top-left 2x2 section of
the sensor, in reading order.
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.info.exposureTimeRange">
 <td class="entry_name
 " rowspan="3">
 android.sensor.info.exposureTimeRange
 </td>
 <td class="entry_type">
 int64
 x

2
 
 [public as rangeLong]

[full]

<div class="entry_type_notes">nanoseconds</div>

</td>

<td class="entry_description">
 The range of image exposure times for <a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a> supported
by this camera device.
 </td>

<td class="entry_units">
 Nanoseconds
 </td>

<td class="entry_range">
 The minimum exposure time will be less than 100 us. For FULL
capability devices (<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL),
the maximum exposure time will be greater than 100ms.
 </td>

</tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For FULL capability devices (<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL),
The maximum of the range SHOULD be at least 1 second (1e9), MUST be at least
100ms.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.info.maxFrameDuration">
 <td class="entry_name
 " rowspan="5">
 android.sensor.info.maxFrameDuration
 </td>
 <td class="entry_type">
 int64

[public]

[full]

</td>

<td class="entry_description">
 The maximum possible frame duration (minimum frame rate) for
<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> that is supported this camera device.
 </td>

<td class="entry_units">
 Nanoseconds
 </td>

<td class="entry_range">
 For FULL capability devices
(<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL), at least 100ms.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Attempting to use frame durations beyond the maximum will result in the frame
duration being clipped to the maximum. See that control for a full definition of frame
durations.
Refer to StreamConfigurationMap#getOutputMinFrameDuration(int,Size) for the minimum
frame duration values.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For FULL capability devices (<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL),
The maximum of the range SHOULD be at least
1 second (1e9), MUST be at least 100ms (100e6).
<a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a> must be greater or
equal to the <a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a> max
value (since exposure time overrides frame duration).
Available minimum frame durations for JPEG must be no greater
than that of the YUV_420_888/IMPLEMENTATION_DEFINED
minimum frame durations (for that respective size).
Since JPEG processing is considered offline and can take longer than
a single uncompressed capture, refer to
<a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a>
for details about encoding this scenario.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.info.physicalSize">
 <td class="entry_name
 " rowspan="5">
 android.sensor.info.physicalSize
 </td>
 <td class="entry_type">
 float
 x

2
 
 [public as sizeF]

[legacy]

<div class="entry_type_notes">width x height</div>

</td>

<td class="entry_description">
 The physical dimensions of the full pixel
array.
 </td>

<td class="entry_units">
 Millimeters
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This is the physical size of the sensor pixel
array defined by <a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.info.pixelArraySize">
 <td class="entry_name
 " rowspan="3">
 android.sensor.info.pixelArraySize
 </td>
 <td class="entry_type">
 int32
 x

2
 
 [public as size]

[legacy]

</td>

<td class="entry_description">
 Dimensions of the full pixel array, possibly
including black calibration pixels.
 </td>

<td class="entry_units">
 Pixels
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The pixel count of the full pixel array,
which covers <a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> area.
If a camera device supports raw sensor formats, either this
or <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> is the maximum output
raw size listed in <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a>.
If a size corresponding to pixelArraySize is listed, the resulting
raw sensor image will include black pixels.
Some parts of the full pixel array may not receive light from the scene,
or are otherwise inactive. The <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> key
defines the rectangle of active pixels that actually forms an image.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.info.whiteLevel">
 <td class="entry_name
 " rowspan="5">
 android.sensor.info.whiteLevel
 </td>
 <td class="entry_type">
 int32

[public]

</td>

<td class="entry_description">
 Maximum raw value output by sensor.
 </td>

<td class="entry_range">
 > 255 (8-bit output)
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This specifies the fully-saturated encoding level for the raw
sample values from the sensor. This is typically caused by the
sensor becoming highly non-linear or clipping. The minimum for
each channel is specified by the offset in the
<a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a> key.
The white level is typically determined either by sensor bit depth
(8-14 bits is expected), or by the point where the sensor response
becomes too non-linear to be useful. The default value for this is
maximum representable value for a 16-bit raw sample (2^16 - 1).
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The full bit depth of the sensor must be available in the raw data,
so the value for linear sensors should not be significantly lower
than maximum raw value supported, i.e. 2^(sensor bits per pixel).
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.info.timestampSource">
 <td class="entry_name
 " rowspan="3">
 android.sensor.info.timestampSource
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 UNKNOWN
 Timestamps from <a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a> are in nanoseconds and monotonic,
but can not be compared to timestamps from other subsystems
(e.g. accelerometer, gyro etc.), or other instances of the same or different
camera devices in the same system. Timestamps between streams and results for
a single camera instance are comparable, and the timestamps for all buffers
and the result metadata generated by a single capture are identical.
 </li>
 <li>
 REALTIME
 Timestamps from <a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a> are in the same timebase as
android.os.SystemClock#elapsedRealtimeNanos(),
and they can be compared to other timestamps using that base.
 </li>
 </ul>

</td>

<td class="entry_description">
 The time base source for sensor capture start timestamps.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The timestamps provided for captures are always in nanoseconds and monotonic, but
may not based on a time source that can be compared to other system time sources.
This characteristic defines the source for the timestamps, and therefore whether they
can be compared against other system time sources/timestamps.
 </td>
 </tr>

<tr class="entry" id="static_android.sensor.referenceIlluminant1">
 <td class="entry_name
 " rowspan="5">
 android.sensor.referenceIlluminant1
 </td>
 <td class="entry_type">
 byte

[public]

<ul class="entry_type_enum">
 <li>
 DAYLIGHT
 1
 </li>
 <li>
 FLUORESCENT
 2
 </li>
 <li>
 TUNGSTEN
 3
 Incandescent light
 </li>
 <li>
 FLASH
 4
 </li>
 <li>
 FINE_WEATHER
 9
 </li>
 <li>
 CLOUDY_WEATHER
 10
 </li>
 <li>
 SHADE
 11
 </li>
 <li>
 DAYLIGHT_FLUORESCENT
 12
 D 5700 - 7100K
 </li>
 <li>
 DAY_WHITE_FLUORESCENT
 13
 N 4600 - 5400K
 </li>
 <li>
 COOL_WHITE_FLUORESCENT
 14
 W 3900 - 4500K
 </li>
 <li>
 WHITE_FLUORESCENT
 15
 WW 3200 - 3700K
 </li>
 <li>
 STANDARD_A
 17
 </li>
 <li>
 STANDARD_B
 18
 </li>
 <li>
 STANDARD_C
 19
 </li>
 <li>
 D55
 20
 </li>
 <li>
 D65
 21
 </li>
 <li>
 D75
 22
 </li>
 <li>
 D50
 23
 </li>
 <li>
 ISO_STUDIO_TUNGSTEN
 24
 </li>
 </ul>

</td>

<td class="entry_description">
 The standard reference illuminant used as the scene light source when
calculating the <a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a>,
<a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a>, and
<a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a> matrices.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The values in this key correspond to the values defined for the
EXIF LightSource tag. These illuminants are standard light sources
that are often used calibrating camera devices.
If this key is present, then <a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a>,
<a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a>, and
<a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a> will also be present.
Some devices may choose to provide a second set of calibration
information for improved quality, including
<a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a> and its corresponding matrices.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The first reference illuminant (<a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a>)
and corresponding matrices must be present to support the RAW capability
and DNG output.
When producing raw images with a color profile that has only been
calibrated against a single light source, it is valid to omit
<a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a> along with the
<a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a>, <a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a>,
and <a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a> matrices.
If only <a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a> is included, it should be
chosen so that it is representative of typical scene lighting. In
general, D50 or DAYLIGHT will be chosen for this case.
If both <a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a> and
<a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a> are included, they should be
chosen to represent the typical range of scene lighting conditions.
In general, low color temperature illuminant such as Standard-A will
be chosen for the first reference illuminant and a higher color
temperature illuminant such as D65 will be chosen for the second
reference illuminant.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.referenceIlluminant2">
 <td class="entry_name
 " rowspan="3">
 android.sensor.referenceIlluminant2
 </td>
 <td class="entry_type">
 byte

[public]

</td>

<td class="entry_description">
 The standard reference illuminant used as the scene light source when
calculating the <a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a>,
<a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a>, and
<a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a> matrices.
 </td>

<td class="entry_range">
 Any value listed in <a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 See <a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a> for more details.
If this key is present, then <a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a>,
<a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a>, and
<a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a> will also be present.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.calibrationTransform1">
 <td class="entry_name
 " rowspan="3">
 android.sensor.calibrationTransform1
 </td>
 <td class="entry_type">
 rational
 x

3 x 3
 
 [public as colorSpaceTransform]

<div class="entry_type_notes">3x3 matrix in row-major-order</div>

</td>

<td class="entry_description">
 A per-device calibration transform matrix that maps from the
reference sensor colorspace to the actual device sensor colorspace.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.calibrationTransform2">
 <td class="entry_name
 " rowspan="3">
 android.sensor.calibrationTransform2
 </td>
 <td class="entry_type">
 rational
 x

3 x 3
 
 [public as colorSpaceTransform]

<div class="entry_type_notes">3x3 matrix in row-major-order</div>

</td>

<td class="entry_description">
 A per-device calibration transform matrix that maps from the
reference sensor colorspace to the actual device sensor colorspace
(this is the colorspace of the raw buffer data).
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This matrix is used to correct for per-device variations in the
sensor colorspace, and is used for processing raw buffer data.
The matrix is expressed as a 3x3 matrix in row-major-order, and
contains a per-device calibration transform that maps colors
from reference sensor color space (i.e. the "golden module"
colorspace) into this camera device's native sensor color
space under the second reference illuminant
(<a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a>).
This matrix will only be present if the second reference
illuminant is present.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.colorTransform1">
 <td class="entry_name
 " rowspan="3">
 android.sensor.colorTransform1
 </td>
 <td class="entry_type">
 rational
 x

3 x 3
 
 [public as colorSpaceTransform]

<div class="entry_type_notes">3x3 matrix in row-major-order</div>

</td>

<td class="entry_description">
 A matrix that transforms color values from CIE XYZ color space to
reference sensor color space.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This matrix is used to convert from the standard CIE XYZ color
space to the reference sensor colorspace, and is used when processing
raw buffer data.
The matrix is expressed as a 3x3 matrix in row-major-order, and
contains a color transform matrix that maps colors from the CIE
XYZ color space to the reference sensor color space (i.e. the
"golden module" colorspace) under the first reference illuminant
(<a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a>).
The white points chosen in both the reference sensor color space
and the CIE XYZ colorspace when calculating this transform will
match the standard white point for the first reference illuminant
(i.e. no chromatic adaptation will be applied by this transform).
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.colorTransform2">
 <td class="entry_name
 " rowspan="3">
 android.sensor.colorTransform2
 </td>
 <td class="entry_type">
 rational
 x

3 x 3
 
 [public as colorSpaceTransform]

<div class="entry_type_notes">3x3 matrix in row-major-order</div>

</td>

<td class="entry_description">
 A matrix that transforms color values from CIE XYZ color space to
reference sensor color space.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This matrix is used to convert from the standard CIE XYZ color
space to the reference sensor colorspace, and is used when processing
raw buffer data.
The matrix is expressed as a 3x3 matrix in row-major-order, and
contains a color transform matrix that maps colors from the CIE
XYZ color space to the reference sensor color space (i.e. the
"golden module" colorspace) under the second reference illuminant
(<a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a>).
The white points chosen in both the reference sensor color space
and the CIE XYZ colorspace when calculating this transform will
match the standard white point for the second reference illuminant
(i.e. no chromatic adaptation will be applied by this transform).
This matrix will only be present if the second reference
illuminant is present.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.forwardMatrix1">
 <td class="entry_name
 " rowspan="3">
 android.sensor.forwardMatrix1
 </td>
 <td class="entry_type">
 rational
 x

3 x 3
 
 [public as colorSpaceTransform]

<div class="entry_type_notes">3x3 matrix in row-major-order</div>

</td>

<td class="entry_description">
 A matrix that transforms white balanced camera colors from the reference
sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This matrix is used to convert to the standard CIE XYZ colorspace, and
is used when processing raw buffer data.
This matrix is expressed as a 3x3 matrix in row-major-order, and contains
a color transform matrix that maps white balanced colors from the
reference sensor color space to the CIE XYZ color space with a D50 white
point.
Under the first reference illuminant (<a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a>)
this matrix is chosen so that the standard white point for this reference
illuminant in the reference sensor colorspace is mapped to D50 in the
CIE XYZ colorspace.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.forwardMatrix2">
 <td class="entry_name
 " rowspan="3">
 android.sensor.forwardMatrix2
 </td>
 <td class="entry_type">
 rational
 x

3 x 3
 
 [public as colorSpaceTransform]

<div class="entry_type_notes">3x3 matrix in row-major-order</div>

</td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This matrix is used to convert to the standard CIE XYZ colorspace, and
is used when processing raw buffer data.
This matrix is expressed as a 3x3 matrix in row-major-order, and contains
a color transform matrix that maps white balanced colors from the
reference sensor color space to the CIE XYZ color space with a D50 white
point.
Under the second reference illuminant (<a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a>)
this matrix is chosen so that the standard white point for this reference
illuminant in the reference sensor colorspace is mapped to D50 in the
CIE XYZ colorspace.
This matrix will only be present if the second reference
illuminant is present.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.baseGainFactor">
 <td class="entry_name
 " rowspan="1">
 android.sensor.baseGainFactor
 </td>
 <td class="entry_type">
 rational

[system]

</td>

<td class="entry_description">
 Gain factor from electrons to raw units when
ISO=100
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.blackLevelPattern">
 <td class="entry_name
 " rowspan="5">
 android.sensor.blackLevelPattern
 </td>
 <td class="entry_type">
 int32
 x

4
 
 [public as blackLevelPattern]

<div class="entry_type_notes">2x2 raw count block</div>

</td>

<td class="entry_description">
 A fixed black level offset for each of the color filter arrangement
(CFA) mosaic channels.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This key specifies the zero light value for each of the CFA mosaic
channels in the camera sensor. The maximal value output by the
sensor is represented by the value in <a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a>.
The values are given in the same order as channels listed for the CFA
layout key (see <a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a>), i.e. the
nth value given corresponds to the black level offset for the nth
color channel listed in the CFA.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The values are given in row-column scan order, with the first value
corresponding to the element of the CFA in row=0, column=0.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.maxAnalogSensitivity">
 <td class="entry_name
 " rowspan="3">
 android.sensor.maxAnalogSensitivity
 </td>
 <td class="entry_type">
 int32

[public]

[full]

</td>

<td class="entry_description">
 Maximum sensitivity that is implemented
purely through analog gain.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> values less than or
equal to this, all applied gain must be analog. For
values above this, the gain applied can be a mix of analog and
digital.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.orientation">
 <td class="entry_name
 " rowspan="3">
 android.sensor.orientation
 </td>
 <td class="entry_type">
 int32

[public]

[legacy]

</td>

<td class="entry_description">
 Clockwise angle through which the output image needs to be rotated to be
upright on the device screen in its native orientation.
 </td>

<td class="entry_units">
 Degrees of clockwise rotation; always a multiple of
 90
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Also defines the direction of rolling shutter readout, which is from top to bottom in
the sensor's coordinate system.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.profileHueSatMapDimensions">
 <td class="entry_name
 " rowspan="3">
 android.sensor.profileHueSatMapDimensions
 </td>
 <td class="entry_type">
 int32
 x

3
 
 [system]

<div class="entry_type_notes">Number of samples for hue, saturation, and value</div>

</td>

<td class="entry_description">
 The number of input samples for each dimension of
<a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a>.
 </td>

<td class="entry_range">
 Hue >= 1,
Saturation >= 2,
Value >= 1
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The number of input samples for the hue, saturation, and value
dimension of <a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a>. The order of the
dimensions given is hue, saturation, value; where hue is the 0th
element.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.sensor.availableTestPatternModes">
 <td class="entry_name
 " rowspan="5">
 android.sensor.availableTestPatternModes
 </td>
 <td class="entry_type">
 int32
 x

n
 
 [public]

<div class="entry_type_notes">list of enums</div>

</td>

<td class="entry_description">
 List of sensor test pattern modes for <a href="#controls_android.sensor.testPatternMode">android.sensor.testPatternMode</a>
supported by this camera device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.sensor.testPatternMode">android.sensor.testPatternMode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Defaults to OFF, and always includes OFF if defined.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.sensor.exposureTime">
 <td class="entry_name
 " rowspan="3">
 android.sensor.exposureTime
 </td>
 <td class="entry_type">
 int64

[public]

[full]

</td>

<td class="entry_description">
 Duration each pixel is exposed to
light.
 </td>

<td class="entry_units">
 Nanoseconds
 </td>

<td class="entry_range">
 <a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a>
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.sensor.frameDuration">
 <td class="entry_name
 " rowspan="5">
 android.sensor.frameDuration
 </td>
 <td class="entry_type">
 int64

[public]

[full]

</td>

<td class="entry_description">
 Duration from start of frame exposure to
start of next frame exposure.
 </td>

<td class="entry_units">
 Nanoseconds
 </td>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For more details about stalling, see
<a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a>.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.sensor.sensitivity">
 <td class="entry_name
 " rowspan="5">
 android.sensor.sensitivity
 </td>
 <td class="entry_type">
 int32

[public]

[full]

</td>

<td class="entry_description">
 The amount of gain applied to sensor data
before processing.
 </td>

<td class="entry_units">
 ISO arithmetic units
 </td>

<td class="entry_range">
 <a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a>
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.sensor.timestamp">
 <td class="entry_name
 " rowspan="5">
 android.sensor.timestamp
 </td>
 <td class="entry_type">
 int64

[public]

[legacy]

</td>

<td class="entry_description">
 Time at start of exposure of first
row of the image sensor active array, in nanoseconds.
 </td>

<td class="entry_units">
 Nanoseconds
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The timestamps are also included in all image
buffers produced for the same capture, and will be identical
on all the outputs.
When <a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> <code>==</code> UNKNOWN,
the timestamps measure time since an unspecified starting point,
and are monotonically increasing. They can be compared with the
timestamps for other captures from the same camera device, but are
not guaranteed to be comparable to any other time source.
When <a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> <code>==</code> REALTIME,
the timestamps measure time in the same timebase as
android.os.SystemClock#elapsedRealtimeNanos(), and they can be
compared to other timestamps from other subsystems that are using
that base.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 All timestamps must be in reference to the kernel's
CLOCK_BOOTTIME monotonic clock, which properly accounts for
time spent asleep. This allows for synchronization with
sensors that continue to operate while the system is
otherwise asleep.
If <a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> <code>==</code> REALTIME,
The timestamp must be synchronized with the timestamps from other
sensor subsystems that are using the same timebase.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.sensor.temperature">
 <td class="entry_name
 " rowspan="1">
 android.sensor.temperature
 </td>
 <td class="entry_type">
 float

[system]

</td>

<td class="entry_description">
 The temperature of the sensor, sampled at the time
exposure began for this frame.
The thermal diode being queried should be inside the sensor PCB, or
somewhere close to it.
 </td>

<td class="entry_units">
 Celsius
 </td>

<td class="entry_range">
 Optional. This value is missing if no temperature is available.
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.sensor.neutralColorPoint">
 <td class="entry_name
 " rowspan="3">
 android.sensor.neutralColorPoint
 </td>
 <td class="entry_type">
 rational
 x

3
 
 [public]

</td>

<td class="entry_description">
 The estimated camera neutral color in the native sensor colorspace at
the time of capture.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This value gives the neutral color point encoded as an RGB value in the
native sensor color space. The neutral color point indicates the
currently estimated white point of the scene illumination. It can be
used to interpolate between the provided color transforms when
processing raw sensor data.
The order of the values is R, G, B; where R is in the lowest index.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.sensor.noiseProfile">
 <td class="entry_name
 " rowspan="5">
 android.sensor.noiseProfile
 </td>
 <td class="entry_type">
 double
 x

2 x CFA Channels
 
 [public as pairDoubleDouble]

<div class="entry_type_notes">Pairs of noise model coefficients</div>

</td>

<td class="entry_description">
 Noise model coefficients for each CFA mosaic channel.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This key contains two noise model coefficients for each CFA channel
corresponding to the sensor amplification (S) and sensor readout
noise (O). These are given as pairs of coefficients for each channel
in the same order as channels listed for the CFA layout key
(see <a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a>). This is
represented as an array of Pair<Double, Double>, where
the first member of the Pair at index n is the S coefficient and the
second member is the O coefficient for the nth color channel in the CFA.
These coefficients are used in a two parameter noise model to describe
the amount of noise present in the image for each CFA channel. The
noise model used here is:
N(x) = sqrt(Sx + O)
Where x represents the recorded signal of a CFA channel normalized to
the range [0, 1], and S and O are the noise model coeffiecients for
that channel.
A more detailed description of the noise model can be found in the
Adobe DNG specification for the NoiseProfile tag.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For a CFA layout of RGGB, the list of coefficients would be given as
an array of doubles S0,O0,S1,O1,..., where S0 and O0 are the coefficients
for the red channel, S1 and O1 are the coefficients for the first green
channel, etc.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.sensor.profileHueSatMap">
 <td class="entry_name
 " rowspan="3">
 android.sensor.profileHueSatMap
 </td>
 <td class="entry_type">
 float
 x

hue_samples x saturation_samples x value_samples x 3
 
 [system]

<div class="entry_type_notes">Mapping for hue, saturation, and value</div>

</td>

<td class="entry_description">
 A mapping containing a hue shift, saturation scale, and value scale
for each pixel.
 </td>

<td class="entry_units">
 
 The hue shift is given in degrees; saturation and value scale factors are
 unitless and are between 0 and 1 inclusive
 
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 hue_samples, saturation_samples, and value_samples are given in
<a href="#static_android.sensor.profileHueSatMapDimensions">android.sensor.profileHueSatMapDimensions</a>.
Each entry of this map contains three floats corresponding to the
hue shift, saturation scale, and value scale, respectively; where the
hue shift has the lowest index. The map entries are stored in the key
in nested loop order, with the value divisions in the outer loop, the
hue divisions in the middle loop, and the saturation divisions in the
inner loop. All zero input saturation entries are required to have a
value scale factor of 1.0.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.sensor.profileToneCurve">
 <td class="entry_name
 " rowspan="3">
 android.sensor.profileToneCurve
 </td>
 <td class="entry_type">
 float
 x

samples x 2
 
 [system]

<div class="entry_type_notes">Samples defining a spline for a tone-mapping curve</div>

</td>

<td class="entry_description">
 A list of x,y samples defining a tone-mapping curve for gamma adjustment.
 </td>

<td class="entry_range">
 Each sample has an input range of <code>[0, 1]</code> and an output range of
<code>[0, 1]</code>. The first sample is required to be <code>(0, 0)</code>, and the last
sample is required to be <code>(1, 1)</code>.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This key contains a default tone curve that can be applied while
processing the image as a starting point for user adjustments.
The curve is specified as a list of value pairs in linear gamma.
The curve is interpolated using a cubic spline.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.sensor.greenSplit">
 <td class="entry_name
 " rowspan="5">
 android.sensor.greenSplit
 </td>
 <td class="entry_type">
 float

[public]

</td>

<td class="entry_description">
 The worst-case divergence between Bayer green channels.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This value is an estimate of the worst case split between the
Bayer green channels in the red and blue rows in the sensor color
filter array.
The green split is calculated as follows:
<ol>
<li>A 5x5 pixel (or larger) window W within the active sensor array is
chosen. The term 'pixel' here is taken to mean a group of 4 Bayer
mosaic channels (R, Gr, Gb, B). The location and size of the window
chosen is implementation defined, and should be chosen to provide a
green split estimate that is both representative of the entire image
for this camera sensor, and can be calculated quickly.</li>
<li>The arithmetic mean of the green channels from the red
rows (mean_Gr) within W is computed.</li>
<li>The arithmetic mean of the green channels from the blue
rows (mean_Gb) within W is computed.</li>
<li>The maximum ratio R of the two means is computed as follows:
<code>R = max((mean_Gr + 1)/(mean_Gb + 1), (mean_Gb + 1)/(mean_Gr + 1))</code></li>
</ol>
The ratio R is the green split divergence reported for this property,
which represents how much the green channels differ in the mosaic
pattern. This value is typically used to determine the treatment of
the green mosaic channels when demosaicing.
The green split value can be roughly interpreted as follows:
<ul>
<li>R < 1.03 is a negligible split (<3% divergence).</li>
<li>1.20 <= R >= 1.03 will require some software
correction to avoid demosaic errors (3-20% divergence).</li>
<li>R > 1.20 will require strong software correction to produce
a usuable image (>20% divergence).</li>
</ul>
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The green split given may be a static value based on prior
characterization of the camera sensor using the green split
calculation method given here over a large, representative, sample
set of images. Other methods of calculation that produce equivalent
results, and can be interpreted in the same manner, may be used.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.sensor.testPatternData">
 <td class="entry_name
 " rowspan="5">
 android.sensor.testPatternData
 </td>
 <td class="entry_type">
 int32
 x

4
 
 [public]

</td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.sensor.testPatternMode">
 <td class="entry_name
 " rowspan="5">
 android.sensor.testPatternMode
 </td>
 <td class="entry_type">
 int32

[public]

</td>

<td class="entry_description">
 When enabled, the sensor sends a test pattern instead of
doing a real exposure from the camera.
 </td>

<td class="entry_range">
 <a href="#static_android.sensor.availableTestPatternModes">android.sensor.availableTestPatternModes</a>
 </td>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 All test patterns are specified in the Bayer domain.
The HAL may choose to substitute test patterns from the sensor
with test patterns from on-device memory. In that case, it should be
indistinguishable to the ISP whether the data came from the
sensor interconnect bus (such as CSI2) or memory.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.sensor.rollingShutterSkew">
 <td class="entry_name
 " rowspan="5">
 android.sensor.rollingShutterSkew
 </td>
 <td class="entry_type">
 int64

[public]

[limited]

</td>

<td class="entry_description">
 Duration between the start of first row exposure
and the start of last row exposure.
 </td>

<td class="entry_units">
 Nanoseconds
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This is the exposure time skew between the first and last
row exposure start times. The first row and the last row are
the first and last rows inside of the
<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.
For typical camera sensors that use rolling shutters, this is also equivalent
to the frame readout time.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The HAL must report <code>0</code> if the sensor is using global shutter, where all pixels begin
exposure at the same time.
 </td>
 </tr>

</tbody>

<tr><td colspan="6" id="section_shading" class="section">shading</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.shading.mode">
 <td class="entry_name
 " rowspan="3">
 android.shading.mode
 </td>
 <td class="entry_type">
 byte

[public]

[full]

<ul class="entry_type_enum">
 <li>
 OFF
 No lens shading correction is applied.
 </li>
 <li>
 FAST
 Apply lens shading corrections, without slowing
frame rate relative to sensor raw output
 </li>
 <li>
 HIGH_QUALITY
 Apply high-quality lens shading correction, at the
cost of reduced frame rate.
 </li>
 </ul>

</td>

<td class="entry_description">
 Quality of lens shading correction applied
to the image data.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When set to OFF mode, no lens shading correction will be applied by the
camera device, and an identity lens shading map data will be provided
if <code><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> == ON</code>. For example, for lens
shading map with size of <code>[ 4, 3 ]</code>,
the output <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a> for this case will be an identity
map shown below:
<pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ]
</code></pre>
When set to other modes, lens shading correction will be applied by the camera
device. Applications can request lens shading map data by setting
<a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> to ON, and then the camera device will provide lens
shading map data in <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a>; the returned shading map
data will be the one applied by the camera device for this capture request.
The shading map data may depend on the auto-exposure (AE) and AWB statistics, therefore
the reliability of the map data may be affected by the AE and AWB algorithms. When AE and
AWB are in AUTO modes(<a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>!=</code> OFF and <a href="#controls_android.control.awbMode">android.control.awbMode</a> <code>!=</code>
OFF), to get best results, it is recommended that the applications wait for the AE and AWB
to be converged before using the returned shading map data.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.shading.strength">
 <td class="entry_name
 " rowspan="1">
 android.shading.strength
 </td>
 <td class="entry_type">
 byte

[system]

</td>

<td class="entry_description">
 Control the amount of shading correction
applied to the images
 </td>

<td class="entry_units">
 unitless: 1-10; 10 is full shading
 compensation
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.shading.mode">
 <td class="entry_name
 " rowspan="3">
 android.shading.mode
 </td>
 <td class="entry_type">
 byte

[public]

[full]

</td>

<td class="entry_description">
 Quality of lens shading correction applied
to the image data.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When set to OFF mode, no lens shading correction will be applied by the
camera device, and an identity lens shading map data will be provided
if <code><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> == ON</code>. For example, for lens
shading map with size of <code>[ 4, 3 ]</code>,
the output <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a> for this case will be an identity
map shown below:
<pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ]
</code></pre>
When set to other modes, lens shading correction will be applied by the camera
device. Applications can request lens shading map data by setting
<a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> to ON, and then the camera device will provide lens
shading map data in <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a>; the returned shading map
data will be the one applied by the camera device for this capture request.
The shading map data may depend on the auto-exposure (AE) and AWB statistics, therefore
the reliability of the map data may be affected by the AE and AWB algorithms. When AE and
AWB are in AUTO modes(<a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>!=</code> OFF and <a href="#controls_android.control.awbMode">android.control.awbMode</a> <code>!=</code>
OFF), to get best results, it is recommended that the applications wait for the AE and AWB
to be converged before using the returned shading map data.
 </td>
 </tr>

</tbody>

<tr><td colspan="6" id="section_statistics" class="section">statistics</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.statistics.faceDetectMode">
 <td class="entry_name
 " rowspan="5">
 android.statistics.faceDetectMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 OFF
 Do not include face detection statistics in capture
results.
 </li>
 <li>
 SIMPLE
 [optional]
 Return face rectangle and confidence values only.
 </li>
 <li>
 FULL
 [optional]
 Return all face
metadata.
In this mode, face rectangles, scores, landmarks, and face IDs are all valid.
 </li>
 </ul>

</td>

<td class="entry_description">
 Operating mode for the face detector
unit.
 </td>

<td class="entry_range">
 <a href="#static_android.statistics.info.availableFaceDetectModes">android.statistics.info.availableFaceDetectModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Whether face detection is enabled, and whether it
should output just the basic fields or the full set of
fields.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 SIMPLE mode must fill in <a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a> and
<a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a>.
FULL mode must also fill in <a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a>, and
<a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a>.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.statistics.histogramMode">
 <td class="entry_name
 " rowspan="1">
 android.statistics.histogramMode
 </td>
 <td class="entry_type">
 byte

[system as boolean]

</td>

<td class="entry_description">
 Operating mode for histogram
generation
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.statistics.sharpnessMapMode">
 <td class="entry_name
 " rowspan="1">
 android.statistics.sharpnessMapMode
 </td>
 <td class="entry_type">
 byte

[system as boolean]

</td>

<td class="entry_description">
 Operating mode for sharpness map
generation
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.statistics.hotPixelMapMode">
 <td class="entry_name
 " rowspan="3">
 android.statistics.hotPixelMapMode
 </td>
 <td class="entry_type">
 byte

[public as boolean]

<ul class="entry_type_enum">
 <li>
 OFF
 Hot pixel map production is disabled.
 </li>
 <li>
 ON
 Hot pixel map production is enabled.
 </li>
 </ul>

</td>

<td class="entry_description">
 Operating mode for hot pixel map generation.
 </td>

<td class="entry_range">
 <a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If set to <code>true</code>, a hot pixel map is returned in <a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a>.
If set to <code>false</code>, no hot pixel map will be returned.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.statistics.lensShadingMapMode">
 <td class="entry_name
 " rowspan="3">
 android.statistics.lensShadingMapMode
 </td>
 <td class="entry_type">
 byte

[public]

[full]

<ul class="entry_type_enum">
 <li>
 OFF
 Do not include a lens shading map in the capture result.
 </li>
 <li>
 ON
 Include a lens shading map in the capture result.
 </li>
 </ul>

</td>

<td class="entry_description">
 Whether the camera device will output the lens
shading map in output result metadata.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When set to ON,
<a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a> will be provided in
the output result metadata.
ON is always supported on devices with the RAW capability.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.statistics.info.availableFaceDetectModes">
 <td class="entry_name
 " rowspan="3">
 android.statistics.info.availableFaceDetectModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[legacy]

<div class="entry_type_notes">List of enums from android.statistics.faceDetectMode</div>

</td>

<td class="entry_description">
 List of face detection modes for <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> that are
supported by this camera device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 OFF is always supported.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.statistics.info.histogramBucketCount">
 <td class="entry_name
 " rowspan="1">
 android.statistics.info.histogramBucketCount
 </td>
 <td class="entry_type">
 int32

[system]

</td>

<td class="entry_description">
 Number of histogram buckets
supported
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.statistics.info.maxFaceCount">
 <td class="entry_name
 " rowspan="1">
 android.statistics.info.maxFaceCount
 </td>
 <td class="entry_type">
 int32

[public]

[legacy]

</td>

<td class="entry_description">
 The maximum number of simultaneously detectable
faces.
 </td>

<td class="entry_range">
 0 for cameras without available face detection; otherwise:
<code>>=4</code> for LIMITED or FULL hwlevel devices or
<code>>0</code> for LEGACY devices.
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.statistics.info.maxHistogramCount">
 <td class="entry_name
 " rowspan="1">
 android.statistics.info.maxHistogramCount
 </td>
 <td class="entry_type">
 int32

[system]

</td>

<td class="entry_description">
 Maximum value possible for a histogram
bucket
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.statistics.info.maxSharpnessMapValue">
 <td class="entry_name
 " rowspan="1">
 android.statistics.info.maxSharpnessMapValue
 </td>
 <td class="entry_type">
 int32

[system]

</td>

<td class="entry_description">
 Maximum value possible for a sharpness map
region.
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.statistics.info.sharpnessMapSize">
 <td class="entry_name
 " rowspan="1">
 android.statistics.info.sharpnessMapSize
 </td>
 <td class="entry_type">
 int32
 x

2
 
 [system as size]

<div class="entry_type_notes">width x height</div>

</td>

<td class="entry_description">
 Dimensions of the sharpness
map
 </td>

<td class="entry_range">
 Must be at least 32 x 32
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.statistics.info.availableHotPixelMapModes">
 <td class="entry_name
 " rowspan="3">
 android.statistics.info.availableHotPixelMapModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as boolean]

<div class="entry_type_notes">list of enums</div>

</td>

<td class="entry_description">
 List of hot pixel map output modes for <a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a> that are
supported by this camera device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If no hotpixel map output is available for this camera device, this will contain only
<code>false</code>.
ON is always supported on devices with the RAW capability.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.statistics.faceDetectMode">
 <td class="entry_name
 " rowspan="5">
 android.statistics.faceDetectMode
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

</td>

<td class="entry_description">
 Operating mode for the face detector
unit.
 </td>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 SIMPLE mode must fill in <a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a> and
<a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a>.
FULL mode must also fill in <a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a>, and
<a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a>.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.faceIds">
 <td class="entry_name
 " rowspan="3">
 android.statistics.faceIds
 </td>
 <td class="entry_type">
 int32
 x

n
 
 [hidden]

[legacy]

</td>

<td class="entry_description">
 List of unique IDs for detected faces.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Each detected face is given a unique ID that is valid for as long as the face is visible
to the camera device. A face that leaves the field of view and later returns may be
assigned a new ID.
Only available if <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> == FULL
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.faceLandmarks">
 <td class="entry_name
 " rowspan="3">
 android.statistics.faceLandmarks
 </td>
 <td class="entry_type">
 int32
 x

n x 6
 
 [hidden]

[legacy]

<div class="entry_type_notes">(leftEyeX, leftEyeY, rightEyeX, rightEyeY, mouthX, mouthY)</div>

</td>

<td class="entry_description">
 List of landmarks for detected
faces.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The coordinate system is that of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with
<code>(0, 0)</code> being the top-left pixel of the active array.
Only available if <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> == FULL
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.faceRectangles">
 <td class="entry_name
 " rowspan="3">
 android.statistics.faceRectangles
 </td>
 <td class="entry_type">
 int32
 x

n x 4
 
 [hidden as rectangle]

[legacy]

<div class="entry_type_notes">(xmin, ymin, xmax, ymax). (0,0) is top-left of active pixel area</div>

</td>

<td class="entry_description">
 List of the bounding rectangles for detected
faces.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.faceScores">
 <td class="entry_name
 " rowspan="5">
 android.statistics.faceScores
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [hidden]

[legacy]

</td>

<td class="entry_description">
 List of the face confidence scores for
detected faces
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Only available if <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> != OFF.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.faces">
 <td class="entry_name
 " rowspan="3">
 android.statistics.faces
 </td>
 <td class="entry_type">
 int32
 x

n
 
 [public as face]

[synthetic]

[legacy]

</td>

<td class="entry_description">
 List of the faces detected through camera face detection
in this capture.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Only available if <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> <code>!=</code> OFF.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.histogram">
 <td class="entry_name
 " rowspan="3">
 android.statistics.histogram
 </td>
 <td class="entry_type">
 int32
 x

n x 3
 
 [system]

<div class="entry_type_notes">count of pixels for each color channel that fall into each histogram bucket, scaled to be between 0 and maxHistogramCount</div>

</td>

<td class="entry_description">
 A 3-channel histogram based on the raw
sensor data
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The k'th bucket (0-based) covers the input range
(with w = <a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a>) of [ k * w/N,
(k + 1) * w / N ). If only a monochrome sharpness map is
supported, all channels should have the same data
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.histogramMode">
 <td class="entry_name
 " rowspan="1">
 android.statistics.histogramMode
 </td>
 <td class="entry_type">
 byte

[system as boolean]

</td>

<td class="entry_description">
 Operating mode for histogram
generation
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.sharpnessMap">
 <td class="entry_name
 " rowspan="3">
 android.statistics.sharpnessMap
 </td>
 <td class="entry_type">
 int32
 x

n x m x 3
 
 [system]

<div class="entry_type_notes">estimated sharpness for each region of the input image. Normalized to be between 0 and maxSharpnessMapValue. Higher values mean sharper (better focused)</div>

</td>

<td class="entry_description">
 A 3-channel sharpness map, based on the raw
sensor data
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If only a monochrome sharpness map is supported,
all channels should have the same data
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.sharpnessMapMode">
 <td class="entry_name
 " rowspan="1">
 android.statistics.sharpnessMapMode
 </td>
 <td class="entry_type">
 byte

[system as boolean]

</td>

<td class="entry_description">
 Operating mode for sharpness map
generation
 </td>

<td class="entry_tags">
 <ul class="entry_tags">
 <li><a href="#tag_FUTURE">FUTURE</a></li>
 </ul>
 </td>

</tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.lensShadingCorrectionMap">
 <td class="entry_name
 " rowspan="3">
 android.statistics.lensShadingCorrectionMap
 </td>
 <td class="entry_type">
 byte

[public as lensShadingMap]

[full]

</td>

<td class="entry_description">
 The shading map is a low-resolution floating-point map
that lists the coefficients used to correct for vignetting, for each
Bayer color channel.
 </td>

<td class="entry_range">
 Each gain factor is >= 1
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The least shaded section of the image should have a gain factor
of 1; all other sections should have gains above 1.
When <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> = TRANSFORM_MATRIX, the map
must take into account the colorCorrection settings.
The shading map is for the entire active pixel array, and is not
affected by the crop region specified in the request. Each shading map
entry is the value of the shading compensation map over a specific
pixel on the sensor. Specifically, with a (N x M) resolution shading
map, and an active pixel array size (W x H), shading map entry
(x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at
pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels.
The map is assumed to be bilinearly interpolated between the sample points.
The channel order is [R, Geven, Godd, B], where Geven is the green
channel for the even rows of a Bayer pattern, and Godd is the odd rows.
The shading map is stored in a fully interleaved format.
The shading map should have on the order of 30-40 rows and columns,
and must be smaller than 64x64.
As an example, given a very small map defined as:
<pre><code>width,height = [ 4, 3 ]
values =
[ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2,
 1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3,
 1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0,
 1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2,
 1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2,
 1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ]
</code></pre>
The low-resolution scaling map images for each channel are
(displayed using nearest-neighbor interpolation):
<img alt="Red lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png"/>
<img alt="Green (even rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png"/>
<img alt="Green (odd rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png"/>
<img alt="Blue lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png"/>
As a visualization only, inverting the full-color map to recover an
image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:
<img alt="Image of a uniform white wall (inverse shading map)" src="images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png"/>
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.lensShadingMap">
 <td class="entry_name
 " rowspan="5">
 android.statistics.lensShadingMap
 </td>
 <td class="entry_type">
 float
 x

4 x n x m
 
 [hidden]

[full]

<div class="entry_type_notes">2D array of float gain factors per channel to correct lens shading</div>

</td>

<td class="entry_range">
 Each gain factor is >= 1
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The least shaded section of the image should have a gain factor
of 1; all other sections should have gains above 1.
When <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> = TRANSFORM_MATRIX, the map
must take into account the colorCorrection settings.
The shading map is for the entire active pixel array, and is not
affected by the crop region specified in the request. Each shading map
entry is the value of the shading compensation map over a specific
pixel on the sensor. Specifically, with a (N x M) resolution shading
map, and an active pixel array size (W x H), shading map entry
(x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at
pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels.
The map is assumed to be bilinearly interpolated between the sample points.
The channel order is [R, Geven, Godd, B], where Geven is the green
channel for the even rows of a Bayer pattern, and Godd is the odd rows.
The shading map is stored in a fully interleaved format, and its size
is provided in the camera static metadata by <a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a>.
The shading map should have on the order of 30-40 rows and columns,
and must be smaller than 64x64.
As an example, given a very small map defined as:
<pre><code><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a> = [ 4, 3 ]
<a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a> =
[ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2,
 1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3,
 1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0,
 1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2,
 1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2,
 1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ]
</code></pre>
The low-resolution scaling map images for each channel are
(displayed using nearest-neighbor interpolation):
<img alt="Red lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png"/>
<img alt="Green (even rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png"/>
<img alt="Green (odd rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png"/>
<img alt="Blue lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png"/>
As a visualization only, inverting the full-color map to recover an
image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:
<img alt="Image of a uniform white wall (inverse shading map)" src="images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png"/>
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The lens shading map calculation may depend on exposure and white balance statistics.
When AE and AWB are in AUTO modes
(<a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>!=</code> OFF and <a href="#controls_android.control.awbMode">android.control.awbMode</a> <code>!=</code> OFF), the HAL
may have all the information it need to generate most accurate lens shading map. When
AE or AWB are in manual mode
(<a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>==</code> OFF or <a href="#controls_android.control.awbMode">android.control.awbMode</a> <code>==</code> OFF), the shading map
may be adversely impacted by manual exposure or white balance parameters. To avoid
generating unreliable shading map data, the HAL may choose to lock the shading map with
the latest known good map generated when the AE and AWB are in AUTO modes.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.predictedColorGains">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.statistics.predictedColorGains
 </td>
 <td class="entry_type">
 float
 x

4
 
 [hidden]

[deprecated]

<div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>

</td>

<td class="entry_description">
 The best-fit color channel gains calculated
by the camera device's statistics units for the current output frame.
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This may be different than the gains used for this frame,
since statistics processing on data from a new frame
typically completes after the transform has already been
applied to that frame.
The 4 channel gains are defined in Bayer domain,
see <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> for details.
This value should always be calculated by the auto-white balance (AWB) block,
regardless of the android.control.* current values.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.predictedColorTransform">
 <td class="entry_name
 entry_name_deprecated
 " rowspan="3">
 android.statistics.predictedColorTransform
 </td>
 <td class="entry_type">
 rational
 x

3 x 3
 
 [hidden]

[deprecated]

<div class="entry_type_notes">3x3 rational matrix in row-major order</div>

</td>

<td class="entry_description">
 The best-fit color transform matrix estimate
calculated by the camera device's statistics units for the current
output frame.
 </td>

<td class="entry_range">
 Deprecated. Do not use.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The camera device will provide the estimate from its
statistics unit on the white balance transforms to use
for the next frame. These are the values the camera device believes
are the best fit for the current output frame. This may
be different than the transform used for this frame, since
statistics processing on data from a new frame typically
completes after the transform has already been applied to
that frame.
These estimates must be provided for all frames, even if
capture settings and color transforms are set by the application.
This value should always be calculated by the auto-white balance (AWB) block,
regardless of the android.control.* current values.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.sceneFlicker">
 <td class="entry_name
 " rowspan="3">
 android.statistics.sceneFlicker
 </td>
 <td class="entry_type">
 byte

[public]

[full]

<ul class="entry_type_enum">
 <li>
 NONE
 The camera device does not detect any flickering illumination
in the current scene.
 </li>
 <li>
 50HZ
 The camera device detects illumination flickering at 50Hz
in the current scene.
 </li>
 <li>
 60HZ
 The camera device detects illumination flickering at 60Hz
in the current scene.
 </li>
 </ul>

</td>

<td class="entry_description">
 The camera device estimated scene illumination lighting
frequency.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Many light sources, such as most fluorescent lights, flicker at a rate
that depends on the local utility power standards. This flicker must be
accounted for by auto-exposure routines to avoid artifacts in captured images.
The camera device uses this entry to tell the application what the scene
illuminant frequency is.
When manual exposure control is enabled
(<code><a href="#controls_android.control.aeMode">android.control.aeMode</a> == OFF</code> or <code><a href="#controls_android.control.mode">android.control.mode</a> ==
OFF</code>), the <a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> doesn't perform
antibanding, and the application can ensure it selects
exposure times that do not cause banding issues by looking
into this metadata field. See
<a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> for more details.
Reports NONE if there doesn't appear to be flickering illumination.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.hotPixelMapMode">
 <td class="entry_name
 " rowspan="3">
 android.statistics.hotPixelMapMode
 </td>
 <td class="entry_type">
 byte

[public as boolean]

</td>

<td class="entry_description">
 Operating mode for hot pixel map generation.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.hotPixelMap">
 <td class="entry_name
 " rowspan="5">
 android.statistics.hotPixelMap
 </td>
 <td class="entry_type">
 int32
 x

2 x n
 
 [public as point]

<div class="entry_type_notes">list of coordinates based on android.sensor.pixelArraySize</div>

</td>

<td class="entry_description">
 List of <code>(x, y)</code> coordinates of hot/defective pixels on the sensor.
 </td>

<td class="entry_range">
 n <= number of pixels on the sensor.
The <code>(x, y)</code> coordinates must be bounded by
<a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 A coordinate <code>(x, y)</code> must lie between <code>(0, 0)</code>, and
<code>(width - 1, height - 1)</code> (inclusive), which are the top-left and
bottom-right of the pixel array, respectively. The width and
height dimensions are given in <a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>.
This may include hot pixels that lie outside of the active array
bounds given by <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 A hotpixel map contains the coordinates of pixels on the camera
sensor that do report valid values (usually due to defects in
the camera sensor). This includes pixels that are stuck at certain
values, or have a response that does not accuractly encode the
incoming light from the scene.
To avoid performance issues, there should be significantly fewer hot
pixels than actual pixels on the camera sensor.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.statistics.lensShadingMapMode">
 <td class="entry_name
 " rowspan="3">
 android.statistics.lensShadingMapMode
 </td>
 <td class="entry_type">
 byte

[public]

[full]

</td>

<td class="entry_description">
 Whether the camera device will output the lens
shading map in output result metadata.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When set to ON,
<a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a> will be provided in
the output result metadata.
ON is always supported on devices with the RAW capability.
 </td>
 </tr>

</tbody>

<tr><td colspan="6" id="section_tonemap" class="section">tonemap</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.tonemap.curveBlue">
 <td class="entry_name
 " rowspan="3">
 android.tonemap.curveBlue
 </td>
 <td class="entry_type">
 float
 x

n x 2
 
 [hidden]

[full]

<div class="entry_type_notes">1D array of float pairs (P_IN, P_OUT). The maximum number of pairs is specified by android.tonemap.maxCurvePoints.</div>

</td>

<td class="entry_description">
 Tonemapping / contrast / gamma curve for the blue
channel, to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is
CONTRAST_CURVE.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.tonemap.curveGreen">
 <td class="entry_name
 " rowspan="3">
 android.tonemap.curveGreen
 </td>
 <td class="entry_type">
 float
 x

n x 2
 
 [hidden]

[full]

</td>

<td class="entry_description">
 Tonemapping / contrast / gamma curve for the green
channel, to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is
CONTRAST_CURVE.
 </td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.tonemap.curveRed">
 <td class="entry_name
 " rowspan="5">
 android.tonemap.curveRed
 </td>
 <td class="entry_type">
 float
 x

n x 2
 
 [hidden]

[full]

</td>

<td class="entry_description">
 Tonemapping / contrast / gamma curve for the red
channel, to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is
CONTRAST_CURVE.
 </td>

<td class="entry_range">
 0-1 on both input and output coordinates, normalized
as a floating-point value such that 0 == black and 1 == white.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Each channel's curve is defined by an array of control points:
<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> =
 [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ]
2 <= N <= <a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></code></pre>
These are sorted in order of increasing <code>Pin</code>; it is
required that input values 0.0 and 1.0 are included in the list to
define a complete mapping. For input values between control points,
the camera device must linearly interpolate between the control
points.
Each curve can have an independent number of points, and the number
of points can be less than max (that is, the request doesn't have to
always provide a curve with number of points equivalent to
<a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a>).
A few examples, and their corresponding graphical mappings; these
only specify the red channel and the precision is limited to 4
digits, for conciseness.
Linear mapping:
<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> = [ 0, 0, 1.0, 1.0 ]
</code></pre>
<img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/>
Invert mapping:
<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> = [ 0, 1.0, 1.0, 0 ]
</code></pre>
<img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/>
Gamma 1/2.2 mapping, with 16 control points:
<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> = [
 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812,
 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072,
 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685,
 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ]
</code></pre>
<img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/>
Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:
<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> = [
 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845,
 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130,
 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721,
 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ]
</code></pre>
<img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/>
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For good quality of mapping, at least 128 control points are
preferred.
A typical use case of this would be a gamma-1/2.2 curve, with as many
control points used as are available.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.tonemap.curve">
 <td class="entry_name
 " rowspan="5">
 android.tonemap.curve
 </td>
 <td class="entry_type">
 float

[public as tonemapCurve]

[synthetic]

[full]

</td>

<td class="entry_description">
 Tonemapping / contrast / gamma curve to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a>
is CONTRAST_CURVE.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The tonemapCurve consist of three curves for each of red, green, and blue
channels respectively. The following example uses the red channel as an
example. The same logic applies to green and blue channel.
Each channel's curve is defined by an array of control points:
<pre><code>curveRed =
 [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ]
2 <= N <= <a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></code></pre>
These are sorted in order of increasing <code>Pin</code>; it is always
guaranteed that input values 0.0 and 1.0 are included in the list to
define a complete mapping. For input values between control points,
the camera device must linearly interpolate between the control
points.
Each curve can have an independent number of points, and the number
of points can be less than max (that is, the request doesn't have to
always provide a curve with number of points equivalent to
<a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a>).
A few examples, and their corresponding graphical mappings; these
only specify the red channel and the precision is limited to 4
digits, for conciseness.
Linear mapping:
<pre><code>curveRed = [ (0, 0), (1.0, 1.0) ]
</code></pre>
<img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/>
Invert mapping:
<pre><code>curveRed = [ (0, 1.0), (1.0, 0) ]
</code></pre>
<img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/>
Gamma 1/2.2 mapping, with 16 control points:
<pre><code>curveRed = [
 (0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812),
 (0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072),
 (0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685),
 (0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ]
</code></pre>
<img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/>
Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:
<pre><code>curveRed = [
 (0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845),
 (0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130),
 (0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721),
 (0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ]
</code></pre>
<img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/>
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="controls_android.tonemap.mode">
 <td class="entry_name
 " rowspan="3">
 android.tonemap.mode
 </td>
 <td class="entry_type">
 byte

[public]

[full]

<ul class="entry_type_enum">
 <li>
 CONTRAST_CURVE
 Use the tone mapping curve specified in
the <a href="#controls_android.tonemap.curve">android.tonemap.curve</a>* entries.
All color enhancement and tonemapping must be disabled, except
for applying the tonemapping curve specified by
<a href="#controls_android.tonemap.curve">android.tonemap.curve</a>.
Must not slow down frame rate relative to raw
sensor output.
 </li>
 <li>
 FAST
 Advanced gamma mapping and color enhancement may be applied, without
reducing frame rate compared to raw sensor output.
 </li>
 <li>
 HIGH_QUALITY
 High-quality gamma mapping and color enhancement will be applied, at
the cost of reduced frame rate compared to raw sensor output.
 </li>
 </ul>

</td>

<td class="entry_description">
 High-level global contrast/gamma/tonemapping control.
 </td>

<td class="entry_range">
 <a href="#static_android.tonemap.availableToneMapModes">android.tonemap.availableToneMapModes</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When switching to an application-defined contrast curve by setting
<a href="#controls_android.tonemap.mode">android.tonemap.mode</a> to CONTRAST_CURVE, the curve is defined
per-channel with a set of <code>(in, out)</code> points that specify the
mapping from input high-bit-depth pixel value to the output
low-bit-depth value. Since the actual pixel ranges of both input
and output may change depending on the camera pipeline, the values
are specified by normalized floating-point numbers.
More-complex color mapping operations such as 3D color look-up
tables, selective chroma enhancement, or other non-linear color
transforms will be disabled when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is
CONTRAST_CURVE.
When using either FAST or HIGH_QUALITY, the camera device will
emit its own tonemap curve in <a href="#controls_android.tonemap.curve">android.tonemap.curve</a>.
These values are always available, and as close as possible to the
actually used nonlinear/nonglobal transforms.
If a request is sent with CONTRAST_CURVE with the camera device's
provided curve in FAST or HIGH_QUALITY, the image's tonemap will be
roughly the same.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.tonemap.maxCurvePoints">
 <td class="entry_name
 " rowspan="5">
 android.tonemap.maxCurvePoints
 </td>
 <td class="entry_type">
 int32

[public]

[full]

</td>

<td class="entry_description">
 Maximum number of supported points in the
tonemap curve that can be used for <a href="#controls_android.tonemap.curve">android.tonemap.curve</a>.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If the actual number of points provided by the application (in <a href="#controls_android.tonemap.curve">android.tonemap.curve</a>*) is
less than this maximum, the camera device will resample the curve to its internal
representation, using linear interpolation.
The output curves in the result metadata may have a different number
of points than the input curves, and will represent the actual
hardware curves used as closely as possible when linearly interpolated.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="static_android.tonemap.availableToneMapModes">
 <td class="entry_name
 " rowspan="3">
 android.tonemap.availableToneMapModes
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [public as enumList]

[full]

<div class="entry_type_notes">list of enums</div>

</td>

<td class="entry_description">
 List of tonemapping modes for <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> that are supported by this camera
device.
 </td>

<td class="entry_range">
 Any value listed in <a href="#controls_android.tonemap.mode">android.tonemap.mode</a>
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Camera devices that support the MANUAL_POST_PROCESSING capability will always list
CONTRAST_CURVE and FAST. This includes all FULL level devices.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.tonemap.curveBlue">
 <td class="entry_name
 " rowspan="3">
 android.tonemap.curveBlue
 </td>
 <td class="entry_type">
 float
 x

n x 2
 
 [hidden]

[full]

</td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.tonemap.curveGreen">
 <td class="entry_name
 " rowspan="3">
 android.tonemap.curveGreen
 </td>
 <td class="entry_type">
 float
 x

n x 2
 
 [hidden]

[full]

</td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.tonemap.curveRed">
 <td class="entry_name
 " rowspan="5">
 android.tonemap.curveRed
 </td>
 <td class="entry_type">
 float
 x

n x 2
 
 [hidden]

[full]

</td>

<td class="entry_range">
 0-1 on both input and output coordinates, normalized
as a floating-point value such that 0 == black and 1 == white.
 </td>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 For good quality of mapping, at least 128 control points are
preferred.
A typical use case of this would be a gamma-1/2.2 curve, with as many
control points used as are available.
 </td>
 </tr>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.tonemap.curve">
 <td class="entry_name
 " rowspan="5">
 android.tonemap.curve
 </td>
 <td class="entry_type">
 float

[public as tonemapCurve]

[synthetic]

[full]

</td>

<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
 
 
 
 <tr class="entry" id="dynamic_android.tonemap.mode">
 <td class="entry_name
 " rowspan="3">
 android.tonemap.mode
 </td>
 <td class="entry_type">
 byte

[public]

[full]

</td>

<td class="entry_description">
 High-level global contrast/gamma/tonemapping control.
 </td>

<td class="entry_range">
 <a href="#static_android.tonemap.availableToneMapModes">android.tonemap.availableToneMapModes</a>
 </td>

</tbody>

<tr><td colspan="6" id="section_led" class="section">led</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.led.transmit">
 <td class="entry_name
 " rowspan="1">
 android.led.transmit
 </td>
 <td class="entry_type">
 byte

[hidden as boolean]

</td>

<td class="entry_description">
 This LED is nominally used to indicate to the user
that the camera is powered on and may be streaming images back to the
Application Processor. In certain rare circumstances, the OS may
disable this when video is processed locally and not transmitted to
any untrusted applications.
In particular, the LED must always be on when the data could be
transmitted off the device. The LED should always be on whenever
data is stored locally on the device.
The LED may be off if a trusted application is using the data that
doesn't violate the above rules.
 </td>

</tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.led.transmit">
 <td class="entry_name
 " rowspan="1">
 android.led.transmit
 </td>
 <td class="entry_type">
 byte

[hidden as boolean]

</td>

</tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.led.availableLeds">
 <td class="entry_name
 " rowspan="1">
 android.led.availableLeds
 </td>
 <td class="entry_type">
 byte
 x

n
 
 [hidden]

<ul class="entry_type_enum">
 <li>
 TRANSMIT
 <a href="#controls_android.led.transmit">android.led.transmit</a> control is used.
 </li>
 </ul>

</td>

<td class="entry_description">
 A list of camera LEDs that are available on this system.
 </td>

</tr>

</tbody>

<tr><td colspan="6" id="section_info" class="section">info</td></tr>

<tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.info.supportedHardwareLevel">
 <td class="entry_name
 " rowspan="5">
 android.info.supportedHardwareLevel
 </td>
 <td class="entry_type">
 byte

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 LIMITED
 This camera device has only limited capabilities.
 </li>
 <li>
 FULL
 This camera device is capable of supporting advanced imaging applications.
 </li>
 <li>
 LEGACY
 This camera device is running in backward compatibility mode.
 </li>
 </ul>

</td>

<td class="entry_description">
 Generally classifies the overall set of the camera device functionality.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Camera devices will come in three flavors: LEGACY, LIMITED and FULL.
A FULL device will support below capabilities:
<ul>
<li>30fps operation at maximum resolution (== sensor resolution) is preferred, more than
 20fps is required, for at least uncompressed YUV
 output. (<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains BURST_CAPTURE)</li>
<li>Per frame control (<a href="#static_android.sync.maxLatency">android.sync.maxLatency</a> <code>==</code> PER_FRAME_CONTROL)</li>
<li>Manual sensor control (<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains MANUAL_SENSOR)</li>
<li>Manual post-processing control (<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains
 MANUAL_POST_PROCESSING)</li>
<li>Arbitrary cropping region (<a href="#static_android.scaler.croppingType">android.scaler.croppingType</a> <code>==</code> FREEFORM)</li>
<li>At least 3 processed (but not stalling) format output streams
 (<a href="#static_android.request.maxNumOutputProc">android.request.maxNumOutputProc</a> <code>>=</code> 3)</li>
<li>The required stream configuration defined in <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a></li>
<li>The required exposure time range defined in <a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a></li>
<li>The required maxFrameDuration defined in <a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a></li>
</ul>
A LIMITED device may have some or none of the above characteristics.
To find out more refer to <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>.
Some features are not part of any particular hardware level or capability and must be
queried separately. These include:
<ul>
<li>Calibrated timestamps (<a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> <code>==</code> REALTIME)</li>
<li>Precision lens control (<a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a> <code>==</code> CALIBRATED)</li>
<li>Face detection (<a href="#static_android.statistics.info.availableFaceDetectModes">android.statistics.info.availableFaceDetectModes</a>)</li>
<li>Optical or electrical image stabilization
 (<a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a>,
 <a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a>)</li>
</ul>
A LEGACY device does not support per-frame control, manual sensor control, manual
post-processing, arbitrary cropping regions, and has relaxed performance constraints.
Each higher level supports everything the lower level supports
in this order: FULL <code>></code> LIMITED <code>></code> LEGACY.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 The camera 3 HAL device can implement one of two possible
operational modes; limited and full. Full support is
expected from new higher-end devices. Limited mode has
hardware requirements roughly in line with those for a
camera HAL device v1 implementation, and is expected from
older or inexpensive devices. Full is a strict superset of
limited, and they share the same essential operational flow.
For full details refer to "S3. Operational Modes" in camera3.h
Camera HAL3+ must not implement LEGACY mode. It is there
for backwards compatibility in the <code>android.hardware.camera2</code>
user-facing API only.
 </td>
 </tr>

</tbody>

<tr><td colspan="6" id="section_blackLevel" class="section">blackLevel</td></tr>

<tr><td colspan="6" class="kind">controls</td></tr>

<tbody>

<tr class="entry" id="controls_android.blackLevel.lock">
 <td class="entry_name
 " rowspan="5">
 android.blackLevel.lock
 </td>
 <td class="entry_type">
 byte

[public as boolean]

[full]

</td>

<td class="entry_description">
 Whether black-level compensation is locked
to its current values, or is free to vary.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When set to <code>true</code> (ON), the values used for black-level
compensation will not change until the lock is set to
<code>false</code> (OFF).
Since changes to certain capture parameters (such as
exposure time) may require resetting of black level
compensation, the camera device must report whether setting
the black level lock was successful in the output result
metadata.
For example, if a sequence of requests is as follows:
<ul>
<li>Request 1: Exposure = 10ms, Black level lock = OFF</li>
<li>Request 2: Exposure = 10ms, Black level lock = ON</li>
<li>Request 3: Exposure = 10ms, Black level lock = ON</li>
<li>Request 4: Exposure = 20ms, Black level lock = ON</li>
<li>Request 5: Exposure = 20ms, Black level lock = ON</li>
<li>Request 6: Exposure = 20ms, Black level lock = ON</li>
</ul>
And the exposure change in Request 4 requires the camera
device to reset the black level offsets, then the output
result metadata is expected to be:
<ul>
<li>Result 1: Exposure = 10ms, Black level lock = OFF</li>
<li>Result 2: Exposure = 10ms, Black level lock = ON</li>
<li>Result 3: Exposure = 10ms, Black level lock = ON</li>
<li>Result 4: Exposure = 20ms, Black level lock = OFF</li>
<li>Result 5: Exposure = 20ms, Black level lock = ON</li>
<li>Result 6: Exposure = 20ms, Black level lock = ON</li>
</ul>
This indicates to the application that on frame 4, black
levels were reset due to exposure value changes, and pixel
values may not be consistent across captures.
The camera device will maintain the lock to the extent
possible, only overriding the lock to OFF when changes to
other request parameters require a black level recalculation
or reset.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If for some reason black level locking is no longer possible
(for example, the analog gain has changed, which forces
black level offsets to be recalculated), then the HAL must
override this request (and it must report 'OFF' when this
does happen) until the next capture for which locking is
possible again.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.blackLevel.lock">
 <td class="entry_name
 " rowspan="5">
 android.blackLevel.lock
 </td>
 <td class="entry_type">
 byte

[public as boolean]

[full]

</td>

<td class="entry_description">
 Whether black-level compensation is locked
to its current values, or is free to vary.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Whether the black level offset was locked for this frame. Should be
ON if <a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a> was ON in the capture request, unless
a change in other capture settings forced the camera device to
perform a black level reset.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 If for some reason black level locking is no longer possible
(for example, the analog gain has changed, which forces
black level offsets to be recalculated), then the HAL must
override this request (and it must report 'OFF' when this
does happen) until the next capture for which locking is
possible again.
 </td>
 </tr>

</tbody>

<tr><td colspan="6" id="section_sync" class="section">sync</td></tr>

<tr><td colspan="6" class="kind">dynamic</td></tr>

<tbody>

<tr class="entry" id="dynamic_android.sync.frameNumber">
 <td class="entry_name
 " rowspan="5">
 android.sync.frameNumber
 </td>
 <td class="entry_type">
 int64

[hidden]

[legacy]

<ul class="entry_type_enum">
 <li>
 CONVERGING
 -1
 The current result is not yet fully synchronized to any request.
Synchronization is in progress, and reading metadata from this
result may include a mix of data that have taken effect since the
last synchronization time.
In some future result, within <a href="#static_android.sync.maxLatency">android.sync.maxLatency</a> frames,
this value will update to the actual frame number frame number
the result is guaranteed to be synchronized to (as long as the
request settings remain constant).
 </li>
 <li>
 UNKNOWN
 -2
 The current result's synchronization status is unknown.
The result may have already converged, or it may be in
progress. Reading from this result may include some mix
of settings from past requests.
After a settings change, the new settings will eventually all
take effect for the output buffers and results. However, this
value will not change when that happens. Altering settings
rapidly may provide outcomes using mixes of settings from recent
requests.
This value is intended primarily for backwards compatibility with
the older camera implementations (for android.hardware.Camera).
 </li>
 </ul>

</td>

<td class="entry_description">
 The frame number corresponding to the last request
with which the output result (metadata + buffers) has been fully
synchronized.
 </td>

<td class="entry_range">
 Either a non-negative value corresponding to a
<code>frame_number</code>, or one of the two enums (CONVERGING / UNKNOWN).
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 When a request is submitted to the camera device, there is usually a
delay of several frames before the controls get applied. A camera
device may either choose to account for this delay by implementing a
pipeline and carefully submit well-timed atomic control updates, or
it may start streaming control changes that span over several frame
boundaries.
In the latter case, whenever a request's settings change relative to
the previous submitted request, the full set of changes may take
multiple frame durations to fully take effect. Some settings may
take effect sooner (in less frame durations) than others.
While a set of control changes are being propagated, this value
will be CONVERGING.
Once it is fully known that a set of control changes have been
finished propagating, and the resulting updated control settings
have been read back by the camera device, this value will be set
to a non-negative frame number (corresponding to the request to
which the results have synchronized to).
Older camera device implementations may not have a way to detect
when all camera controls have been applied, and will always set this
value to UNKNOWN.
FULL capability devices will always have this value set to the
frame number of the request corresponding to this result.
Further details:
<ul>
<li>Whenever a request differs from the last request, any future
results not yet returned may have this value set to CONVERGING (this
could include any in-progress captures not yet returned by the camera
device, for more details see pipeline considerations below).</li>
<li>Submitting a series of multiple requests that differ from the
previous request (e.g. r1, r2, r3 s.t. r1 != r2 != r3)
moves the new synchronization frame to the last non-repeating
request (using the smallest frame number from the contiguous list of
repeating requests).</li>
<li>Submitting the same request repeatedly will not change this value
to CONVERGING, if it was already a non-negative value.</li>
<li>When this value changes to non-negative, that means that all of the
metadata controls from the request have been applied, all of the
metadata controls from the camera device have been read to the
updated values (into the result), and all of the graphics buffers
corresponding to this result are also synchronized to the request.</li>
</ul>
Pipeline considerations:
Submitting a request with updated controls relative to the previously
submitted requests may also invalidate the synchronization state
of all the results corresponding to currently in-flight requests.
In other words, results for this current request and up to
<a href="#static_android.request.pipelineMaxDepth">android.request.pipelineMaxDepth</a> prior requests may have their
<a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> change to CONVERGING.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Using UNKNOWN here is illegal unless <a href="#static_android.sync.maxLatency">android.sync.maxLatency</a>
is also UNKNOWN.
FULL capability devices should simply set this value to the
<code>frame_number</code> of the request this result corresponds to.
 </td>
 </tr>

</tbody>
 <tr><td colspan="6" class="kind">static</td></tr>

<tbody>

<tr class="entry" id="static_android.sync.maxLatency">
 <td class="entry_name
 " rowspan="5">
 android.sync.maxLatency
 </td>
 <td class="entry_type">
 int32

[public]

[legacy]

<ul class="entry_type_enum">
 <li>
 PER_FRAME_CONTROL
 0
 Every frame has the requests immediately applied.
Furthermore for all results,
<code><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == CaptureResult#getFrameNumber()</code>
Changing controls over multiple requests one after another will
produce results that have those controls applied atomically
each frame.
All FULL capability devices will have this as their maxLatency.
 </li>
 <li>
 UNKNOWN
 -1
 Each new frame has some subset (potentially the entire set)
of the past requests applied to the camera settings.
By submitting a series of identical requests, the camera device
will eventually have the camera settings applied, but it is
unknown when that exact point will be.
All LEGACY capability devices will have this as their maxLatency.
 </li>
 </ul>

</td>

<td class="entry_description">
 The maximum number of frames that can occur after a request
(different than the previous) has been submitted, and before the
result's state becomes synchronized (by setting
<a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> to a non-negative value).
 </td>

<td class="entry_units">
 Frame counts
 </td>

<td class="entry_range">
 A positive value, PER_FRAME_CONTROL, or UNKNOWN.
 </td>

</tr>
 <tr class="entries_header">
 <th class="th_details" colspan="5">Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 This defines the maximum distance (in number of metadata results),
between <a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> and the equivalent
frame number for that result.
In other words this acts as an upper boundary for how many frames
must occur before the camera device knows for a fact that the new
submitted camera settings have been applied in outgoing frames.
For example if the distance was 2,
<pre><code>initial request = X (repeating)
request1 = X
request2 = Y
request3 = Y
request4 = Y

where requestN has frameNumber N, and the first of the repeating
initial request's has frameNumber F (and F < 1).

initial result = X' + { <a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == F }
result1 = X' + { <a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == F }
result2 = X' + { <a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == CONVERGING }
result3 = X' + { <a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == CONVERGING }
result4 = X' + { <a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == 2 }

where resultN has frameNumber N.
</code></pre>
Since <code>result4</code> has a <code>frameNumber == 4</code> and
<code><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == 2</code>, the distance is clearly
<code>4 - 2 = 2</code>.
 </td>
 </tr>

<tr class="entries_header">
 <th class="th_details" colspan="5">HAL Implementation Details</th>
 </tr>
 <tr class="entry_cont">
 <td class="entry_details" colspan="5">
 Use <code>frame_count</code> from camera3_request_t instead of
<a href="#controls_android.request.frameCount">android.request.frameCount</a> or <code>CaptureResult#getFrameNumber()</code>.
LIMITED devices are strongly encouraged to use a non-negative
value. If UNKNOWN is used here then app developers do not have a way
to know when sensor settings have been applied.
 </td>
 </tr>

</tbody>

</table>

<div class="tags" id="tag_index">
 <h2>Tags</h2>
 <ul>
 <li id="tag_BC">BC - 
 Needed for backwards compatibility with old Java API
 
 <ul class="tags_entries">
 <li><a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> (controls)</li>
 <li><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> (controls)</li>
 <li><a href="#controls_android.control.aeLock">android.control.aeLock</a> (controls)</li>
 <li><a href="#controls_android.control.aeMode">android.control.aeMode</a> (controls)</li>
 <li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a> (controls)</li>
 <li><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> (controls)</li>
 <li><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> (controls)</li>
 <li><a href="#controls_android.control.afMode">android.control.afMode</a> (controls)</li>
 <li><a href="#controls_android.control.afRegions">android.control.afRegions</a> (controls)</li>
 <li><a href="#controls_android.control.afTrigger">android.control.afTrigger</a> (controls)</li>
 <li><a href="#controls_android.control.awbLock">android.control.awbLock</a> (controls)</li>
 <li><a href="#controls_android.control.awbMode">android.control.awbMode</a> (controls)</li>
 <li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a> (controls)</li>
 <li><a href="#controls_android.control.captureIntent">android.control.captureIntent</a> (controls)</li>
 <li><a href="#controls_android.control.effectMode">android.control.effectMode</a> (controls)</li>
 <li><a href="#controls_android.control.mode">android.control.mode</a> (controls)</li>
 <li><a href="#controls_android.control.sceneMode">android.control.sceneMode</a> (controls)</li>
 <li><a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a> (controls)</li>
 <li><a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a> (static)</li>
 <li><a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a> (static)</li>
 <li><a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a> (static)</li>
 <li><a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a> (static)</li>
 <li><a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a> (static)</li>
 <li><a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a> (static)</li>
 <li><a href="#static_android.control.availableEffects">android.control.availableEffects</a> (static)</li>
 <li><a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a> (static)</li>
 <li><a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a> (static)</li>
 <li><a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a> (static)</li>
 <li><a href="#static_android.control.maxRegions">android.control.maxRegions</a> (static)</li>
 <li><a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a> (static)</li>
 <li><a href="#controls_android.flash.mode">android.flash.mode</a> (controls)</li>
 <li><a href="#static_android.flash.info.available">android.flash.info.available</a> (static)</li>
 <li><a href="#controls_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a> (controls)</li>
 <li><a href="#controls_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a> (controls)</li>
 <li><a href="#controls_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a> (controls)</li>
 <li><a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a> (controls)</li>
 <li><a href="#controls_android.jpeg.quality">android.jpeg.quality</a> (controls)</li>
 <li><a href="#controls_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a> (controls)</li>
 <li><a href="#controls_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a> (controls)</li>
 <li><a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a> (static)</li>
 <li><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> (controls)</li>
 <li><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a> (static)</li>
 <li><a href="#dynamic_android.lens.focusRange">android.lens.focusRange</a> (dynamic)</li>
 <li><a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a> (static)</li>
 <li><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> (controls)</li>
 <li><a href="#static_android.scaler.availableFormats">android.scaler.availableFormats</a> (static)</li>
 <li><a href="#static_android.scaler.availableJpegMinDurations">android.scaler.availableJpegMinDurations</a> (static)</li>
 <li><a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a> (static)</li>
 <li><a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> (static)</li>
 <li><a href="#static_android.scaler.availableProcessedMinDurations">android.scaler.availableProcessedMinDurations</a> (static)</li>
 <li><a href="#static_android.scaler.availableProcessedSizes">android.scaler.availableProcessedSizes</a> (static)</li>
 <li><a href="#static_android.scaler.availableRawMinDurations">android.scaler.availableRawMinDurations</a> (static)</li>
 <li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> (static)</li>
 <li><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> (static)</li>
 <li><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> (static)</li>
 <li><a href="#static_android.sensor.orientation">android.sensor.orientation</a> (static)</li>
 <li><a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a> (dynamic)</li>
 <li><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> (controls)</li>
 <li><a href="#static_android.statistics.info.maxFaceCount">android.statistics.info.maxFaceCount</a> (static)</li>
 <li><a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a> (dynamic)</li>
 <li><a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a> (dynamic)</li>
 <li><a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a> (dynamic)</li>
 <li><a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a> (dynamic)</li>
 <li><a href="#dynamic_android.lens.focalLength">android.lens.focalLength</a> (dynamic)</li>
 <li><a href="#dynamic_android.lens.focusDistance">android.lens.focusDistance</a> (dynamic)</li>
 </ul>
 </li> 
 <li id="tag_V1">V1 - 
 New features for first camera 2 release (API1)
 
 <ul class="tags_entries">
 <li><a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a> (static)</li>
 <li><a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a> (static)</li>
 <li><a href="#controls_android.edge.mode">android.edge.mode</a> (controls)</li>
 <li><a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a> (static)</li>
 <li><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a> (controls)</li>
 <li><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a> (static)</li>
 <li><a href="#controls_android.lens.aperture">android.lens.aperture</a> (controls)</li>
 <li><a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> (controls)</li>
 <li><a href="#controls_android.lens.focalLength">android.lens.focalLength</a> (controls)</li>
 <li><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> (controls)</li>
 <li><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (controls)</li>
 <li><a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a> (static)</li>
 <li><a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a> (static)</li>
 <li><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a> (static)</li>
 <li><a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a> (static)</li>
 <li><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> (static)</li>
 <li><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a> (static)</li>
 <li><a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a> (static)</li>
 <li><a href="#dynamic_android.lens.state">android.lens.state</a> (dynamic)</li>
 <li><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a> (controls)</li>
 <li><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a> (static)</li>
 <li><a href="#controls_android.request.id">android.request.id</a> (controls)</li>
 <li><a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a> (static)</li>
 <li><a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a> (static)</li>
 <li><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a> (controls)</li>
 <li><a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> (controls)</li>
 <li><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> (controls)</li>
 <li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> (static)</li>
 <li><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a> (static)</li>
 <li><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a> (static)</li>
 <li><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> (static)</li>
 <li><a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> (static)</li>
 <li><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a> (static)</li>
 <li><a href="#dynamic_android.sensor.rollingShutterSkew">android.sensor.rollingShutterSkew</a> (dynamic)</li>
 <li><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a> (controls)</li>
 <li><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a> (static)</li>
 <li><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a> (dynamic)</li>
 <li><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> (dynamic)</li>
 <li><a href="#static_android.sync.maxLatency">android.sync.maxLatency</a> (static)</li>
 <li><a href="#dynamic_android.edge.mode">android.edge.mode</a> (dynamic)</li>
 <li><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a> (dynamic)</li>
 <li><a href="#dynamic_android.lens.aperture">android.lens.aperture</a> (dynamic)</li>
 <li><a href="#dynamic_android.lens.filterDensity">android.lens.filterDensity</a> (dynamic)</li>
 <li><a href="#dynamic_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (dynamic)</li>
 <li><a href="#dynamic_android.noiseReduction.mode">android.noiseReduction.mode</a> (dynamic)</li>
 </ul>
 </li> 
 <li id="tag_RAW">RAW - 
 Needed for useful RAW image processing and DNG file support
 
 <ul class="tags_entries">
 <li><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a> (controls)</li>
 <li><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a> (static)</li>
 <li><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> (static)</li>
 <li><a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a> (static)</li>
 <li><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> (static)</li>
 <li><a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a> (static)</li>
 <li><a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a> (static)</li>
 <li><a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a> (static)</li>
 <li><a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a> (static)</li>
 <li><a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a> (static)</li>
 <li><a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a> (static)</li>
 <li><a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a> (static)</li>
 <li><a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a> (static)</li>
 <li><a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a> (static)</li>
 <li><a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a> (static)</li>
 <li><a href="#static_android.sensor.profileHueSatMapDimensions">android.sensor.profileHueSatMapDimensions</a> (static)</li>
 <li><a href="#dynamic_android.sensor.neutralColorPoint">android.sensor.neutralColorPoint</a> (dynamic)</li>
 <li><a href="#dynamic_android.sensor.noiseProfile">android.sensor.noiseProfile</a> (dynamic)</li>
 <li><a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a> (dynamic)</li>
 <li><a href="#dynamic_android.sensor.profileToneCurve">android.sensor.profileToneCurve</a> (dynamic)</li>
 <li><a href="#dynamic_android.sensor.greenSplit">android.sensor.greenSplit</a> (dynamic)</li>
 <li><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a> (controls)</li>
 <li><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a> (static)</li>
 <li><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a> (dynamic)</li>
 <li><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> (controls)</li>
 <li><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a> (dynamic)</li>
 </ul>
 </li> 
 <li id="tag_HAL2">HAL2 - 
 Entry is only used by camera device HAL 2.x
 
 <ul class="tags_entries">
 <li><a href="#controls_android.request.inputStreams">android.request.inputStreams</a> (controls)</li>
 <li><a href="#controls_android.request.outputStreams">android.request.outputStreams</a> (controls)</li>
 <li><a href="#controls_android.request.type">android.request.type</a> (controls)</li>
 <li><a href="#static_android.request.maxNumReprocessStreams">android.request.maxNumReprocessStreams</a> (static)</li>
 <li><a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a> (controls)</li>
 </ul>
 </li> 
 <li id="tag_FULL">FULL - 
 Entry is required for full hardware level devices, and optional for other hardware levels
 
 <ul class="tags_entries">
 <li><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a> (static)</li>
 </ul>
 </li> 
 <li id="tag_FUTURE">FUTURE - 
 Entry is under-specified and is not required for now. This is for book-keeping purpose,
 do not implement or use it, it may be revised for future.
 
 <ul class="tags_entries">
 <li><a href="#controls_android.demosaic.mode">android.demosaic.mode</a> (controls)</li>
 <li><a href="#controls_android.edge.strength">android.edge.strength</a> (controls)</li>
 <li><a href="#controls_android.flash.firingPower">android.flash.firingPower</a> (controls)</li>
 <li><a href="#controls_android.flash.firingTime">android.flash.firingTime</a> (controls)</li>
 <li><a href="#static_android.flash.info.chargeDuration">android.flash.info.chargeDuration</a> (static)</li>
 <li><a href="#static_android.flash.colorTemperature">android.flash.colorTemperature</a> (static)</li>
 <li><a href="#static_android.flash.maxEnergy">android.flash.maxEnergy</a> (static)</li>
 <li><a href="#dynamic_android.jpeg.size">android.jpeg.size</a> (dynamic)</li>
 <li><a href="#static_android.lens.opticalAxisAngle">android.lens.opticalAxisAngle</a> (static)</li>
 <li><a href="#static_android.lens.position">android.lens.position</a> (static)</li>
 <li><a href="#controls_android.noiseReduction.strength">android.noiseReduction.strength</a> (controls)</li>
 <li><a href="#controls_android.request.metadataMode">android.request.metadataMode</a> (controls)</li>
 <li><a href="#static_android.sensor.baseGainFactor">android.sensor.baseGainFactor</a> (static)</li>
 <li><a href="#dynamic_android.sensor.temperature">android.sensor.temperature</a> (dynamic)</li>
 <li><a href="#controls_android.shading.strength">android.shading.strength</a> (controls)</li>
 <li><a href="#controls_android.statistics.histogramMode">android.statistics.histogramMode</a> (controls)</li>
 <li><a href="#controls_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a> (controls)</li>
 <li><a href="#static_android.statistics.info.histogramBucketCount">android.statistics.info.histogramBucketCount</a> (static)</li>
 <li><a href="#static_android.statistics.info.maxHistogramCount">android.statistics.info.maxHistogramCount</a> (static)</li>
 <li><a href="#static_android.statistics.info.maxSharpnessMapValue">android.statistics.info.maxSharpnessMapValue</a> (static)</li>
 <li><a href="#static_android.statistics.info.sharpnessMapSize">android.statistics.info.sharpnessMapSize</a> (static)</li>
 <li><a href="#dynamic_android.statistics.histogram">android.statistics.histogram</a> (dynamic)</li>
 <li><a href="#dynamic_android.statistics.sharpnessMap">android.statistics.sharpnessMap</a> (dynamic)</li>
 </ul>
 </li> 
 </ul>
 </div>

[ <a href="#">top</a> ]

</body>
</html>

Html程序 | 23583行 | 941.67 KB

<!DOCTYPE html>
<html>
<!-- Copyright (C) 2012 The Android Open Source Project

     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     See the License for the specific language governing permissions and
     limitations under the License.
-->
<head>
  <!-- automatically generated from html.mako. do NOT edit directly -->
  <meta charset="utf-8" />
  <title>Android Camera HAL3.2 Properties</title>
  <style type="text/css">
     body { background-color: #f7f7f7; font-family: Roboto, sans-serif;}
     h1 { color: #333333; }
     h2 { color: #333333; }
     a:link { color: #258aaf; text-decoration: none}
     a:hover { color: #459aaf; text-decoration: underline }
     a:visited { color: #154a5f; text-decoration: none}
    .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}
    .kind { color: #eeeeee; font-size: 1.2em; font-weight: bold; padding-left: 1.5em; background-color: #aaaaaa }
    .entry { background-color: #f0f0f0 }
    .entry_cont { background-color: #f0f0f0 }
    .entries_header { background-color: #dddddd; text-align: center}

    /* toc style */
    .toc_section_header { font-size:1.3em;  }
    .toc_kind_header { font-size:1.2em;  }
    .toc_deprecated { text-decoration:line-through; }

    /* table column sizes */
    table { border-collapse:collapse; table-layout: fixed; width: 100%; word-wrap: break-word }
    td,th { border: 1px solid; border-color: #aaaaaa; padding-left: 0.5em; padding-right: 0.5em }
    .th_name { width: 20% }
    .th_units { width: 10% }
    .th_tags { width: 5% }
    .th_details { width: 25% }
    .th_type { width: 20% }
    .th_description { width: 20% }
    .th_range { width: 10% }
    td { font-size: 0.9em; }

    /* hide the first thead, we need it there only to enforce column sizes */
    .thead_dummy { visibility: hidden; }

    /* Entry flair */
    .entry_name { color: #333333; padding-left:1.0em; font-size:1.1em; font-family: monospace; vertical-align:top; }
    .entry_name_deprecated { text-decoration:line-through; }

    /* Entry type flair */
    .entry_type_name { font-size:1.1em; color: #669900; font-weight: bold;}
    .entry_type_name_enum:after { color: #669900; font-weight: bold; content:" (enum)" }
    .entry_type_visibility { font-weight: bolder; padding-left:1em}
    .entry_type_synthetic { font-weight: bolder; color: #996600; }
    .entry_type_hwlevel { font-weight: bolder; color: #000066; }
    .entry_type_deprecated { font-weight: bolder; color: #4D4D4D; }
    .entry_type_enum_name { font-family: monospace; font-weight: bolder; }
    .entry_type_enum_notes:before { content:" - " }
    .entry_type_enum_notes>p:first-child { display:inline; }
    .entry_type_enum_value:before { content:" = " }
    .entry_type_enum_value { font-family: monospace; }
    .entry ul { margin: 0 0 0 0; list-style-position: inside; padding-left: 0.5em; }
    .entry ul li { padding: 0 0 0 0; margin: 0 0 0 0;}
    .entry_range_deprecated { font-weight: bolder; }

    /* Entry tags flair */
    .entry_tags ul { list-style-type: none; }

    /* Entry details (full docs) flair */
    .entry_details_header { font-weight: bold; background-color: #dddddd;
      text-align: center; font-size: 1.1em; margin-left: 0em; margin-right: 0em; }

    /* Entry spacer flair */
    .entry_spacer { background-color: transparent; border-style: none; height: 0.5em; }

    /* TODO: generate abbr element for each tag link? */
    /* TODO for each x.y.z try to link it to the entry */

  </style>

  <style>

    {
      /* broken...
         supposedly there is a bug in chrome that it lays out tables before
         it knows its being printed, so the page-break-* styles are ignored
         */
        tr { page-break-after: always; page-break-inside: avoid; }
    }

  </style>
</head>



<body>
  <h1>Android Camera HAL3.2 Properties</h1>


  <h2>Table of Contents</h2>
  <ul class="toc">
    <li><a href="#tag_index" class="toc_section_header">Tags</a></li>
    <li>
      <span class="toc_section_header"><a href="#section_colorCorrection">colorCorrection</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a></li>
            <li
            ><a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a></li>
            <li
            ><a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a></li>
            <li
            ><a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.colorCorrection.mode">android.colorCorrection.mode</a></li>
            <li
            ><a href="#dynamic_android.colorCorrection.transform">android.colorCorrection.transform</a></li>
            <li
            ><a href="#dynamic_android.colorCorrection.gains">android.colorCorrection.gains</a></li>
            <li
            ><a href="#dynamic_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
            ><a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_control">control</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a></li>
            <li
            ><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>
            <li
            ><a href="#controls_android.control.aeLock">android.control.aeLock</a></li>
            <li
            ><a href="#controls_android.control.aeMode">android.control.aeMode</a></li>
            <li
            ><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>
            <li
            ><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>
            <li
            ><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>
            <li
            ><a href="#controls_android.control.afMode">android.control.afMode</a></li>
            <li
            ><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>
            <li
            ><a href="#controls_android.control.afTrigger">android.control.afTrigger</a></li>
            <li
            ><a href="#controls_android.control.awbLock">android.control.awbLock</a></li>
            <li
            ><a href="#controls_android.control.awbMode">android.control.awbMode</a></li>
            <li
            ><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>
            <li
            ><a href="#controls_android.control.captureIntent">android.control.captureIntent</a></li>
            <li
            ><a href="#controls_android.control.effectMode">android.control.effectMode</a></li>
            <li
            ><a href="#controls_android.control.mode">android.control.mode</a></li>
            <li
            ><a href="#controls_android.control.sceneMode">android.control.sceneMode</a></li>
            <li
            ><a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
            ><a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a></li>
            <li
            ><a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a></li>
            <li
            ><a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a></li>
            <li
            ><a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a></li>
            <li
            ><a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a></li>
            <li
            ><a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a></li>
            <li
            ><a href="#static_android.control.availableEffects">android.control.availableEffects</a></li>
            <li
            ><a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a></li>
            <li
            ><a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a></li>
            <li
            ><a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a></li>
            <li
            ><a href="#static_android.control.maxRegions">android.control.maxRegions</a></li>
            <li
            ><a href="#static_android.control.maxRegionsAe">android.control.maxRegionsAe</a></li>
            <li
            ><a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a></li>
            <li
            ><a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a></li>
            <li
            ><a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a></li>
            <li
            ><a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
                class="toc_deprecated"
            ><a href="#dynamic_android.control.aePrecaptureId">android.control.aePrecaptureId</a></li>
            <li
            ><a href="#dynamic_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a></li>
            <li
            ><a href="#dynamic_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>
            <li
            ><a href="#dynamic_android.control.aeLock">android.control.aeLock</a></li>
            <li
            ><a href="#dynamic_android.control.aeMode">android.control.aeMode</a></li>
            <li
            ><a href="#dynamic_android.control.aeRegions">android.control.aeRegions</a></li>
            <li
            ><a href="#dynamic_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>
            <li
            ><a href="#dynamic_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>
            <li
            ><a href="#dynamic_android.control.aeState">android.control.aeState</a></li>
            <li
            ><a href="#dynamic_android.control.afMode">android.control.afMode</a></li>
            <li
            ><a href="#dynamic_android.control.afRegions">android.control.afRegions</a></li>
            <li
            ><a href="#dynamic_android.control.afTrigger">android.control.afTrigger</a></li>
            <li
            ><a href="#dynamic_android.control.afState">android.control.afState</a></li>
            <li
                class="toc_deprecated"
            ><a href="#dynamic_android.control.afTriggerId">android.control.afTriggerId</a></li>
            <li
            ><a href="#dynamic_android.control.awbLock">android.control.awbLock</a></li>
            <li
            ><a href="#dynamic_android.control.awbMode">android.control.awbMode</a></li>
            <li
            ><a href="#dynamic_android.control.awbRegions">android.control.awbRegions</a></li>
            <li
            ><a href="#dynamic_android.control.captureIntent">android.control.captureIntent</a></li>
            <li
            ><a href="#dynamic_android.control.awbState">android.control.awbState</a></li>
            <li
            ><a href="#dynamic_android.control.effectMode">android.control.effectMode</a></li>
            <li
            ><a href="#dynamic_android.control.mode">android.control.mode</a></li>
            <li
            ><a href="#dynamic_android.control.sceneMode">android.control.sceneMode</a></li>
            <li
            ><a href="#dynamic_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_demosaic">demosaic</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.demosaic.mode">android.demosaic.mode</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_edge">edge</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.edge.mode">android.edge.mode</a></li>
            <li
            ><a href="#controls_android.edge.strength">android.edge.strength</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
            ><a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.edge.mode">android.edge.mode</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_flash">flash</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.flash.firingPower">android.flash.firingPower</a></li>
            <li
            ><a href="#controls_android.flash.firingTime">android.flash.firingTime</a></li>
            <li
            ><a href="#controls_android.flash.mode">android.flash.mode</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">

            <li
            ><a href="#static_android.flash.info.available">android.flash.info.available</a></li>
            <li
            ><a href="#static_android.flash.info.chargeDuration">android.flash.info.chargeDuration</a></li>

            <li
            ><a href="#static_android.flash.colorTemperature">android.flash.colorTemperature</a></li>
            <li
            ><a href="#static_android.flash.maxEnergy">android.flash.maxEnergy</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.flash.firingPower">android.flash.firingPower</a></li>
            <li
            ><a href="#dynamic_android.flash.firingTime">android.flash.firingTime</a></li>
            <li
            ><a href="#dynamic_android.flash.mode">android.flash.mode</a></li>
            <li
            ><a href="#dynamic_android.flash.state">android.flash.state</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_hotPixel">hotPixel</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
            ><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_jpeg">jpeg</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.jpeg.gpsLocation">android.jpeg.gpsLocation</a></li>
            <li
            ><a href="#controls_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a></li>
            <li
            ><a href="#controls_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a></li>
            <li
            ><a href="#controls_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a></li>
            <li
            ><a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a></li>
            <li
            ><a href="#controls_android.jpeg.quality">android.jpeg.quality</a></li>
            <li
            ><a href="#controls_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a></li>
            <li
            ><a href="#controls_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
            ><a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a></li>
            <li
            ><a href="#static_android.jpeg.maxSize">android.jpeg.maxSize</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.jpeg.gpsLocation">android.jpeg.gpsLocation</a></li>
            <li
            ><a href="#dynamic_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a></li>
            <li
            ><a href="#dynamic_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a></li>
            <li
            ><a href="#dynamic_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a></li>
            <li
            ><a href="#dynamic_android.jpeg.orientation">android.jpeg.orientation</a></li>
            <li
            ><a href="#dynamic_android.jpeg.quality">android.jpeg.quality</a></li>
            <li
            ><a href="#dynamic_android.jpeg.size">android.jpeg.size</a></li>
            <li
            ><a href="#dynamic_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a></li>
            <li
            ><a href="#dynamic_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_lens">lens</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.lens.aperture">android.lens.aperture</a></li>
            <li
            ><a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a></li>
            <li
            ><a href="#controls_android.lens.focalLength">android.lens.focalLength</a></li>
            <li
            ><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a></li>
            <li
            ><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">

            <li
            ><a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a></li>
            <li
            ><a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a></li>
            <li
            ><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a></li>
            <li
            ><a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a></li>
            <li
            ><a href="#static_android.lens.info.hyperfocalDistance">android.lens.info.hyperfocalDistance</a></li>
            <li
            ><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a></li>
            <li
            ><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a></li>
            <li
            ><a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a></li>

            <li
            ><a href="#static_android.lens.facing">android.lens.facing</a></li>
            <li
            ><a href="#static_android.lens.opticalAxisAngle">android.lens.opticalAxisAngle</a></li>
            <li
            ><a href="#static_android.lens.position">android.lens.position</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.lens.aperture">android.lens.aperture</a></li>
            <li
            ><a href="#dynamic_android.lens.filterDensity">android.lens.filterDensity</a></li>
            <li
            ><a href="#dynamic_android.lens.focalLength">android.lens.focalLength</a></li>
            <li
            ><a href="#dynamic_android.lens.focusDistance">android.lens.focusDistance</a></li>
            <li
            ><a href="#dynamic_android.lens.focusRange">android.lens.focusRange</a></li>
            <li
            ><a href="#dynamic_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a></li>
            <li
            ><a href="#dynamic_android.lens.state">android.lens.state</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_noiseReduction">noiseReduction</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a></li>
            <li
            ><a href="#controls_android.noiseReduction.strength">android.noiseReduction.strength</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
            ><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.noiseReduction.mode">android.noiseReduction.mode</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_quirks">quirks</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
                class="toc_deprecated"
            ><a href="#static_android.quirks.meteringCropRegion">android.quirks.meteringCropRegion</a></li>
            <li
                class="toc_deprecated"
            ><a href="#static_android.quirks.triggerAfWithAuto">android.quirks.triggerAfWithAuto</a></li>
            <li
                class="toc_deprecated"
            ><a href="#static_android.quirks.useZslFormat">android.quirks.useZslFormat</a></li>
            <li
                class="toc_deprecated"
            ><a href="#static_android.quirks.usePartialResult">android.quirks.usePartialResult</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
                class="toc_deprecated"
            ><a href="#dynamic_android.quirks.partialResult">android.quirks.partialResult</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_request">request</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
                class="toc_deprecated"
            ><a href="#controls_android.request.frameCount">android.request.frameCount</a></li>
            <li
            ><a href="#controls_android.request.id">android.request.id</a></li>
            <li
                class="toc_deprecated"
            ><a href="#controls_android.request.inputStreams">android.request.inputStreams</a></li>
            <li
            ><a href="#controls_android.request.metadataMode">android.request.metadataMode</a></li>
            <li
                class="toc_deprecated"
            ><a href="#controls_android.request.outputStreams">android.request.outputStreams</a></li>
            <li
                class="toc_deprecated"
            ><a href="#controls_android.request.type">android.request.type</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
            ><a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a></li>
            <li
            ><a href="#static_android.request.maxNumOutputRaw">android.request.maxNumOutputRaw</a></li>
            <li
            ><a href="#static_android.request.maxNumOutputProc">android.request.maxNumOutputProc</a></li>
            <li
            ><a href="#static_android.request.maxNumOutputProcStalling">android.request.maxNumOutputProcStalling</a></li>
            <li
                class="toc_deprecated"
            ><a href="#static_android.request.maxNumReprocessStreams">android.request.maxNumReprocessStreams</a></li>
            <li
            ><a href="#static_android.request.maxNumInputStreams">android.request.maxNumInputStreams</a></li>
            <li
            ><a href="#static_android.request.pipelineMaxDepth">android.request.pipelineMaxDepth</a></li>
            <li
            ><a href="#static_android.request.partialResultCount">android.request.partialResultCount</a></li>
            <li
            ><a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a></li>
            <li
            ><a href="#static_android.request.availableRequestKeys">android.request.availableRequestKeys</a></li>
            <li
            ><a href="#static_android.request.availableResultKeys">android.request.availableResultKeys</a></li>
            <li
            ><a href="#static_android.request.availableCharacteristicsKeys">android.request.availableCharacteristicsKeys</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
                class="toc_deprecated"
            ><a href="#dynamic_android.request.frameCount">android.request.frameCount</a></li>
            <li
            ><a href="#dynamic_android.request.id">android.request.id</a></li>
            <li
            ><a href="#dynamic_android.request.metadataMode">android.request.metadataMode</a></li>
            <li
                class="toc_deprecated"
            ><a href="#dynamic_android.request.outputStreams">android.request.outputStreams</a></li>
            <li
            ><a href="#dynamic_android.request.pipelineDepth">android.request.pipelineDepth</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_scaler">scaler</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
                class="toc_deprecated"
            ><a href="#static_android.scaler.availableFormats">android.scaler.availableFormats</a></li>
            <li
                class="toc_deprecated"
            ><a href="#static_android.scaler.availableJpegMinDurations">android.scaler.availableJpegMinDurations</a></li>
            <li
                class="toc_deprecated"
            ><a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a></li>
            <li
            ><a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a></li>
            <li
                class="toc_deprecated"
            ><a href="#static_android.scaler.availableProcessedMinDurations">android.scaler.availableProcessedMinDurations</a></li>
            <li
                class="toc_deprecated"
            ><a href="#static_android.scaler.availableProcessedSizes">android.scaler.availableProcessedSizes</a></li>
            <li
                class="toc_deprecated"
            ><a href="#static_android.scaler.availableRawMinDurations">android.scaler.availableRawMinDurations</a></li>
            <li
                class="toc_deprecated"
            ><a href="#static_android.scaler.availableRawSizes">android.scaler.availableRawSizes</a></li>
            <li
            ><a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a></li>
            <li
            ><a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a></li>
            <li
            ><a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a></li>
            <li
            ><a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a></li>
            <li
            ><a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a></li>
            <li
            ><a href="#static_android.scaler.croppingType">android.scaler.croppingType</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.scaler.cropRegion">android.scaler.cropRegion</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_sensor">sensor</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a></li>
            <li
            ><a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a></li>
            <li
            ><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a></li>
            <li
            ><a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a></li>
            <li
            ><a href="#controls_android.sensor.testPatternMode">android.sensor.testPatternMode</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">

            <li
            ><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a></li>
            <li
            ><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a></li>
            <li
            ><a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a></li>
            <li
            ><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a></li>
            <li
            ><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a></li>
            <li
            ><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a></li>
            <li
            ><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a></li>
            <li
            ><a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a></li>
            <li
            ><a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a></li>

            <li
            ><a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a></li>
            <li
            ><a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a></li>
            <li
            ><a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a></li>
            <li
            ><a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a></li>
            <li
            ><a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a></li>
            <li
            ><a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a></li>
            <li
            ><a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a></li>
            <li
            ><a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a></li>
            <li
            ><a href="#static_android.sensor.baseGainFactor">android.sensor.baseGainFactor</a></li>
            <li
            ><a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a></li>
            <li
            ><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a></li>
            <li
            ><a href="#static_android.sensor.orientation">android.sensor.orientation</a></li>
            <li
            ><a href="#static_android.sensor.profileHueSatMapDimensions">android.sensor.profileHueSatMapDimensions</a></li>
            <li
            ><a href="#static_android.sensor.availableTestPatternModes">android.sensor.availableTestPatternModes</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.sensor.exposureTime">android.sensor.exposureTime</a></li>
            <li
            ><a href="#dynamic_android.sensor.frameDuration">android.sensor.frameDuration</a></li>
            <li
            ><a href="#dynamic_android.sensor.sensitivity">android.sensor.sensitivity</a></li>
            <li
            ><a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a></li>
            <li
            ><a href="#dynamic_android.sensor.temperature">android.sensor.temperature</a></li>
            <li
            ><a href="#dynamic_android.sensor.neutralColorPoint">android.sensor.neutralColorPoint</a></li>
            <li
            ><a href="#dynamic_android.sensor.noiseProfile">android.sensor.noiseProfile</a></li>
            <li
            ><a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a></li>
            <li
            ><a href="#dynamic_android.sensor.profileToneCurve">android.sensor.profileToneCurve</a></li>
            <li
            ><a href="#dynamic_android.sensor.greenSplit">android.sensor.greenSplit</a></li>
            <li
            ><a href="#dynamic_android.sensor.testPatternData">android.sensor.testPatternData</a></li>
            <li
            ><a href="#dynamic_android.sensor.testPatternMode">android.sensor.testPatternMode</a></li>
            <li
            ><a href="#dynamic_android.sensor.rollingShutterSkew">android.sensor.rollingShutterSkew</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_shading">shading</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.shading.mode">android.shading.mode</a></li>
            <li
            ><a href="#controls_android.shading.strength">android.shading.strength</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.shading.mode">android.shading.mode</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_statistics">statistics</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>
            <li
            ><a href="#controls_android.statistics.histogramMode">android.statistics.histogramMode</a></li>
            <li
            ><a href="#controls_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a></li>
            <li
            ><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a></li>
            <li
            ><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">

            <li
            ><a href="#static_android.statistics.info.availableFaceDetectModes">android.statistics.info.availableFaceDetectModes</a></li>
            <li
            ><a href="#static_android.statistics.info.histogramBucketCount">android.statistics.info.histogramBucketCount</a></li>
            <li
            ><a href="#static_android.statistics.info.maxFaceCount">android.statistics.info.maxFaceCount</a></li>
            <li
            ><a href="#static_android.statistics.info.maxHistogramCount">android.statistics.info.maxHistogramCount</a></li>
            <li
            ><a href="#static_android.statistics.info.maxSharpnessMapValue">android.statistics.info.maxSharpnessMapValue</a></li>
            <li
            ><a href="#static_android.statistics.info.sharpnessMapSize">android.statistics.info.sharpnessMapSize</a></li>
            <li
            ><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a></li>

          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>
            <li
            ><a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a></li>
            <li
            ><a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a></li>
            <li
            ><a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a></li>
            <li
            ><a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a></li>
            <li
            ><a href="#dynamic_android.statistics.faces">android.statistics.faces</a></li>
            <li
            ><a href="#dynamic_android.statistics.histogram">android.statistics.histogram</a></li>
            <li
            ><a href="#dynamic_android.statistics.histogramMode">android.statistics.histogramMode</a></li>
            <li
            ><a href="#dynamic_android.statistics.sharpnessMap">android.statistics.sharpnessMap</a></li>
            <li
            ><a href="#dynamic_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a></li>
            <li
            ><a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a></li>
            <li
            ><a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a></li>
            <li
                class="toc_deprecated"
            ><a href="#dynamic_android.statistics.predictedColorGains">android.statistics.predictedColorGains</a></li>
            <li
                class="toc_deprecated"
            ><a href="#dynamic_android.statistics.predictedColorTransform">android.statistics.predictedColorTransform</a></li>
            <li
            ><a href="#dynamic_android.statistics.sceneFlicker">android.statistics.sceneFlicker</a></li>
            <li
            ><a href="#dynamic_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a></li>
            <li
            ><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a></li>
            <li
            ><a href="#dynamic_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_tonemap">tonemap</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.tonemap.curveBlue">android.tonemap.curveBlue</a></li>
            <li
            ><a href="#controls_android.tonemap.curveGreen">android.tonemap.curveGreen</a></li>
            <li
            ><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a></li>
            <li
            ><a href="#controls_android.tonemap.curve">android.tonemap.curve</a></li>
            <li
            ><a href="#controls_android.tonemap.mode">android.tonemap.mode</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
            ><a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></li>
            <li
            ><a href="#static_android.tonemap.availableToneMapModes">android.tonemap.availableToneMapModes</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.tonemap.curveBlue">android.tonemap.curveBlue</a></li>
            <li
            ><a href="#dynamic_android.tonemap.curveGreen">android.tonemap.curveGreen</a></li>
            <li
            ><a href="#dynamic_android.tonemap.curveRed">android.tonemap.curveRed</a></li>
            <li
            ><a href="#dynamic_android.tonemap.curve">android.tonemap.curve</a></li>
            <li
            ><a href="#dynamic_android.tonemap.mode">android.tonemap.mode</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_led">led</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.led.transmit">android.led.transmit</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.led.transmit">android.led.transmit</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
            ><a href="#static_android.led.availableLeds">android.led.availableLeds</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_info">info</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
            ><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_blackLevel">blackLevel</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">controls</span>
          <ul class="toc_section">
            <li
            ><a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.blackLevel.lock">android.blackLevel.lock</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
    <li>
      <span class="toc_section_header"><a href="#section_sync">sync</a></span>
      <ul class="toc_section">
        <li>
          <span class="toc_kind_header">dynamic</span>
          <ul class="toc_section">
            <li
            ><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a></li>
          </ul>
        </li>
        <li>
          <span class="toc_kind_header">static</span>
          <ul class="toc_section">
            <li
            ><a href="#static_android.sync.maxLatency">android.sync.maxLatency</a></li>
          </ul>
        </li>
      </ul> <!-- toc_section -->
    </li>
  </ul>


  <h1>Properties</h1>
  <table class="properties">

    <thead class="thead_dummy">
      <tr>
        <th class="th_name">Property Name</th>
        <th class="th_type">Type</th>
        <th class="th_description">Description</th>
        <th class="th_units">Units</th>
        <th class="th_range">Range</th>
        <th class="th_tags">Tags</th>
      </tr>
    </thead> <!-- so that the first occurrence of thead is not
                         above the first occurrence of tr -->
<!-- <namespace name="android"> -->
  <tr><td colspan="6" id="section_colorCorrection" class="section">colorCorrection</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.colorCorrection.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>color<wbr/>Correction.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">TRANSFORM_MATRIX</span>
                    <span class="entry_type_enum_notes"><p>Use the <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> matrix
and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> to do color conversion.<wbr/></p>
<p>All advanced white balance adjustments (not specified
by our white balance pipeline) must be disabled.<wbr/></p>
<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
TRANSFORM_<wbr/>MATRIX is ignored.<wbr/> The camera device will override
this value to either FAST or HIGH_<wbr/>QUALITY.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Color correction processing must not slow down
capture rate relative to sensor raw output.<wbr/></p>
<p>Advanced white balance adjustments above and beyond
the specified white balance pipeline may be applied.<wbr/></p>
<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
the camera device uses the last frame's AWB values
(or defaults if AWB has never been run).<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>Color correction processing operates at improved
quality but reduced capture rate (relative to sensor raw
output).<wbr/></p>
<p>Advanced white balance adjustments above and beyond
the specified white balance pipeline may be applied.<wbr/></p>
<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
the camera device uses the last frame's AWB values
(or defaults if AWB has never been run).<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The mode control selects how the image data is converted from the
sensor's native color into linear sRGB color.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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
control is overridden by the AWB routine.<wbr/> When AWB is disabled,<wbr/> the
application controls how the color mapping is performed.<wbr/></p>
<p>We define the expected processing pipeline below.<wbr/> For consistency
across devices,<wbr/> this is always the case with TRANSFORM_<wbr/>MATRIX.<wbr/></p>
<p>When either FULL or HIGH_<wbr/>QUALITY is used,<wbr/> the camera device may
do additional processing but <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
<a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> will still be provided by the
camera device (in the results) and be roughly correct.<wbr/></p>
<p>Switching to TRANSFORM_<wbr/>MATRIX and using the data provided from
FAST or HIGH_<wbr/>QUALITY will yield a picture with the same white point
as what was produced by the camera device in the earlier frame.<wbr/></p>
<p>The expected processing pipeline is as follows:</p>
<p><img alt="White balance processing pipeline" src="images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png"/></p>
<p>The white balance is encoded by two values,<wbr/> a 4-channel white-balance
gain vector (applied in the Bayer domain),<wbr/> and a 3x3 color transform
matrix (applied after demosaic).<wbr/></p>
<p>The 4-channel white-balance gains are defined as:</p>
<pre><code><a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> = [ R G_<wbr/>even G_<wbr/>odd B ]
</code></pre>
<p>where <code>G_<wbr/>even</code> is the gain for green pixels on even rows of the
output,<wbr/> and <code>G_<wbr/>odd</code> is the gain for green pixels on the odd rows.<wbr/>
These may be identical for a given camera device implementation; if
the camera device does not support a separate gain for even/<wbr/>odd green
channels,<wbr/> it will use the <code>G_<wbr/>even</code> value,<wbr/> and write <code>G_<wbr/>odd</code> equal to
<code>G_<wbr/>even</code> in the output result metadata.<wbr/></p>
<p>The matrices for color transforms are defined as a 9-entry vector:</p>
<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 ]
</code></pre>
<p>which define a transform from input sensor colors,<wbr/> <code>P_<wbr/>in = [ r g b ]</code>,<wbr/>
to output linear sRGB,<wbr/> <code>P_<wbr/>out = [ r' g' b' ]</code>,<wbr/></p>
<p>with colors as follows:</p>
<pre><code>r' = I0r + I1g + I2b
g' = I3r + I4g + I5b
b' = I6r + I7g + I8b
</code></pre>
<p>Both the input and output value ranges must match.<wbr/> Overflow/<wbr/>underflow
values are clipped to fit within the range.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.colorCorrection.transform">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>color<wbr/>Correction.<wbr/>transform
            </td>
            <td class="entry_type">
                <span class="entry_type_name">rational</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3 x 3
                </span>
              <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <div class="entry_type_notes">3x3 rational matrix in row-major order</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A color transform matrix to use to transform
from sensor RGB color space to output linear sRGB color space.<wbr/></p>
            </td>

            <td class="entry_units">
              Unitless scale factors
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This matrix is either set by the camera device when the request
<a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is not TRANSFORM_<wbr/>MATRIX,<wbr/> or
directly by the application in the request when the
<a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is TRANSFORM_<wbr/>MATRIX.<wbr/></p>
<p>In the latter case,<wbr/> the camera device may round the matrix to account
for precision issues; the final rounded matrix should be reported back
in this matrix result metadata.<wbr/> The transform should keep the magnitude
of the output color values within <code>[0,<wbr/> 1.<wbr/>0]</code> (assuming input color
values is within the normalized range <code>[0,<wbr/> 1.<wbr/>0]</code>),<wbr/> or clipping may occur.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.colorCorrection.gains">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>color<wbr/>Correction.<wbr/>gains
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4
                </span>
              <span class="entry_type_visibility"> [public as rggbChannelVector]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Gains applying to Bayer raw color channels for
white-balance.<wbr/></p>
            </td>

            <td class="entry_units">
              Unitless gain factors
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>These per-channel gains are either set by the camera device
when the request <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is not
TRANSFORM_<wbr/>MATRIX,<wbr/> or directly by the application in the
request when the <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is
TRANSFORM_<wbr/>MATRIX.<wbr/></p>
<p>The gains in the result metadata are the gains actually
applied by the camera device to the current frame.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The 4-channel white-balance gains are defined in
the order of <code>[R G_<wbr/>even G_<wbr/>odd B]</code>,<wbr/> where <code>G_<wbr/>even</code> is the gain
for green pixels on even rows of the output,<wbr/> and <code>G_<wbr/>odd</code>
is the gain for green pixels on the odd rows.<wbr/></p>
<p>If a HAL does not support a separate gain for even/<wbr/>odd green
channels,<wbr/> it must use the <code>G_<wbr/>even</code> value,<wbr/> and write
<code>G_<wbr/>odd</code> equal to <code>G_<wbr/>even</code> in the output result metadata.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.colorCorrection.aberrationMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No aberration correction is applied.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Aberration correction will not slow down capture rate
relative to sensor raw output.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>Aberration correction operates at improved quality but reduced
capture rate (relative to sensor raw output).<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Mode of operation for the chromatic aberration correction algorithm.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.colorCorrection.availableAberrationModes">android.<wbr/>color<wbr/>Correction.<wbr/>available<wbr/>Aberration<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light
can not focus on the same point after exiting from the lens.<wbr/> This metadata defines
the high level control of chromatic aberration correction algorithm,<wbr/> which aims to
minimize the chromatic artifacts that may occur along the object boundaries in an
image.<wbr/></p>
<p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean that camera device determined aberration
correction will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the camera device will
use the highest-quality aberration correction algorithms,<wbr/> even if it slows down
capture rate.<wbr/> FAST means the camera device will not slow down capture rate when
applying aberration correction.<wbr/></p>
<p>LEGACY devices will always be in FAST mode.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.colorCorrection.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>color<wbr/>Correction.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">TRANSFORM_MATRIX</span>
                    <span class="entry_type_enum_notes"><p>Use the <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> matrix
and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> to do color conversion.<wbr/></p>
<p>All advanced white balance adjustments (not specified
by our white balance pipeline) must be disabled.<wbr/></p>
<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
TRANSFORM_<wbr/>MATRIX is ignored.<wbr/> The camera device will override
this value to either FAST or HIGH_<wbr/>QUALITY.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Color correction processing must not slow down
capture rate relative to sensor raw output.<wbr/></p>
<p>Advanced white balance adjustments above and beyond
the specified white balance pipeline may be applied.<wbr/></p>
<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
the camera device uses the last frame's AWB values
(or defaults if AWB has never been run).<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>Color correction processing operates at improved
quality but reduced capture rate (relative to sensor raw
output).<wbr/></p>
<p>Advanced white balance adjustments above and beyond
the specified white balance pipeline may be applied.<wbr/></p>
<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
the camera device uses the last frame's AWB values
(or defaults if AWB has never been run).<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The mode control selects how the image data is converted from the
sensor's native color into linear sRGB color.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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
control is overridden by the AWB routine.<wbr/> When AWB is disabled,<wbr/> the
application controls how the color mapping is performed.<wbr/></p>
<p>We define the expected processing pipeline below.<wbr/> For consistency
across devices,<wbr/> this is always the case with TRANSFORM_<wbr/>MATRIX.<wbr/></p>
<p>When either FULL or HIGH_<wbr/>QUALITY is used,<wbr/> the camera device may
do additional processing but <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
<a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> will still be provided by the
camera device (in the results) and be roughly correct.<wbr/></p>
<p>Switching to TRANSFORM_<wbr/>MATRIX and using the data provided from
FAST or HIGH_<wbr/>QUALITY will yield a picture with the same white point
as what was produced by the camera device in the earlier frame.<wbr/></p>
<p>The expected processing pipeline is as follows:</p>
<p><img alt="White balance processing pipeline" src="images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png"/></p>
<p>The white balance is encoded by two values,<wbr/> a 4-channel white-balance
gain vector (applied in the Bayer domain),<wbr/> and a 3x3 color transform
matrix (applied after demosaic).<wbr/></p>
<p>The 4-channel white-balance gains are defined as:</p>
<pre><code><a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> = [ R G_<wbr/>even G_<wbr/>odd B ]
</code></pre>
<p>where <code>G_<wbr/>even</code> is the gain for green pixels on even rows of the
output,<wbr/> and <code>G_<wbr/>odd</code> is the gain for green pixels on the odd rows.<wbr/>
These may be identical for a given camera device implementation; if
the camera device does not support a separate gain for even/<wbr/>odd green
channels,<wbr/> it will use the <code>G_<wbr/>even</code> value,<wbr/> and write <code>G_<wbr/>odd</code> equal to
<code>G_<wbr/>even</code> in the output result metadata.<wbr/></p>
<p>The matrices for color transforms are defined as a 9-entry vector:</p>
<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 ]
</code></pre>
<p>which define a transform from input sensor colors,<wbr/> <code>P_<wbr/>in = [ r g b ]</code>,<wbr/>
to output linear sRGB,<wbr/> <code>P_<wbr/>out = [ r' g' b' ]</code>,<wbr/></p>
<p>with colors as follows:</p>
<pre><code>r' = I0r + I1g + I2b
g' = I3r + I4g + I5b
b' = I6r + I7g + I8b
</code></pre>
<p>Both the input and output value ranges must match.<wbr/> Overflow/<wbr/>underflow
values are clipped to fit within the range.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.colorCorrection.transform">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>color<wbr/>Correction.<wbr/>transform
            </td>
            <td class="entry_type">
                <span class="entry_type_name">rational</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3 x 3
                </span>
              <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <div class="entry_type_notes">3x3 rational matrix in row-major order</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A color transform matrix to use to transform
from sensor RGB color space to output linear sRGB color space.<wbr/></p>
            </td>

            <td class="entry_units">
              Unitless scale factors
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This matrix is either set by the camera device when the request
<a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is not TRANSFORM_<wbr/>MATRIX,<wbr/> or
directly by the application in the request when the
<a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is TRANSFORM_<wbr/>MATRIX.<wbr/></p>
<p>In the latter case,<wbr/> the camera device may round the matrix to account
for precision issues; the final rounded matrix should be reported back
in this matrix result metadata.<wbr/> The transform should keep the magnitude
of the output color values within <code>[0,<wbr/> 1.<wbr/>0]</code> (assuming input color
values is within the normalized range <code>[0,<wbr/> 1.<wbr/>0]</code>),<wbr/> or clipping may occur.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.colorCorrection.gains">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>color<wbr/>Correction.<wbr/>gains
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4
                </span>
              <span class="entry_type_visibility"> [public as rggbChannelVector]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Gains applying to Bayer raw color channels for
white-balance.<wbr/></p>
            </td>

            <td class="entry_units">
              Unitless gain factors
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>These per-channel gains are either set by the camera device
when the request <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is not
TRANSFORM_<wbr/>MATRIX,<wbr/> or directly by the application in the
request when the <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is
TRANSFORM_<wbr/>MATRIX.<wbr/></p>
<p>The gains in the result metadata are the gains actually
applied by the camera device to the current frame.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The 4-channel white-balance gains are defined in
the order of <code>[R G_<wbr/>even G_<wbr/>odd B]</code>,<wbr/> where <code>G_<wbr/>even</code> is the gain
for green pixels on even rows of the output,<wbr/> and <code>G_<wbr/>odd</code>
is the gain for green pixels on the odd rows.<wbr/></p>
<p>If a HAL does not support a separate gain for even/<wbr/>odd green
channels,<wbr/> it must use the <code>G_<wbr/>even</code> value,<wbr/> and write
<code>G_<wbr/>odd</code> equal to <code>G_<wbr/>even</code> in the output result metadata.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.colorCorrection.aberrationMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No aberration correction is applied.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Aberration correction will not slow down capture rate
relative to sensor raw output.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>Aberration correction operates at improved quality but reduced
capture rate (relative to sensor raw output).<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Mode of operation for the chromatic aberration correction algorithm.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.colorCorrection.availableAberrationModes">android.<wbr/>color<wbr/>Correction.<wbr/>available<wbr/>Aberration<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light
can not focus on the same point after exiting from the lens.<wbr/> This metadata defines
the high level control of chromatic aberration correction algorithm,<wbr/> which aims to
minimize the chromatic artifacts that may occur along the object boundaries in an
image.<wbr/></p>
<p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean that camera device determined aberration
correction will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the camera device will
use the highest-quality aberration correction algorithms,<wbr/> even if it slows down
capture rate.<wbr/> FAST means the camera device will not slow down capture rate when
applying aberration correction.<wbr/></p>
<p>LEGACY devices will always be in FAST mode.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.colorCorrection.availableAberrationModes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>color<wbr/>Correction.<wbr/>available<wbr/>Aberration<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">list of enums</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <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
supported by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.colorCorrection.aberrationMode">android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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
aberration correction modes are available for a device,<wbr/> this list will solely include
OFF mode.<wbr/> All camera devices will support either OFF or FAST mode.<wbr/></p>
<p>Camera devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability will always list
OFF mode.<wbr/> This includes all FULL level devices.<wbr/></p>
<p>LEGACY devices will always only support FAST mode.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_control" class="section">control</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.control.aeAntibandingMode">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>The camera device will not adjust exposure duration to
avoid banding problems.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">50HZ</span>
                    <span class="entry_type_enum_notes"><p>The camera device will adjust exposure duration to
avoid banding problems with 50Hz illumination sources.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">60HZ</span>
                    <span class="entry_type_enum_notes"><p>The camera device will adjust exposure duration to
avoid banding problems with 60Hz illumination
sources.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">AUTO</span>
                    <span class="entry_type_enum_notes"><p>The camera device will automatically adapt its
antibanding routine to the current illumination
condition.<wbr/> This is the default mode if AUTO is
available on given camera device.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired setting for the camera device's auto-exposure
algorithm's antibanding compensation.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.aeAvailableAntibandingModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Some kinds of lighting fixtures,<wbr/> such as some fluorescent
lights,<wbr/> flicker at the rate of the power supply frequency
(60Hz or 50Hz,<wbr/> depending on country).<wbr/> While this is
typically not noticeable to a person,<wbr/> it can be visible to
a camera device.<wbr/> If a camera sets its exposure time to the
wrong value,<wbr/> the flicker may become visible in the
viewfinder as flicker or in a final captured image,<wbr/> as a
set of variable-brightness bands across the image.<wbr/></p>
<p>Therefore,<wbr/> the auto-exposure routines of camera devices
include antibanding routines that ensure that the chosen
exposure value will not cause such banding.<wbr/> The choice of
exposure time depends on the rate of flicker,<wbr/> which the
camera device can detect automatically,<wbr/> or the expected
rate can be selected by the application using this
control.<wbr/></p>
<p>A given camera device may not support all of the possible
options for the antibanding mode.<wbr/> The
<a href="#static_android.control.aeAvailableAntibandingModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes</a> key contains
the available modes for a given camera device.<wbr/></p>
<p>AUTO mode is the default if it is available on given
camera device.<wbr/> When AUTO mode is not available,<wbr/> the
default will be either 50HZ or 60HZ,<wbr/> and both 50HZ
and 60HZ will be available.<wbr/></p>
<p>If manual exposure control is enabled (by setting
<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/>
then this setting has no effect,<wbr/> and the application must
ensure it selects exposure times that do not cause banding
issues.<wbr/> The <a href="#dynamic_android.statistics.sceneFlicker">android.<wbr/>statistics.<wbr/>scene<wbr/>Flicker</a> key can assist
the application in this.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For all capture request templates,<wbr/> this field must be set
to AUTO if AUTO mode is available.<wbr/> If AUTO is not available,<wbr/>
the default must be either 50HZ or 60HZ,<wbr/> and both 50HZ and
60HZ must be available.<wbr/></p>
<p>If manual exposure control is enabled (by setting
<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/>
then the exposure values provided by the application must not be
adjusted for antibanding.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.aeExposureCompensation">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Adjustment to auto-exposure (AE) target image
brightness.<wbr/></p>
            </td>

            <td class="entry_units">
              Compensation steps
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.aeCompensationRange">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The adjustment is measured as a count of steps,<wbr/> with the
step size defined by <a href="#static_android.control.aeCompensationStep">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step</a> and the
allowed range by <a href="#static_android.control.aeCompensationRange">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range</a>.<wbr/></p>
<p>For example,<wbr/> if the exposure value (EV) step is 0.<wbr/>333,<wbr/> '6'
will mean an exposure compensation of +2 EV; -3 will mean an
exposure compensation of -1 EV.<wbr/> One EV represents a doubling
of image brightness.<wbr/> Note that this control will only be
effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>!=</code> OFF.<wbr/> This control
will take effect even when <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> <code>== true</code>.<wbr/></p>
<p>In the event of exposure compensation value being changed,<wbr/> camera device
may take several frames to reach the newly requested exposure target.<wbr/>
During that time,<wbr/> <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> field will be in the SEARCHING
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
change from SEARCHING to either CONVERGED,<wbr/> LOCKED (if AE lock is enabled),<wbr/> or
FLASH_<wbr/>REQUIRED (if the scene is too dark for still capture).<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.aeLock">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Lock
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public as boolean]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Auto-exposure lock is disabled; the AE algorithm
is free to update its parameters.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_notes"><p>Auto-exposure lock is enabled; the AE algorithm
must not update the exposure and sensitivity parameters
while the lock is active.<wbr/></p>
<p><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a> setting changes
will still take effect while auto-exposure is locked.<wbr/></p>
<p>Some rare LEGACY devices may not support
this,<wbr/> in which case the value will always be overridden to OFF.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether auto-exposure (AE) is currently locked to its latest
calculated values.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When set to <code>true</code> (ON),<wbr/> the AE algorithm is locked to its latest parameters,<wbr/>
and will not change exposure settings until the lock is set to <code>false</code> (OFF).<wbr/></p>
<p>Note that even when AE is locked,<wbr/> the flash may be fired if
the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is ON_<wbr/>AUTO_<wbr/>FLASH /<wbr/>
ON_<wbr/>ALWAYS_<wbr/>FLASH /<wbr/> ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE.<wbr/></p>
<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
is ON,<wbr/> the camera device will still adjust its exposure value.<wbr/></p>
<p>If AE precapture is triggered (see <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>)
when AE is already locked,<wbr/> the camera device will not change the exposure time
(<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>)
parameters.<wbr/> The flash may be fired if the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>
is ON_<wbr/>AUTO_<wbr/>FLASH/<wbr/>ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE and the scene is too dark.<wbr/> If the
<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>
<p>Since the camera device has a pipeline of in-flight requests,<wbr/> the settings that
get locked do not necessarily correspond to the settings that were present in the
latest capture result received from the camera device,<wbr/> since additional captures
and AE updates may have occurred even before the result was sent out.<wbr/> If an
application is switching between automatic and manual control and wishes to eliminate
any flicker during the switch,<wbr/> the following procedure is recommended:</p>
<ol>
<li>Starting in auto-AE mode:</li>
<li>Lock AE</li>
<li>Wait for the first result to be output that has the AE locked</li>
<li>Copy exposure settings from that result into a request,<wbr/> set the request to manual AE</li>
<li>Submit the capture request,<wbr/> proceed to run manual AE as desired.<wbr/></li>
</ol>
<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>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.aeMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>The camera device's autoexposure routine is disabled.<wbr/></p>
<p>The application-selected <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> and
<a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> are used by the camera
device,<wbr/> along with android.<wbr/>flash.<wbr/>* fields,<wbr/> if there's
a flash unit for this camera device.<wbr/></p>
<p>Note that auto-white balance (AWB) and auto-focus (AF)
behavior is device dependent when AE is in OFF mode.<wbr/>
To have consistent behavior across different devices,<wbr/>
it is recommended to either set AWB and AF to OFF mode
or lock AWB and AF before setting AE to OFF.<wbr/>
See <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>,<wbr/>
<a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a>,<wbr/> and <a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>
for more details.<wbr/></p>
<p>LEGACY devices do not support the OFF mode and will
override attempts to use this value to ON.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_notes"><p>The camera device's autoexposure routine is active,<wbr/>
with no flash control.<wbr/></p>
<p>The application's values for
<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/> and
<a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> are ignored.<wbr/> The
application has control over the various
android.<wbr/>flash.<wbr/>* fields.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON_AUTO_FLASH</span>
                    <span class="entry_type_enum_notes"><p>Like ON,<wbr/> except that the camera device also controls
the camera's flash unit,<wbr/> firing it in low-light
conditions.<wbr/></p>
<p>The flash may be fired during a precapture sequence
(triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>) and
may be fired for captures for which the
<a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> field is set to
STILL_<wbr/>CAPTURE</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON_ALWAYS_FLASH</span>
                    <span class="entry_type_enum_notes"><p>Like ON,<wbr/> except that the camera device also controls
the camera's flash unit,<wbr/> always firing it for still
captures.<wbr/></p>
<p>The flash may be fired during a precapture sequence
(triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>) and
will always be fired for captures for which the
<a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> field is set to
STILL_<wbr/>CAPTURE</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON_AUTO_FLASH_REDEYE</span>
                    <span class="entry_type_enum_notes"><p>Like ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/> but with automatic red eye
reduction.<wbr/></p>
<p>If deemed necessary by the camera device,<wbr/> a red eye
reduction flash will fire during the precapture
sequence.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired mode for the camera device's
auto-exposure routine.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.aeAvailableModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control is only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is
AUTO.<wbr/></p>
<p>When set to any of the ON modes,<wbr/> the camera device's
auto-exposure routine is enabled,<wbr/> overriding the
application's selected exposure time,<wbr/> sensor sensitivity,<wbr/>
and frame duration (<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/> and
<a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>).<wbr/> If one of the FLASH modes
is selected,<wbr/> the camera device's flash unit controls are
also overridden.<wbr/></p>
<p>The FLASH modes are only available if the camera device
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>
<p>If flash TORCH mode is desired,<wbr/> this field must be set to
ON or OFF,<wbr/> and <a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> set to TORCH.<wbr/></p>
<p>When set to any of the ON modes,<wbr/> the values chosen by the
camera device auto-exposure routine for the overridden
fields for a given capture will be available in its
CaptureResult.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.aeRegions">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>ae<wbr/>Regions
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  5 x area_count
                </span>
              <span class="entry_type_visibility"> [public as meteringRectangle]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of metering areas to use for auto-exposure adjustment.<wbr/></p>
            </td>

            <td class="entry_units">
              Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
            </td>

            <td class="entry_range">
              <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Not available if <a href="#static_android.control.maxRegionsAe">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae</a> is 0.<wbr/>
Otherwise will always be present.<wbr/></p>
<p>The maximum number of regions supported by the device is determined by the value
of <a href="#static_android.control.maxRegionsAe">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae</a>.<wbr/></p>
<p>The coordinate system is based on the active pixel array,<wbr/>
with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
(<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
bottom-right pixel in the active pixel array.<wbr/></p>
<p>The weight must be within <code>[0,<wbr/> 1000]</code>,<wbr/> and represents a weight
for every pixel in the area.<wbr/> This means that a large metering area
with the same weight as a smaller area will have more effect in
the metering result.<wbr/> Metering areas can partially overlap and the
camera device will add the weights in the overlap region.<wbr/></p>
<p>The weights are relative to weights of other exposure metering regions,<wbr/> so if only one
region is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with 0
weight is ignored.<wbr/></p>
<p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
camera device.<wbr/></p>
<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
capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
region and output only the intersection rectangle as the metering region in the result
metadata.<wbr/>  If the region is entirely outside the crop region,<wbr/> it will be ignored and
not reported in the result metadata.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The HAL level representation of MeteringRectangle[] is a
int[5 * area_<wbr/>count].<wbr/>
Every five elements represent a metering region of
(xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
exclusive on xmax and ymax.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.aeTargetFpsRange">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [public as rangeInt]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Range over which the auto-exposure routine can
adjust the capture frame rate to maintain good
exposure.<wbr/></p>
            </td>

            <td class="entry_units">
              Frames per second (FPS)
            </td>

            <td class="entry_range">
              <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>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Only constrains auto-exposure (AE) algorithm,<wbr/> not
manual control of <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a> and
<a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.aePrecaptureTrigger">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[limited] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">IDLE</span>
                    <span class="entry_type_enum_notes"><p>The trigger is idle.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">START</span>
                    <span class="entry_type_enum_notes"><p>The precapture metering sequence will be started
by the camera device.<wbr/></p>
<p>The exact effect of the precapture trigger depends on
the current AE mode and state.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether the camera device will trigger a precapture
metering sequence when it processes this request.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This entry is normally set to IDLE,<wbr/> or is not
included at all in the request settings.<wbr/> When included and
set to START,<wbr/> the camera device will trigger the auto-exposure (AE)
precapture metering sequence.<wbr/></p>
<p>The precapture sequence should be triggered before starting a
high-quality still capture for final metering decisions to
be made,<wbr/> and for firing pre-capture flash pulses to estimate
scene brightness and required final capture flash power,<wbr/> when
the flash is enabled.<wbr/></p>
<p>Normally,<wbr/> this entry should be set to START for only a
single request,<wbr/> and the application should wait until the
sequence completes before starting a new one.<wbr/></p>
<p>When a precapture metering sequence is finished,<wbr/> the camera device
may lock the auto-exposure routine internally to be able to accurately expose the
subsequent still capture image (<code><a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> == STILL_<wbr/>CAPTURE</code>).<wbr/>
For this case,<wbr/> the AE may not resume normal scan if no subsequent still capture is
submitted.<wbr/> To ensure that the AE routine restarts normal scan,<wbr/> the application should
submit a request with <code><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> == true</code>,<wbr/> followed by a request
with <code><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> == false</code>,<wbr/> if the application decides not to submit a
still capture request after the precapture sequence completes.<wbr/></p>
<p>The exact effect of auto-exposure (AE) precapture trigger
depends on the current AE mode and state; see
<a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> for AE precapture state transition
details.<wbr/></p>
<p>On LEGACY-level devices,<wbr/> the precapture trigger is not supported;
capturing a high-resolution JPEG image will automatically trigger a
precapture sequence before the high-resolution capture,<wbr/> including
potentially firing a pre-capture flash.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.afMode">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>af<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>The auto-focus routine does not control the lens;
<a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> is controlled by the
application.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">AUTO</span>
                    <span class="entry_type_enum_notes"><p>Basic automatic focus mode.<wbr/></p>
<p>In this mode,<wbr/> the lens does not move unless
the autofocus trigger action is called.<wbr/> When that trigger
is activated,<wbr/> AF will transition to ACTIVE_<wbr/>SCAN,<wbr/> then to
the outcome of the scan (FOCUSED or NOT_<wbr/>FOCUSED).<wbr/></p>
<p>Always supported if lens is not fixed focus.<wbr/></p>
<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
is fixed-focus.<wbr/></p>
<p>Triggering AF_<wbr/>CANCEL resets the lens position to default,<wbr/>
and sets the AF state to INACTIVE.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">MACRO</span>
                    <span class="entry_type_enum_notes"><p>Close-up focusing mode.<wbr/></p>
<p>In this mode,<wbr/> the lens does not move unless the
autofocus trigger action is called.<wbr/> When that trigger is
activated,<wbr/> AF will transition to ACTIVE_<wbr/>SCAN,<wbr/> then to
the outcome of the scan (FOCUSED or NOT_<wbr/>FOCUSED).<wbr/> This
mode is optimized for focusing on objects very close to
the camera.<wbr/></p>
<p>When that trigger is activated,<wbr/> AF will transition to
ACTIVE_<wbr/>SCAN,<wbr/> then to the outcome of the scan (FOCUSED or
NOT_<wbr/>FOCUSED).<wbr/> Triggering cancel AF resets the lens
position to default,<wbr/> and sets the AF state to
INACTIVE.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CONTINUOUS_VIDEO</span>
                    <span class="entry_type_enum_notes"><p>In this mode,<wbr/> the AF algorithm modifies the lens
position continually to attempt to provide a
constantly-in-focus image stream.<wbr/></p>
<p>The focusing behavior should be suitable for good quality
video recording; typically this means slower focus
movement and no overshoots.<wbr/> When the AF trigger is not
involved,<wbr/> the AF algorithm should start in INACTIVE state,<wbr/>
and then transition into PASSIVE_<wbr/>SCAN and PASSIVE_<wbr/>FOCUSED
states as appropriate.<wbr/> When the AF trigger is activated,<wbr/>
the algorithm should immediately transition into
AF_<wbr/>FOCUSED or AF_<wbr/>NOT_<wbr/>FOCUSED as appropriate,<wbr/> and lock the
lens position until a cancel AF trigger is received.<wbr/></p>
<p>Once cancel is received,<wbr/> the algorithm should transition
back to INACTIVE and resume passive scan.<wbr/> Note that this
behavior is not identical to CONTINUOUS_<wbr/>PICTURE,<wbr/> since an
ongoing PASSIVE_<wbr/>SCAN must immediately be
canceled.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CONTINUOUS_PICTURE</span>
                    <span class="entry_type_enum_notes"><p>In this mode,<wbr/> the AF algorithm modifies the lens
position continually to attempt to provide a
constantly-in-focus image stream.<wbr/></p>
<p>The focusing behavior should be suitable for still image
capture; typically this means focusing as fast as
possible.<wbr/> When the AF trigger is not involved,<wbr/> the AF
algorithm should start in INACTIVE state,<wbr/> and then
transition into PASSIVE_<wbr/>SCAN and PASSIVE_<wbr/>FOCUSED states as
appropriate as it attempts to maintain focus.<wbr/> When the AF
trigger is activated,<wbr/> the algorithm should finish its
PASSIVE_<wbr/>SCAN if active,<wbr/> and then transition into
AF_<wbr/>FOCUSED or AF_<wbr/>NOT_<wbr/>FOCUSED as appropriate,<wbr/> and lock the
lens position until a cancel AF trigger is received.<wbr/></p>
<p>When the AF cancel trigger is activated,<wbr/> the algorithm
should transition back to INACTIVE and then act as if it
has just been started.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">EDOF</span>
                    <span class="entry_type_enum_notes"><p>Extended depth of field (digital focus) mode.<wbr/></p>
<p>The camera device will produce images with an extended
depth of field automatically; no special focusing
operations need to be done before taking a picture.<wbr/></p>
<p>AF triggers are ignored,<wbr/> and the AF state will always be
INACTIVE.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether auto-focus (AF) is currently enabled,<wbr/> and what
mode it is set to.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.afAvailableModes">android.<wbr/>control.<wbr/>af<wbr/>Available<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> = AUTO and the lens is not fixed focus
(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/> Also note that
when <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is OFF,<wbr/> the behavior of AF is device
dependent.<wbr/> It is recommended to lock AF by using <a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a> before
setting <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> to OFF,<wbr/> or set AF mode to OFF when AE is OFF.<wbr/></p>
<p>If the lens is controlled by the camera device auto-focus algorithm,<wbr/>
the camera device will report the current AF status in <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a>
in result metadata.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When afMode is AUTO or MACRO,<wbr/> the lens must not move until an AF trigger is sent in a
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
up with either FOCUSED_<wbr/>LOCKED or NOT_<wbr/>FOCUSED_<wbr/>LOCKED state (see
<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
locked and will not move.<wbr/> If camera movement (e.<wbr/>g.<wbr/> tilting camera) causes the lens to move
after the lens is locked,<wbr/> the HAL must compensate this movement appropriately such that
the same focal plane remains in focus.<wbr/></p>
<p>When afMode is one of the continuous auto focus modes,<wbr/> the HAL is free to start a AF
scan whenever it's not locked.<wbr/> When the lens is locked after an AF trigger
(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
same lock behavior as above.<wbr/></p>
<p>When afMode is OFF,<wbr/> the application controls focus manually.<wbr/> The accuracy of the
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/>
However,<wbr/> the lens must not move regardless of the camera movement for any focus distance
manual control.<wbr/></p>
<p>To put this in concrete terms,<wbr/> if the camera has lens elements which may move based on
camera orientation or motion (e.<wbr/>g.<wbr/> due to gravity),<wbr/> then the HAL must drive the lens to
remain in a fixed position invariant to the camera's orientation or motion,<wbr/> for example,<wbr/>
by using accelerometer measurements in the lens control logic.<wbr/> This is a typical issue
that will arise on camera modules with open-loop VCMs.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.afRegions">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>af<wbr/>Regions
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  5 x area_count
                </span>
              <span class="entry_type_visibility"> [public as meteringRectangle]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of metering areas to use for auto-focus.<wbr/></p>
            </td>

            <td class="entry_units">
              Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
            </td>

            <td class="entry_range">
              <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Not available if <a href="#static_android.control.maxRegionsAf">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af</a> is 0.<wbr/>
Otherwise will always be present.<wbr/></p>
<p>The maximum number of focus areas supported by the device is determined by the value
of <a href="#static_android.control.maxRegionsAf">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af</a>.<wbr/></p>
<p>The coordinate system is based on the active pixel array,<wbr/>
with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
(<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
bottom-right pixel in the active pixel array.<wbr/></p>
<p>The weight must be within <code>[0,<wbr/> 1000]</code>,<wbr/> and represents a weight
for every pixel in the area.<wbr/> This means that a large metering area
with the same weight as a smaller area will have more effect in
the metering result.<wbr/> Metering areas can partially overlap and the
camera device will add the weights in the overlap region.<wbr/></p>
<p>The weights are relative to weights of other metering regions,<wbr/> so if only one region
is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with 0 weight is
ignored.<wbr/></p>
<p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
camera device.<wbr/></p>
<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
capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
region and output only the intersection rectangle as the metering region in the result
metadata.<wbr/> If the region is entirely outside the crop region,<wbr/> it will be ignored and
not reported in the result metadata.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The HAL level representation of MeteringRectangle[] is a
int[5 * area_<wbr/>count].<wbr/>
Every five elements represent a metering region of
(xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
exclusive on xmax and ymax.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.afTrigger">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>af<wbr/>Trigger
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">IDLE</span>
                    <span class="entry_type_enum_notes"><p>The trigger is idle.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">START</span>
                    <span class="entry_type_enum_notes"><p>Autofocus will trigger now.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CANCEL</span>
                    <span class="entry_type_enum_notes"><p>Autofocus will return to its initial
state,<wbr/> and cancel any currently active trigger.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether the camera device will trigger autofocus for this request.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This entry is normally set to IDLE,<wbr/> or is not
included at all in the request settings.<wbr/></p>
<p>When included and set to START,<wbr/> the camera device will trigger the
autofocus algorithm.<wbr/> If autofocus is disabled,<wbr/> this trigger has no effect.<wbr/></p>
<p>When set to CANCEL,<wbr/> the camera device will cancel any active trigger,<wbr/>
and return to its initial AF state.<wbr/></p>
<p>Generally,<wbr/> applications should set this entry to START or CANCEL for only a
single capture,<wbr/> and then return it to IDLE (or not set at all).<wbr/> Specifying
START for multiple captures in a row means restarting the AF operation over
and over again.<wbr/></p>
<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>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.awbLock">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>awb<wbr/>Lock
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public as boolean]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Auto-white balance lock is disabled; the AWB
algorithm is free to update its parameters if in AUTO
mode.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_notes"><p>Auto-white balance lock is enabled; the AWB
algorithm will not update its parameters while the lock
is active.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether auto-white balance (AWB) is currently locked to its
latest calculated values.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When set to <code>true</code> (ON),<wbr/> the AWB algorithm is locked to its latest parameters,<wbr/>
and will not change color balance settings until the lock is set to <code>false</code> (OFF).<wbr/></p>
<p>Since the camera device has a pipeline of in-flight requests,<wbr/> the settings that
get locked do not necessarily correspond to the settings that were present in the
latest capture result received from the camera device,<wbr/> since additional captures
and AWB updates may have occurred even before the result was sent out.<wbr/> If an
application is switching between automatic and manual control and wishes to eliminate
any flicker during the switch,<wbr/> the following procedure is recommended:</p>
<ol>
<li>Starting in auto-AWB mode:</li>
<li>Lock AWB</li>
<li>Wait for the first result to be output that has the AWB locked</li>
<li>Copy AWB settings from that result into a request,<wbr/> set the request to manual AWB</li>
<li>Submit the capture request,<wbr/> proceed to run manual AWB as desired.<wbr/></li>
</ol>
<p>Note that AWB lock is only meaningful when
<a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> is in the AUTO mode; in other modes,<wbr/>
AWB is already fixed to a specific setting.<wbr/></p>
<p>Some LEGACY devices may not support ON; the value is then overridden to OFF.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.awbMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>awb<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled.<wbr/></p>
<p>The application-selected color transform matrix
(<a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>) and gains
(<a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a>) are used by the camera
device for manual white balance control.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">AUTO</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is active.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">INCANDESCENT</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses incandescent light as the assumed scene
illumination for white balance.<wbr/></p>
<p>While the exact white balance transforms are up to the
camera device,<wbr/> they will approximately match the CIE
standard illuminant A.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FLUORESCENT</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses fluorescent light as the assumed scene
illumination for white balance.<wbr/></p>
<p>While the exact white balance transforms are up to the
camera device,<wbr/> they will approximately match the CIE
standard illuminant F2.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">WARM_FLUORESCENT</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses warm fluorescent light as the assumed scene
illumination for white balance.<wbr/></p>
<p>While the exact white balance transforms are up to the
camera device,<wbr/> they will approximately match the CIE
standard illuminant F4.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">DAYLIGHT</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses daylight light as the assumed scene
illumination for white balance.<wbr/></p>
<p>While the exact white balance transforms are up to the
camera device,<wbr/> they will approximately match the CIE
standard illuminant D65.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CLOUDY_DAYLIGHT</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses cloudy daylight light as the assumed scene
illumination for white balance.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">TWILIGHT</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses twilight light as the assumed scene
illumination for white balance.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SHADE</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses shade light as the assumed scene
illumination for white balance.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether auto-white balance (AWB) is currently setting the color
transform fields,<wbr/> and what its illumination target
is.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.awbAvailableModes">android.<wbr/>control.<wbr/>awb<wbr/>Available<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control is only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is AUTO.<wbr/></p>
<p>When set to the ON mode,<wbr/> the camera device's auto-white balance
routine is enabled,<wbr/> overriding the application's selected
<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
<a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a>.<wbr/> Note that when <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>
is OFF,<wbr/> the behavior of AWB is device dependent.<wbr/> It is recommened to
also set AWB mode to OFF or lock AWB by using <a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> before
setting AE mode to OFF.<wbr/></p>
<p>When set to the OFF mode,<wbr/> the camera device's auto-white balance
routine is disabled.<wbr/> The application manually controls the white
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>
and <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a>.<wbr/></p>
<p>When set to any other modes,<wbr/> the camera device's auto-white
balance routine is disabled.<wbr/> The camera device uses each
particular illumination target for white balance
adjustment.<wbr/> The application's values for
<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
<a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> are ignored.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.awbRegions">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>awb<wbr/>Regions
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  5 x area_count
                </span>
              <span class="entry_type_visibility"> [public as meteringRectangle]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of metering areas to use for auto-white-balance illuminant
estimation.<wbr/></p>
            </td>

            <td class="entry_units">
              Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
            </td>

            <td class="entry_range">
              <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Not available if <a href="#static_android.control.maxRegionsAwb">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb</a> is 0.<wbr/>
Otherwise will always be present.<wbr/></p>
<p>The maximum number of regions supported by the device is determined by the value
of <a href="#static_android.control.maxRegionsAwb">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb</a>.<wbr/></p>
<p>The coordinate system is based on the active pixel array,<wbr/>
with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
(<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
bottom-right pixel in the active pixel array.<wbr/></p>
<p>The weight must range from 0 to 1000,<wbr/> and represents a weight
for every pixel in the area.<wbr/> This means that a large metering area
with the same weight as a smaller area will have more effect in
the metering result.<wbr/> Metering areas can partially overlap and the
camera device will add the weights in the overlap region.<wbr/></p>
<p>The weights are relative to weights of other white balance metering regions,<wbr/> so if
only one region is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with
0 weight is ignored.<wbr/></p>
<p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
camera device.<wbr/></p>
<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
capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
region and output only the intersection rectangle as the metering region in the result
metadata.<wbr/>  If the region is entirely outside the crop region,<wbr/> it will be ignored and
not reported in the result metadata.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The HAL level representation of MeteringRectangle[] is a
int[5 * area_<wbr/>count].<wbr/>
Every five elements represent a metering region of
(xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
exclusive on xmax and ymax.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.captureIntent">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>capture<wbr/>Intent
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">CUSTOM</span>
                    <span class="entry_type_enum_notes"><p>The goal of this request doesn't fall into the other
categories.<wbr/> The camera device will default to preview-like
behavior.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PREVIEW</span>
                    <span class="entry_type_enum_notes"><p>This request is for a preview-like use case.<wbr/></p>
<p>The precapture trigger may be used to start off a metering
w/<wbr/>flash sequence.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">STILL_CAPTURE</span>
                    <span class="entry_type_enum_notes"><p>This request is for a still capture-type
use case.<wbr/></p>
<p>If the flash unit is under automatic control,<wbr/> it may fire as needed.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">VIDEO_RECORD</span>
                    <span class="entry_type_enum_notes"><p>This request is for a video recording
use case.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">VIDEO_SNAPSHOT</span>
                    <span class="entry_type_enum_notes"><p>This request is for a video snapshot (still
image while recording video) use case.<wbr/></p>
<p>The camera device should take the highest-quality image
possible (given the other settings) without disrupting the
frame rate of video recording.<wbr/>  </p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ZERO_SHUTTER_LAG</span>
                    <span class="entry_type_enum_notes"><p>This request is for a ZSL usecase; the
application will stream full-resolution images and
reprocess one or several later for a final
capture.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">MANUAL</span>
                    <span class="entry_type_enum_notes"><p>This request is for manual capture use case where
the applications want to directly control the capture parameters.<wbr/></p>
<p>For example,<wbr/> the application may wish to manually control
<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>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Information to the camera device 3A (auto-exposure,<wbr/>
auto-focus,<wbr/> auto-white balance) routines about the purpose
of this capture,<wbr/> to help the camera device to decide optimal 3A
strategy.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control (except for MANUAL) is only effective if
<code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> != OFF</code> and any 3A routine is active.<wbr/></p>
<p>ZERO_<wbr/>SHUTTER_<wbr/>LAG will be supported if <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
contains ZSL.<wbr/> MANUAL will be supported if <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
contains MANUAL_<wbr/>SENSOR.<wbr/> Other intent values are always supported.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.effectMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>effect<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No color effect will be applied.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">MONO</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "monocolor" effect where the image is mapped into
a single color.<wbr/></p>
<p>This will typically be grayscale.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">NEGATIVE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "photo-negative" effect where the image's colors
are inverted.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SOLARIZE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "solarisation" effect (Sabattier effect) where the
image is wholly or partially reversed in
tone.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SEPIA</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "sepia" effect where the image is mapped into warm
gray,<wbr/> red,<wbr/> and brown tones.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">POSTERIZE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "posterization" effect where the image uses
discrete regions of tone rather than a continuous
gradient of tones.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">WHITEBOARD</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "whiteboard" effect where the image is typically displayed
as regions of white,<wbr/> with black or grey details.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">BLACKBOARD</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "blackboard" effect where the image is typically displayed
as regions of black,<wbr/> with white or grey details.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">AQUA</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>An "aqua" effect where a blue hue is added to the image.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A special color effect to apply.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.availableEffects">android.<wbr/>control.<wbr/>available<wbr/>Effects</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When this mode is set,<wbr/> a color effect will be applied
to images produced by the camera device.<wbr/> The interpretation
and implementation of these color effects is left to the
implementor of the camera device,<wbr/> and should not be
depended on to be consistent (or present) across all
devices.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Full application control of pipeline.<wbr/></p>
<p>All control by the device's metering and focusing (3A)
routines is disabled,<wbr/> and no other settings in
android.<wbr/>control.<wbr/>* have any effect,<wbr/> except that
<a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> may be used by the camera
device to select post-processing values for processing
blocks that do not allow for manual control,<wbr/> or are not
exposed by the camera API.<wbr/></p>
<p>However,<wbr/> the camera device's 3A routines may continue to
collect statistics and update their internal state so that
when control is switched to AUTO mode,<wbr/> good control values
can be immediately applied.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">AUTO</span>
                    <span class="entry_type_enum_notes"><p>Use settings for each individual 3A routine.<wbr/></p>
<p>Manual control of capture parameters is disabled.<wbr/> All
controls in android.<wbr/>control.<wbr/>* besides sceneMode take
effect.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">USE_SCENE_MODE</span>
                    <span class="entry_type_enum_notes"><p>Use a specific scene mode.<wbr/></p>
<p>Enabling this disables control.<wbr/>aeMode,<wbr/> control.<wbr/>awbMode and
control.<wbr/>afMode controls; the camera device will ignore
those settings while USE_<wbr/>SCENE_<wbr/>MODE is active (except for
FACE_<wbr/>PRIORITY scene mode).<wbr/> Other control entries are still
active.<wbr/>  This setting can only be used if scene mode is
supported (i.<wbr/>e.<wbr/> <a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a>
contain some modes other than DISABLED).<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">OFF_KEEP_STATE</span>
                    <span class="entry_type_enum_notes"><p>Same as OFF mode,<wbr/> except that this capture will not be
used by camera device background auto-exposure,<wbr/> auto-white balance and
auto-focus algorithms (3A) to update their statistics.<wbr/></p>
<p>Specifically,<wbr/> the 3A routines are locked to the last
values set from a request with AUTO,<wbr/> OFF,<wbr/> or
USE_<wbr/>SCENE_<wbr/>MODE,<wbr/> and any statistics or state updates
collected from manual captures with OFF_<wbr/>KEEP_<wbr/>STATE will be
discarded by the camera device.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Overall mode of 3A (auto-exposure,<wbr/> auto-white-balance,<wbr/> auto-focus) control
routines.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This is a top-level 3A control switch.<wbr/> When set to OFF,<wbr/> all 3A control
by the camera device is disabled.<wbr/> The application must set the fields for
capture parameters itself.<wbr/></p>
<p>When set to AUTO,<wbr/> the individual algorithm controls in
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>
<p>When set to USE_<wbr/>SCENE_<wbr/>MODE,<wbr/> the individual controls in
android.<wbr/>control.<wbr/>* are mostly disabled,<wbr/> and the camera device implements
one of the scene mode settings (such as ACTION,<wbr/> SUNSET,<wbr/> or PARTY)
as it wishes.<wbr/> The camera device scene mode 3A settings are provided by
<a href="#static_android.control.sceneModeOverrides">android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides</a>.<wbr/></p>
<p>When set to OFF_<wbr/>KEEP_<wbr/>STATE,<wbr/> it is similar to OFF mode,<wbr/> the only difference
is that this frame will not be used by camera device background 3A statistics
update,<wbr/> as if this frame is never captured.<wbr/> This mode can be used in the scenario
where the application doesn't want a 3A manual control capture to affect
the subsequent auto 3A capture results.<wbr/></p>
<p>LEGACY mode devices will only support AUTO and USE_<wbr/>SCENE_<wbr/>MODE modes.<wbr/>
LIMITED mode devices will only support OFF and OFF_<wbr/>KEEP_<wbr/>STATE if they
support the MANUAL_<wbr/>SENSOR and MANUAL_<wbr/>POST_<wbr/>PROCSESING capabilities.<wbr/>
FULL mode devices will always support OFF and OFF_<wbr/>KEEP_<wbr/>STATE.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.sceneMode">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>scene<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">DISABLED</span>
                    <span class="entry_type_enum_value">0</span>
                    <span class="entry_type_enum_notes"><p>Indicates that no scene modes are set for a given capture request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FACE_PRIORITY</span>
                    <span class="entry_type_enum_notes"><p>If face detection support exists,<wbr/> use face
detection data for auto-focus,<wbr/> auto-white balance,<wbr/> and
auto-exposure routines.<wbr/></p>
<p>If face detection statistics are disabled
(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/>
this should still operate correctly (but will not return
face detection statistics to the framework).<wbr/></p>
<p>Unlike the other scene modes,<wbr/> <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/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>
remain active when FACE_<wbr/>PRIORITY is set.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ACTION</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for photos of quickly moving objects.<wbr/></p>
<p>Similar to SPORTS.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PORTRAIT</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for still photos of people.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">LANDSCAPE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for photos of distant macroscopic objects.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">NIGHT</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for low-light settings.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">NIGHT_PORTRAIT</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for still photos of people in low-light
settings.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">THEATRE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for dim,<wbr/> indoor settings where flash must
remain off.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">BEACH</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for bright,<wbr/> outdoor beach settings.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SNOW</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for bright,<wbr/> outdoor settings containing snow.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SUNSET</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for scenes of the setting sun.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">STEADYPHOTO</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized to avoid blurry photos due to small amounts of
device motion (for example: due to hand shake).<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FIREWORKS</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for nighttime photos of fireworks.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SPORTS</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for photos of quickly moving people.<wbr/></p>
<p>Similar to ACTION.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PARTY</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for dim,<wbr/> indoor settings with multiple moving
people.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CANDLELIGHT</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for dim settings where the main light source
is a flame.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">BARCODE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for accurately capturing a photo of barcode
for use by camera applications that wish to read the
barcode value.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_SPEED_VIDEO</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for high speed video recording (frame rate &gt;=60fps) use case.<wbr/></p>
<p>The supported high speed video sizes and fps ranges are specified in
<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/> To get desired
output frame rates,<wbr/> the application is only allowed to select video size
and fps range combinations listed in this static metadata.<wbr/> The fps range
can be control via <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a>.<wbr/></p>
<p>In this mode,<wbr/> the camera device will override aeMode,<wbr/> awbMode,<wbr/> and afMode to
ON,<wbr/> ON,<wbr/> and CONTINUOUS_<wbr/>VIDEO,<wbr/> respectively.<wbr/> All post-processing block mode
controls will be overridden to be FAST.<wbr/> Therefore,<wbr/> no manual control of capture
and post-processing parameters is possible.<wbr/> All other controls operate the
same as when <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == AUTO.<wbr/> This means that all other
android.<wbr/>control.<wbr/>* fields continue to work,<wbr/> such as</p>
<ul>
<li><a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a></li>
<li><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a></li>
<li><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a></li>
<li><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a></li>
<li><a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a></li>
<li><a href="#controls_android.control.aeRegions">android.<wbr/>control.<wbr/>ae<wbr/>Regions</a></li>
<li><a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a></li>
<li><a href="#controls_android.control.awbRegions">android.<wbr/>control.<wbr/>awb<wbr/>Regions</a></li>
<li><a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a></li>
<li><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a></li>
</ul>
<p>Outside of android.<wbr/>control.<wbr/>*,<wbr/> the following controls will work:</p>
<ul>
<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>
<li><a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a> (if it is supported)</li>
<li><a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a></li>
<li><a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a></li>
</ul>
<p>For high speed recording use case,<wbr/> the actual maximum supported frame rate may
be lower than what camera can output,<wbr/> depending on the destination Surfaces for
the image data.<wbr/> For example,<wbr/> if the destination surface is from video encoder,<wbr/>
the application need check if the video encoder is capable of supporting the
high frame rate for a given video size,<wbr/> or it will end up with lower recording
frame rate.<wbr/> If the destination surface is from preview window,<wbr/> the preview frame
rate will be bounded by the screen refresh rate.<wbr/></p>
<p>The camera device will only support up to 2 output high speed streams
(processed non-stalling format defined in <a href="#static_android.request.maxNumOutputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams</a>)
in this mode.<wbr/> This control will be effective only if all of below conditions are true:</p>
<ul>
<li>The application created no more than maxNumHighSpeedStreams processed non-stalling
format output streams,<wbr/> where maxNumHighSpeedStreams is calculated as
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>
<li>The stream sizes are selected from the sizes reported by
<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/></li>
<li>No processed non-stalling or raw streams are configured.<wbr/></li>
</ul>
<p>When above conditions are NOT satistied,<wbr/> the controls of this mode and
<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/>
the camera device will fall back to <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> <code>==</code> AUTO,<wbr/>
and the returned capture result metadata will give the fps range choosen
by the camera device.<wbr/></p>
<p>Switching into or out of this mode may trigger some camera ISP/<wbr/>sensor
reconfigurations,<wbr/> which may introduce extra latency.<wbr/> It is recommended that
the application avoids unnecessary scene mode switch as much as possible.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HDR</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Turn on a device-specific high dynamic range (HDR) mode.<wbr/></p>
<p>In this scene mode,<wbr/> the camera device captures images
that keep a larger range of scene illumination levels
visible in the final image.<wbr/> For example,<wbr/> when taking a
picture of a object in front of a bright window,<wbr/> both
the object and the scene through the window may be
visible when using HDR mode,<wbr/> while in normal AUTO mode,<wbr/>
one or the other may be poorly exposed.<wbr/> As a tradeoff,<wbr/>
HDR mode generally takes much longer to capture a single
image,<wbr/> has no user control,<wbr/> and may have other artifacts
depending on the HDR method used.<wbr/></p>
<p>Therefore,<wbr/> HDR captures operate at a much slower rate
than regular captures.<wbr/></p>
<p>In this mode,<wbr/> on LIMITED or FULL devices,<wbr/> when a request
is made with a <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> of
STILL_<wbr/>CAPTURE,<wbr/> the camera device will capture an image
using a high dynamic range capture technique.<wbr/>  On LEGACY
devices,<wbr/> captures that target a JPEG-format output will
be captured with HDR,<wbr/> and the capture intent is not
relevant.<wbr/></p>
<p>The HDR capture may involve the device capturing a burst
of images internally and combining them into one,<wbr/> or it
may involve the device using specialized high dynamic
range capture hardware.<wbr/> In all cases,<wbr/> a single image is
produced in response to a capture request submitted
while in HDR mode.<wbr/></p>
<p>Since substantial post-processing is generally needed to
produce an HDR image,<wbr/> only YUV and JPEG outputs are
supported for LIMITED/<wbr/>FULL device HDR captures,<wbr/> and only
JPEG outputs are supported for LEGACY HDR
captures.<wbr/> Using a RAW output for HDR capture is not
supported.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Control for which scene mode is currently active.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Scene modes are custom camera modes optimized for a certain set of conditions and
capture settings.<wbr/></p>
<p>This is the mode that that is active when
<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/>
these modes will disable <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/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> while in use.<wbr/></p>
<p>The interpretation and implementation of these scene modes is left
to the implementor of the camera device.<wbr/> Their behavior will not be
consistent across all devices,<wbr/> and any given device may only implement
a subset of these modes.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>HAL implementations that include scene modes are expected to provide
the per-scene settings to use for <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/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> in
<a href="#static_android.control.sceneModeOverrides">android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides</a>.<wbr/></p>
<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/>
the HAL must list supported video size and fps range in
<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/>
1280x720,<wbr/> if the HAL has two different sensor configurations for normal streaming
mode and high speed streaming,<wbr/> when this scene mode is set/<wbr/>reset in a sequence of capture
requests,<wbr/> the HAL may have to switch between different sensor modes.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.control.videoStabilizationMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Video stabilization is disabled.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_notes"><p>Video stabilization is enabled.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether video stabilization is
active.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Video stabilization automatically translates and scales images from
the camera in order to stabilize motion between consecutive frames.<wbr/></p>
<p>If enabled,<wbr/> video stabilization can modify the
<a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> to keep the video stream stabilized.<wbr/></p>
<p>Switching between different video stabilization modes may take several
frames to initialize,<wbr/> the camera device will report the current mode
in capture result metadata.<wbr/> For example,<wbr/> When "ON" mode is requested,<wbr/>
the video stabilization modes in the first several capture results may
still be "OFF",<wbr/> and it will become "ON" when the initialization is
done.<wbr/></p>
<p>If a camera device supports both this mode and OIS
(<a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> turning both modes on may
produce undesirable interaction,<wbr/> so it is recommended not to enable
both at the same time.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.control.aeAvailableAntibandingModes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">list of enums</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <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
supported by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Not all of the auto-exposure anti-banding modes may be
supported by a given camera device.<wbr/> This field lists the
valid anti-banding modes that the application may request
for this camera device with the
<a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a> control.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.aeAvailableModes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">list of enums</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <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
device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Not all the auto-exposure modes may be supported by a
given camera device,<wbr/> especially if no flash unit is
available.<wbr/> This entry lists the valid modes for
<a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> for this camera device.<wbr/></p>
<p>All camera devices support ON,<wbr/> and all camera devices with flash
units support ON_<wbr/>AUTO_<wbr/>FLASH and ON_<wbr/>ALWAYS_<wbr/>FLASH.<wbr/></p>
<p>FULL mode camera devices always support OFF mode,<wbr/>
which enables application control of camera exposure time,<wbr/>
sensitivity,<wbr/> and frame duration.<wbr/></p>
<p>LEGACY mode camera devices never support OFF mode.<wbr/>
LIMITED mode devices support OFF if they support the MANUAL_<wbr/>SENSOR
capability.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.aeAvailableTargetFpsRanges">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Target<wbr/>Fps<wbr/>Ranges
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2 x n
                </span>
              <span class="entry_type_visibility"> [public as rangeInt]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">list of pairs of frame rates</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <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
this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
              Frames per second (FPS)
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For devices at the LIMITED level or above,<wbr/> this list will include at least (30,<wbr/> 30) for
constant-framerate recording.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.aeCompensationRange">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [public as rangeInt]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Maximum and minimum exposure compensation values for
<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/>
that are supported by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Range [0,<wbr/>0] indicates that exposure compensation is not supported.<wbr/></p>
<p>For LIMITED and FULL devices,<wbr/> range must follow below requirements if exposure
compensation is supported (<code>range != [0,<wbr/> 0]</code>):</p>
<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>
<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>
<p>LEGACY devices may support a smaller range than this.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.aeCompensationStep">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step
            </td>
            <td class="entry_type">
                <span class="entry_type_name">rational</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Smallest step by which the exposure compensation
can be changed.<wbr/></p>
            </td>

            <td class="entry_units">
              Exposure Value (EV)
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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
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
that the target EV offset for the auto-exposure routine is -1 EV.<wbr/></p>
<p>One unit of EV compensation changes the brightness of the captured image by a factor
of two.<wbr/> +1 EV doubles the image brightness,<wbr/> while -1 EV halves the image brightness.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This must be less than or equal to 1/<wbr/>2.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.afAvailableModes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>af<wbr/>Available<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">List of enums</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of auto-focus (AF) modes for <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> that are
supported by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Not all the auto-focus modes may be supported by a
given camera device.<wbr/> This entry lists the valid modes for
<a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> for this camera device.<wbr/></p>
<p>All LIMITED and FULL mode camera devices will support OFF mode,<wbr/> and all
camera devices with adjustable focuser units
(<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>
<p>LEGACY devices will support OFF mode only if they support
focusing to infinity (by also setting <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> to
<code>0.<wbr/>0f</code>).<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.availableEffects">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>available<wbr/>Effects
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">List of enums (android.<wbr/>control.<wbr/>effect<wbr/>Mode).<wbr/></div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <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
device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This list contains the color effect modes that can be applied to
images produced by the camera device.<wbr/>
Implementations are not expected to be consistent across all devices.<wbr/>
If no color effect modes are available for a device,<wbr/> this will only list
OFF.<wbr/></p>
<p>A color effect will only be applied if
<a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> != OFF.<wbr/>  OFF is always included in this list.<wbr/></p>
<p>This control has no effect on the operation of other control routines such
as auto-exposure,<wbr/> white balance,<wbr/> or focus.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.availableSceneModes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">List of enums (android.<wbr/>control.<wbr/>scene<wbr/>Mode).<wbr/></div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <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
device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This list contains scene modes that can be set for the camera device.<wbr/>
Only scene modes that have been fully implemented for the
camera device may be included here.<wbr/> Implementations are not expected
to be consistent across all devices.<wbr/></p>
<p>If no scene modes are supported by the camera device,<wbr/> this
will be set to DISABLED.<wbr/> Otherwise DISABLED will not be listed.<wbr/></p>
<p>FACE_<wbr/>PRIORITY is always listed if face detection is
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;
0</code>).<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.availableVideoStabilizationModes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>available<wbr/>Video<wbr/>Stabilization<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">List of enums.<wbr/></div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of video stabilization modes for <a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>
that are supported by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>OFF will always be listed.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.awbAvailableModes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>awb<wbr/>Available<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">List of enums</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <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
camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Not all the auto-white-balance modes may be supported by a
given camera device.<wbr/> This entry lists the valid modes for
<a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> for this camera device.<wbr/></p>
<p>All camera devices will support ON mode.<wbr/></p>
<p>Camera devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability will always support OFF
mode,<wbr/> which enables application control of white balance,<wbr/> by using
<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
mode camera devices.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.maxRegions">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>control.<wbr/>max<wbr/>Regions
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of the maximum number of regions that can be used for metering in
auto-exposure (AE),<wbr/> auto-white balance (AWB),<wbr/> and auto-focus (AF);
this corresponds to the the maximum number of elements in
<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/>
and <a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a>.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Value must be &gt;= 0 for each element.<wbr/> For full-capability devices
this value must be &gt;= 1 for AE and AF.<wbr/> The order of the elements is:
<code>(AE,<wbr/> AWB,<wbr/> AF)</code>.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.maxRegionsAe">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>

              <span class="entry_type_synthetic">[synthetic] </span>

              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The maximum number of metering regions that can be used by the auto-exposure (AE)
routine.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Value will be &gt;= 0.<wbr/> For FULL-capability devices,<wbr/> this
value will be &gt;= 1.<wbr/></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This corresponds to the the maximum allowed number of elements in
<a href="#controls_android.control.aeRegions">android.<wbr/>control.<wbr/>ae<wbr/>Regions</a>.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This entry is private to the framework.<wbr/> Fill in
maxRegions to have this entry be automatically populated.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.maxRegionsAwb">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>

              <span class="entry_type_synthetic">[synthetic] </span>

              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The maximum number of metering regions that can be used by the auto-white balance (AWB)
routine.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Value will be &gt;= 0.<wbr/></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This corresponds to the the maximum allowed number of elements in
<a href="#controls_android.control.awbRegions">android.<wbr/>control.<wbr/>awb<wbr/>Regions</a>.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This entry is private to the framework.<wbr/> Fill in
maxRegions to have this entry be automatically populated.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.maxRegionsAf">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>

              <span class="entry_type_synthetic">[synthetic] </span>

              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The maximum number of metering regions that can be used by the auto-focus (AF) routine.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Value will be &gt;= 0.<wbr/> For FULL-capability devices,<wbr/> this
value will be &gt;= 1.<wbr/></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This corresponds to the the maximum allowed number of elements in
<a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a>.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This entry is private to the framework.<wbr/> Fill in
maxRegions to have this entry be automatically populated.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.sceneModeOverrides">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3 x length(availableSceneModes)
                </span>
              <span class="entry_type_visibility"> [system]</span>


              <span class="entry_type_hwlevel">[limited] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Ordered list of auto-exposure,<wbr/> auto-white balance,<wbr/> and auto-focus
settings to use with each available scene mode.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>For each available scene mode,<wbr/> the list must contain three
entries containing the <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/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> values used
by the camera device.<wbr/> The entry order is <code>(aeMode,<wbr/> awbMode,<wbr/> afMode)</code>
where aeMode has the lowest index position.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When a scene mode is enabled,<wbr/> the camera device is expected
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/>
and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> with its preferred settings for
that scene mode.<wbr/></p>
<p>The order of this list matches that of availableSceneModes,<wbr/>
with 3 entries for each mode.<wbr/>  The overrides listed
for FACE_<wbr/>PRIORITY are ignored,<wbr/> since for that
mode the application-set <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/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> values are
used instead,<wbr/> matching the behavior when <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a>
is set to AUTO.<wbr/> It is recommended that the FACE_<wbr/>PRIORITY
overrides should be set to 0.<wbr/></p>
<p>For example,<wbr/> if availableSceneModes contains
<code>(FACE_<wbr/>PRIORITY,<wbr/> ACTION,<wbr/> NIGHT)</code>,<wbr/>  then the camera framework
expects sceneModeOverrides to have 9 entries formatted like:
<code>(0,<wbr/> 0,<wbr/> 0,<wbr/> ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/> AUTO,<wbr/> CONTINUOUS_<wbr/>PICTURE,<wbr/>
ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/> INCANDESCENT,<wbr/> AUTO)</code>.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>To maintain backward compatibility,<wbr/> this list will be made available
in the static metadata of the camera service.<wbr/>  The camera service will
use these values to set <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/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> when using a scene
mode other than FACE_<wbr/>PRIORITY.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.control.availableHighSpeedVideoConfigurations">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4 x n
                </span>
              <span class="entry_type_visibility"> [hidden as highSpeedVideoConfiguration]</span>


              <span class="entry_type_hwlevel">[limited] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of available high speed video size and fps range configurations
supported by the camera device,<wbr/> in the format of (width,<wbr/> height,<wbr/> fps_<wbr/>min,<wbr/> fps_<wbr/>max).<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>For each configuration,<wbr/> the fps_<wbr/>max &gt;= 60fps.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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/>
this metadata will list the supported high speed video size and fps range
configurations.<wbr/> All the sizes listed in this configuration will be a subset
of the sizes reported by StreamConfigurationMap#getOutputSizes for processed
non-stalling formats.<wbr/></p>
<p>For the high speed video use case,<wbr/> where the application will set
<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
select the video size and fps range from this metadata to configure the recording and
preview streams and setup the recording requests.<wbr/> For example,<wbr/> if the application intends
to do high speed recording,<wbr/> it can select the maximum size reported by this metadata to
configure output streams.<wbr/> Once the size is selected,<wbr/> application can filter this metadata
by selected size and get the supported fps ranges,<wbr/> and use these fps ranges to setup the
recording requests.<wbr/> Note that for the use case of multiple output streams,<wbr/> application
must select one unique size from this metadata to use.<wbr/> Otherwise a request error might
occur.<wbr/></p>
<p>For normal video recording use case,<wbr/> where some application will NOT set
<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
reported in this metadata must not be used to setup capture requests,<wbr/> or it will cause
request error.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>All the sizes listed in this configuration will be a subset of the sizes reported by
<a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a> for processed non-stalling output formats.<wbr/>
Note that for all high speed video configurations,<wbr/> HAL must be able to support a minimum
of two streams,<wbr/> though the application might choose to configure just one stream.<wbr/></p>
<p>Since the HIGH_<wbr/>SPEED_<wbr/>VIDEO mode may be turned on for preview view only case,<wbr/> the preview
fps is bounded by device refresh rate (e.<wbr/>g.<wbr/> 60fps).<wbr/> For a given resolution,<wbr/> it is
recommended that this list includes some fps ranges (e.<wbr/>g.<wbr/> [30,<wbr/> 60]) that is suitable
for preview only streaming case.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.control.aePrecaptureId">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Id
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [system]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The ID sent with the latest
CAMERA2_<wbr/>TRIGGER_<wbr/>PRECAPTURE_<wbr/>METERING call</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Must be 0 if no
CAMERA2_<wbr/>TRIGGER_<wbr/>PRECAPTURE_<wbr/>METERING trigger received yet
by HAL.<wbr/> Always updated even if AE algorithm ignores the
trigger</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.aeAntibandingMode">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>The camera device will not adjust exposure duration to
avoid banding problems.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">50HZ</span>
                    <span class="entry_type_enum_notes"><p>The camera device will adjust exposure duration to
avoid banding problems with 50Hz illumination sources.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">60HZ</span>
                    <span class="entry_type_enum_notes"><p>The camera device will adjust exposure duration to
avoid banding problems with 60Hz illumination
sources.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">AUTO</span>
                    <span class="entry_type_enum_notes"><p>The camera device will automatically adapt its
antibanding routine to the current illumination
condition.<wbr/> This is the default mode if AUTO is
available on given camera device.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired setting for the camera device's auto-exposure
algorithm's antibanding compensation.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.aeAvailableAntibandingModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Some kinds of lighting fixtures,<wbr/> such as some fluorescent
lights,<wbr/> flicker at the rate of the power supply frequency
(60Hz or 50Hz,<wbr/> depending on country).<wbr/> While this is
typically not noticeable to a person,<wbr/> it can be visible to
a camera device.<wbr/> If a camera sets its exposure time to the
wrong value,<wbr/> the flicker may become visible in the
viewfinder as flicker or in a final captured image,<wbr/> as a
set of variable-brightness bands across the image.<wbr/></p>
<p>Therefore,<wbr/> the auto-exposure routines of camera devices
include antibanding routines that ensure that the chosen
exposure value will not cause such banding.<wbr/> The choice of
exposure time depends on the rate of flicker,<wbr/> which the
camera device can detect automatically,<wbr/> or the expected
rate can be selected by the application using this
control.<wbr/></p>
<p>A given camera device may not support all of the possible
options for the antibanding mode.<wbr/> The
<a href="#static_android.control.aeAvailableAntibandingModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes</a> key contains
the available modes for a given camera device.<wbr/></p>
<p>AUTO mode is the default if it is available on given
camera device.<wbr/> When AUTO mode is not available,<wbr/> the
default will be either 50HZ or 60HZ,<wbr/> and both 50HZ
and 60HZ will be available.<wbr/></p>
<p>If manual exposure control is enabled (by setting
<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/>
then this setting has no effect,<wbr/> and the application must
ensure it selects exposure times that do not cause banding
issues.<wbr/> The <a href="#dynamic_android.statistics.sceneFlicker">android.<wbr/>statistics.<wbr/>scene<wbr/>Flicker</a> key can assist
the application in this.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For all capture request templates,<wbr/> this field must be set
to AUTO if AUTO mode is available.<wbr/> If AUTO is not available,<wbr/>
the default must be either 50HZ or 60HZ,<wbr/> and both 50HZ and
60HZ must be available.<wbr/></p>
<p>If manual exposure control is enabled (by setting
<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/>
then the exposure values provided by the application must not be
adjusted for antibanding.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.aeExposureCompensation">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Adjustment to auto-exposure (AE) target image
brightness.<wbr/></p>
            </td>

            <td class="entry_units">
              Compensation steps
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.aeCompensationRange">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The adjustment is measured as a count of steps,<wbr/> with the
step size defined by <a href="#static_android.control.aeCompensationStep">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step</a> and the
allowed range by <a href="#static_android.control.aeCompensationRange">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range</a>.<wbr/></p>
<p>For example,<wbr/> if the exposure value (EV) step is 0.<wbr/>333,<wbr/> '6'
will mean an exposure compensation of +2 EV; -3 will mean an
exposure compensation of -1 EV.<wbr/> One EV represents a doubling
of image brightness.<wbr/> Note that this control will only be
effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>!=</code> OFF.<wbr/> This control
will take effect even when <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> <code>== true</code>.<wbr/></p>
<p>In the event of exposure compensation value being changed,<wbr/> camera device
may take several frames to reach the newly requested exposure target.<wbr/>
During that time,<wbr/> <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> field will be in the SEARCHING
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
change from SEARCHING to either CONVERGED,<wbr/> LOCKED (if AE lock is enabled),<wbr/> or
FLASH_<wbr/>REQUIRED (if the scene is too dark for still capture).<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.aeLock">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Lock
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public as boolean]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Auto-exposure lock is disabled; the AE algorithm
is free to update its parameters.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_notes"><p>Auto-exposure lock is enabled; the AE algorithm
must not update the exposure and sensitivity parameters
while the lock is active.<wbr/></p>
<p><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a> setting changes
will still take effect while auto-exposure is locked.<wbr/></p>
<p>Some rare LEGACY devices may not support
this,<wbr/> in which case the value will always be overridden to OFF.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether auto-exposure (AE) is currently locked to its latest
calculated values.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When set to <code>true</code> (ON),<wbr/> the AE algorithm is locked to its latest parameters,<wbr/>
and will not change exposure settings until the lock is set to <code>false</code> (OFF).<wbr/></p>
<p>Note that even when AE is locked,<wbr/> the flash may be fired if
the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is ON_<wbr/>AUTO_<wbr/>FLASH /<wbr/>
ON_<wbr/>ALWAYS_<wbr/>FLASH /<wbr/> ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE.<wbr/></p>
<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
is ON,<wbr/> the camera device will still adjust its exposure value.<wbr/></p>
<p>If AE precapture is triggered (see <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>)
when AE is already locked,<wbr/> the camera device will not change the exposure time
(<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>)
parameters.<wbr/> The flash may be fired if the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>
is ON_<wbr/>AUTO_<wbr/>FLASH/<wbr/>ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE and the scene is too dark.<wbr/> If the
<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>
<p>Since the camera device has a pipeline of in-flight requests,<wbr/> the settings that
get locked do not necessarily correspond to the settings that were present in the
latest capture result received from the camera device,<wbr/> since additional captures
and AE updates may have occurred even before the result was sent out.<wbr/> If an
application is switching between automatic and manual control and wishes to eliminate
any flicker during the switch,<wbr/> the following procedure is recommended:</p>
<ol>
<li>Starting in auto-AE mode:</li>
<li>Lock AE</li>
<li>Wait for the first result to be output that has the AE locked</li>
<li>Copy exposure settings from that result into a request,<wbr/> set the request to manual AE</li>
<li>Submit the capture request,<wbr/> proceed to run manual AE as desired.<wbr/></li>
</ol>
<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>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.aeMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>The camera device's autoexposure routine is disabled.<wbr/></p>
<p>The application-selected <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> and
<a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> are used by the camera
device,<wbr/> along with android.<wbr/>flash.<wbr/>* fields,<wbr/> if there's
a flash unit for this camera device.<wbr/></p>
<p>Note that auto-white balance (AWB) and auto-focus (AF)
behavior is device dependent when AE is in OFF mode.<wbr/>
To have consistent behavior across different devices,<wbr/>
it is recommended to either set AWB and AF to OFF mode
or lock AWB and AF before setting AE to OFF.<wbr/>
See <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>,<wbr/>
<a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a>,<wbr/> and <a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>
for more details.<wbr/></p>
<p>LEGACY devices do not support the OFF mode and will
override attempts to use this value to ON.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_notes"><p>The camera device's autoexposure routine is active,<wbr/>
with no flash control.<wbr/></p>
<p>The application's values for
<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/> and
<a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> are ignored.<wbr/> The
application has control over the various
android.<wbr/>flash.<wbr/>* fields.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON_AUTO_FLASH</span>
                    <span class="entry_type_enum_notes"><p>Like ON,<wbr/> except that the camera device also controls
the camera's flash unit,<wbr/> firing it in low-light
conditions.<wbr/></p>
<p>The flash may be fired during a precapture sequence
(triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>) and
may be fired for captures for which the
<a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> field is set to
STILL_<wbr/>CAPTURE</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON_ALWAYS_FLASH</span>
                    <span class="entry_type_enum_notes"><p>Like ON,<wbr/> except that the camera device also controls
the camera's flash unit,<wbr/> always firing it for still
captures.<wbr/></p>
<p>The flash may be fired during a precapture sequence
(triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>) and
will always be fired for captures for which the
<a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> field is set to
STILL_<wbr/>CAPTURE</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON_AUTO_FLASH_REDEYE</span>
                    <span class="entry_type_enum_notes"><p>Like ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/> but with automatic red eye
reduction.<wbr/></p>
<p>If deemed necessary by the camera device,<wbr/> a red eye
reduction flash will fire during the precapture
sequence.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired mode for the camera device's
auto-exposure routine.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.aeAvailableModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control is only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is
AUTO.<wbr/></p>
<p>When set to any of the ON modes,<wbr/> the camera device's
auto-exposure routine is enabled,<wbr/> overriding the
application's selected exposure time,<wbr/> sensor sensitivity,<wbr/>
and frame duration (<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/> and
<a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>).<wbr/> If one of the FLASH modes
is selected,<wbr/> the camera device's flash unit controls are
also overridden.<wbr/></p>
<p>The FLASH modes are only available if the camera device
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>
<p>If flash TORCH mode is desired,<wbr/> this field must be set to
ON or OFF,<wbr/> and <a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> set to TORCH.<wbr/></p>
<p>When set to any of the ON modes,<wbr/> the values chosen by the
camera device auto-exposure routine for the overridden
fields for a given capture will be available in its
CaptureResult.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.aeRegions">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>ae<wbr/>Regions
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  5 x area_count
                </span>
              <span class="entry_type_visibility"> [public as meteringRectangle]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of metering areas to use for auto-exposure adjustment.<wbr/></p>
            </td>

            <td class="entry_units">
              Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
            </td>

            <td class="entry_range">
              <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Not available if <a href="#static_android.control.maxRegionsAe">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae</a> is 0.<wbr/>
Otherwise will always be present.<wbr/></p>
<p>The maximum number of regions supported by the device is determined by the value
of <a href="#static_android.control.maxRegionsAe">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae</a>.<wbr/></p>
<p>The coordinate system is based on the active pixel array,<wbr/>
with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
(<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
bottom-right pixel in the active pixel array.<wbr/></p>
<p>The weight must be within <code>[0,<wbr/> 1000]</code>,<wbr/> and represents a weight
for every pixel in the area.<wbr/> This means that a large metering area
with the same weight as a smaller area will have more effect in
the metering result.<wbr/> Metering areas can partially overlap and the
camera device will add the weights in the overlap region.<wbr/></p>
<p>The weights are relative to weights of other exposure metering regions,<wbr/> so if only one
region is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with 0
weight is ignored.<wbr/></p>
<p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
camera device.<wbr/></p>
<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
capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
region and output only the intersection rectangle as the metering region in the result
metadata.<wbr/>  If the region is entirely outside the crop region,<wbr/> it will be ignored and
not reported in the result metadata.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The HAL level representation of MeteringRectangle[] is a
int[5 * area_<wbr/>count].<wbr/>
Every five elements represent a metering region of
(xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
exclusive on xmax and ymax.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.aeTargetFpsRange">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [public as rangeInt]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Range over which the auto-exposure routine can
adjust the capture frame rate to maintain good
exposure.<wbr/></p>
            </td>

            <td class="entry_units">
              Frames per second (FPS)
            </td>

            <td class="entry_range">
              <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>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Only constrains auto-exposure (AE) algorithm,<wbr/> not
manual control of <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a> and
<a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.aePrecaptureTrigger">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[limited] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">IDLE</span>
                    <span class="entry_type_enum_notes"><p>The trigger is idle.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">START</span>
                    <span class="entry_type_enum_notes"><p>The precapture metering sequence will be started
by the camera device.<wbr/></p>
<p>The exact effect of the precapture trigger depends on
the current AE mode and state.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether the camera device will trigger a precapture
metering sequence when it processes this request.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This entry is normally set to IDLE,<wbr/> or is not
included at all in the request settings.<wbr/> When included and
set to START,<wbr/> the camera device will trigger the auto-exposure (AE)
precapture metering sequence.<wbr/></p>
<p>The precapture sequence should be triggered before starting a
high-quality still capture for final metering decisions to
be made,<wbr/> and for firing pre-capture flash pulses to estimate
scene brightness and required final capture flash power,<wbr/> when
the flash is enabled.<wbr/></p>
<p>Normally,<wbr/> this entry should be set to START for only a
single request,<wbr/> and the application should wait until the
sequence completes before starting a new one.<wbr/></p>
<p>When a precapture metering sequence is finished,<wbr/> the camera device
may lock the auto-exposure routine internally to be able to accurately expose the
subsequent still capture image (<code><a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> == STILL_<wbr/>CAPTURE</code>).<wbr/>
For this case,<wbr/> the AE may not resume normal scan if no subsequent still capture is
submitted.<wbr/> To ensure that the AE routine restarts normal scan,<wbr/> the application should
submit a request with <code><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> == true</code>,<wbr/> followed by a request
with <code><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> == false</code>,<wbr/> if the application decides not to submit a
still capture request after the precapture sequence completes.<wbr/></p>
<p>The exact effect of auto-exposure (AE) precapture trigger
depends on the current AE mode and state; see
<a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> for AE precapture state transition
details.<wbr/></p>
<p>On LEGACY-level devices,<wbr/> the precapture trigger is not supported;
capturing a high-resolution JPEG image will automatically trigger a
precapture sequence before the high-resolution capture,<wbr/> including
potentially firing a pre-capture flash.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.aeState">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>ae<wbr/>State
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[limited] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">INACTIVE</span>
                    <span class="entry_type_enum_notes"><p>AE is off or recently reset.<wbr/></p>
<p>When a camera device is opened,<wbr/> it starts in
this state.<wbr/> This is a transient state,<wbr/> the camera device may skip reporting
this state in capture result.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SEARCHING</span>
                    <span class="entry_type_enum_notes"><p>AE doesn't yet have a good set of control values
for the current scene.<wbr/></p>
<p>This is a transient state,<wbr/> the camera device may skip
reporting this state in capture result.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CONVERGED</span>
                    <span class="entry_type_enum_notes"><p>AE has a good set of control values for the
current scene.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">LOCKED</span>
                    <span class="entry_type_enum_notes"><p>AE has been locked.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FLASH_REQUIRED</span>
                    <span class="entry_type_enum_notes"><p>AE has a good set of control values,<wbr/> but flash
needs to be fired for good quality still
capture.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PRECAPTURE</span>
                    <span class="entry_type_enum_notes"><p>AE has been asked to do a precapture sequence
and is currently executing it.<wbr/></p>
<p>Precapture can be triggered through setting
<a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> to START.<wbr/></p>
<p>Once PRECAPTURE completes,<wbr/> AE will transition to CONVERGED
or FLASH_<wbr/>REQUIRED as appropriate.<wbr/> This is a transient
state,<wbr/> the camera device may skip reporting this state in
capture result.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Current state of the auto-exposure (AE) algorithm.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Switching between or enabling AE modes (<a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>) always
resets the AE state to INACTIVE.<wbr/> Similarly,<wbr/> switching between <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a>,<wbr/>
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
the algorithm states to INACTIVE.<wbr/></p>
<p>The camera device can do several state transitions between two results,<wbr/> if it is
allowed by the state transition table.<wbr/> For example: INACTIVE may never actually be
seen in a result.<wbr/></p>
<p>The state in the result is the state for this image (in sync with this image): if
AE state becomes CONVERGED,<wbr/> then the image data associated with this result should
be good to use.<wbr/></p>
<p>Below are state transition tables for different AE modes.<wbr/></p>
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center"></td>
<td align="center">INACTIVE</td>
<td align="center">Camera device auto exposure algorithm is disabled</td>
</tr>
</tbody>
</table>
<p>When <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is AE_<wbr/>MODE_<wbr/>ON_<wbr/>*:</p>
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center">Camera device initiates AE scan</td>
<td align="center">SEARCHING</td>
<td align="center">Values changing</td>
</tr>
<tr>
<td align="center">INACTIVE</td>
<td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
<td align="center">LOCKED</td>
<td align="center">Values locked</td>
</tr>
<tr>
<td align="center">SEARCHING</td>
<td align="center">Camera device finishes AE scan</td>
<td align="center">CONVERGED</td>
<td align="center">Good values,<wbr/> not changing</td>
</tr>
<tr>
<td align="center">SEARCHING</td>
<td align="center">Camera device finishes AE scan</td>
<td align="center">FLASH_<wbr/>REQUIRED</td>
<td align="center">Converged but too dark w/<wbr/>o flash</td>
</tr>
<tr>
<td align="center">SEARCHING</td>
<td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
<td align="center">LOCKED</td>
<td align="center">Values locked</td>
</tr>
<tr>
<td align="center">CONVERGED</td>
<td align="center">Camera device initiates AE scan</td>
<td align="center">SEARCHING</td>
<td align="center">Values changing</td>
</tr>
<tr>
<td align="center">CONVERGED</td>
<td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
<td align="center">LOCKED</td>
<td align="center">Values locked</td>
</tr>
<tr>
<td align="center">FLASH_<wbr/>REQUIRED</td>
<td align="center">Camera device initiates AE scan</td>
<td align="center">SEARCHING</td>
<td align="center">Values changing</td>
</tr>
<tr>
<td align="center">FLASH_<wbr/>REQUIRED</td>
<td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
<td align="center">LOCKED</td>
<td align="center">Values locked</td>
</tr>
<tr>
<td align="center">LOCKED</td>
<td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is OFF</td>
<td align="center">SEARCHING</td>
<td align="center">Values not good after unlock</td>
</tr>
<tr>
<td align="center">LOCKED</td>
<td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is OFF</td>
<td align="center">CONVERGED</td>
<td align="center">Values good after unlock</td>
</tr>
<tr>
<td align="center">LOCKED</td>
<td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is OFF</td>
<td align="center">FLASH_<wbr/>REQUIRED</td>
<td align="center">Exposure good,<wbr/> but too dark</td>
</tr>
<tr>
<td align="center">PRECAPTURE</td>
<td align="center">Sequence done.<wbr/> <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is OFF</td>
<td align="center">CONVERGED</td>
<td align="center">Ready for high-quality capture</td>
</tr>
<tr>
<td align="center">PRECAPTURE</td>
<td align="center">Sequence done.<wbr/> <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
<td align="center">LOCKED</td>
<td align="center">Ready for high-quality capture</td>
</tr>
<tr>
<td align="center">Any state</td>
<td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> is START</td>
<td align="center">PRECAPTURE</td>
<td align="center">Start AE precapture metering sequence</td>
</tr>
</tbody>
</table>
<p>For the above table,<wbr/> the camera device may skip reporting any state changes that happen
without application intervention (i.<wbr/>e.<wbr/> mode switch,<wbr/> trigger,<wbr/> locking).<wbr/> Any state that
can be skipped in that manner is called a transient state.<wbr/></p>
<p>For example,<wbr/> for above AE modes (AE_<wbr/>MODE_<wbr/>ON_<wbr/>*),<wbr/> in addition to the state transitions
listed in above table,<wbr/> it is also legal for the camera device to skip one or more
transient states between two results.<wbr/> See below table for examples:</p>
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center">Camera device finished AE scan</td>
<td align="center">CONVERGED</td>
<td align="center">Values are already good,<wbr/> transient states are skipped by camera device.<wbr/></td>
</tr>
<tr>
<td align="center">Any state</td>
<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>
<td align="center">FLASH_<wbr/>REQUIRED</td>
<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>
</tr>
<tr>
<td align="center">Any state</td>
<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>
<td align="center">CONVERGED</td>
<td align="center">Converged after a precapture sequence,<wbr/> transient states are skipped by camera device.<wbr/></td>
</tr>
<tr>
<td align="center">CONVERGED</td>
<td align="center">Camera device finished AE scan</td>
<td align="center">FLASH_<wbr/>REQUIRED</td>
<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>
</tr>
<tr>
<td align="center">FLASH_<wbr/>REQUIRED</td>
<td align="center">Camera device finished AE scan</td>
<td align="center">CONVERGED</td>
<td align="center">Converged after a new scan,<wbr/> transient states are skipped by camera device.<wbr/></td>
</tr>
</tbody>
</table>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.afMode">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>af<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>The auto-focus routine does not control the lens;
<a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> is controlled by the
application.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">AUTO</span>
                    <span class="entry_type_enum_notes"><p>Basic automatic focus mode.<wbr/></p>
<p>In this mode,<wbr/> the lens does not move unless
the autofocus trigger action is called.<wbr/> When that trigger
is activated,<wbr/> AF will transition to ACTIVE_<wbr/>SCAN,<wbr/> then to
the outcome of the scan (FOCUSED or NOT_<wbr/>FOCUSED).<wbr/></p>
<p>Always supported if lens is not fixed focus.<wbr/></p>
<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
is fixed-focus.<wbr/></p>
<p>Triggering AF_<wbr/>CANCEL resets the lens position to default,<wbr/>
and sets the AF state to INACTIVE.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">MACRO</span>
                    <span class="entry_type_enum_notes"><p>Close-up focusing mode.<wbr/></p>
<p>In this mode,<wbr/> the lens does not move unless the
autofocus trigger action is called.<wbr/> When that trigger is
activated,<wbr/> AF will transition to ACTIVE_<wbr/>SCAN,<wbr/> then to
the outcome of the scan (FOCUSED or NOT_<wbr/>FOCUSED).<wbr/> This
mode is optimized for focusing on objects very close to
the camera.<wbr/></p>
<p>When that trigger is activated,<wbr/> AF will transition to
ACTIVE_<wbr/>SCAN,<wbr/> then to the outcome of the scan (FOCUSED or
NOT_<wbr/>FOCUSED).<wbr/> Triggering cancel AF resets the lens
position to default,<wbr/> and sets the AF state to
INACTIVE.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CONTINUOUS_VIDEO</span>
                    <span class="entry_type_enum_notes"><p>In this mode,<wbr/> the AF algorithm modifies the lens
position continually to attempt to provide a
constantly-in-focus image stream.<wbr/></p>
<p>The focusing behavior should be suitable for good quality
video recording; typically this means slower focus
movement and no overshoots.<wbr/> When the AF trigger is not
involved,<wbr/> the AF algorithm should start in INACTIVE state,<wbr/>
and then transition into PASSIVE_<wbr/>SCAN and PASSIVE_<wbr/>FOCUSED
states as appropriate.<wbr/> When the AF trigger is activated,<wbr/>
the algorithm should immediately transition into
AF_<wbr/>FOCUSED or AF_<wbr/>NOT_<wbr/>FOCUSED as appropriate,<wbr/> and lock the
lens position until a cancel AF trigger is received.<wbr/></p>
<p>Once cancel is received,<wbr/> the algorithm should transition
back to INACTIVE and resume passive scan.<wbr/> Note that this
behavior is not identical to CONTINUOUS_<wbr/>PICTURE,<wbr/> since an
ongoing PASSIVE_<wbr/>SCAN must immediately be
canceled.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CONTINUOUS_PICTURE</span>
                    <span class="entry_type_enum_notes"><p>In this mode,<wbr/> the AF algorithm modifies the lens
position continually to attempt to provide a
constantly-in-focus image stream.<wbr/></p>
<p>The focusing behavior should be suitable for still image
capture; typically this means focusing as fast as
possible.<wbr/> When the AF trigger is not involved,<wbr/> the AF
algorithm should start in INACTIVE state,<wbr/> and then
transition into PASSIVE_<wbr/>SCAN and PASSIVE_<wbr/>FOCUSED states as
appropriate as it attempts to maintain focus.<wbr/> When the AF
trigger is activated,<wbr/> the algorithm should finish its
PASSIVE_<wbr/>SCAN if active,<wbr/> and then transition into
AF_<wbr/>FOCUSED or AF_<wbr/>NOT_<wbr/>FOCUSED as appropriate,<wbr/> and lock the
lens position until a cancel AF trigger is received.<wbr/></p>
<p>When the AF cancel trigger is activated,<wbr/> the algorithm
should transition back to INACTIVE and then act as if it
has just been started.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">EDOF</span>
                    <span class="entry_type_enum_notes"><p>Extended depth of field (digital focus) mode.<wbr/></p>
<p>The camera device will produce images with an extended
depth of field automatically; no special focusing
operations need to be done before taking a picture.<wbr/></p>
<p>AF triggers are ignored,<wbr/> and the AF state will always be
INACTIVE.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether auto-focus (AF) is currently enabled,<wbr/> and what
mode it is set to.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.afAvailableModes">android.<wbr/>control.<wbr/>af<wbr/>Available<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> = AUTO and the lens is not fixed focus
(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/> Also note that
when <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is OFF,<wbr/> the behavior of AF is device
dependent.<wbr/> It is recommended to lock AF by using <a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a> before
setting <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> to OFF,<wbr/> or set AF mode to OFF when AE is OFF.<wbr/></p>
<p>If the lens is controlled by the camera device auto-focus algorithm,<wbr/>
the camera device will report the current AF status in <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a>
in result metadata.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When afMode is AUTO or MACRO,<wbr/> the lens must not move until an AF trigger is sent in a
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
up with either FOCUSED_<wbr/>LOCKED or NOT_<wbr/>FOCUSED_<wbr/>LOCKED state (see
<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
locked and will not move.<wbr/> If camera movement (e.<wbr/>g.<wbr/> tilting camera) causes the lens to move
after the lens is locked,<wbr/> the HAL must compensate this movement appropriately such that
the same focal plane remains in focus.<wbr/></p>
<p>When afMode is one of the continuous auto focus modes,<wbr/> the HAL is free to start a AF
scan whenever it's not locked.<wbr/> When the lens is locked after an AF trigger
(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
same lock behavior as above.<wbr/></p>
<p>When afMode is OFF,<wbr/> the application controls focus manually.<wbr/> The accuracy of the
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/>
However,<wbr/> the lens must not move regardless of the camera movement for any focus distance
manual control.<wbr/></p>
<p>To put this in concrete terms,<wbr/> if the camera has lens elements which may move based on
camera orientation or motion (e.<wbr/>g.<wbr/> due to gravity),<wbr/> then the HAL must drive the lens to
remain in a fixed position invariant to the camera's orientation or motion,<wbr/> for example,<wbr/>
by using accelerometer measurements in the lens control logic.<wbr/> This is a typical issue
that will arise on camera modules with open-loop VCMs.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.afRegions">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>af<wbr/>Regions
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  5 x area_count
                </span>
              <span class="entry_type_visibility"> [public as meteringRectangle]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of metering areas to use for auto-focus.<wbr/></p>
            </td>

            <td class="entry_units">
              Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
            </td>

            <td class="entry_range">
              <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Not available if <a href="#static_android.control.maxRegionsAf">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af</a> is 0.<wbr/>
Otherwise will always be present.<wbr/></p>
<p>The maximum number of focus areas supported by the device is determined by the value
of <a href="#static_android.control.maxRegionsAf">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af</a>.<wbr/></p>
<p>The coordinate system is based on the active pixel array,<wbr/>
with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
(<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
bottom-right pixel in the active pixel array.<wbr/></p>
<p>The weight must be within <code>[0,<wbr/> 1000]</code>,<wbr/> and represents a weight
for every pixel in the area.<wbr/> This means that a large metering area
with the same weight as a smaller area will have more effect in
the metering result.<wbr/> Metering areas can partially overlap and the
camera device will add the weights in the overlap region.<wbr/></p>
<p>The weights are relative to weights of other metering regions,<wbr/> so if only one region
is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with 0 weight is
ignored.<wbr/></p>
<p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
camera device.<wbr/></p>
<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
capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
region and output only the intersection rectangle as the metering region in the result
metadata.<wbr/> If the region is entirely outside the crop region,<wbr/> it will be ignored and
not reported in the result metadata.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The HAL level representation of MeteringRectangle[] is a
int[5 * area_<wbr/>count].<wbr/>
Every five elements represent a metering region of
(xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
exclusive on xmax and ymax.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.afTrigger">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>af<wbr/>Trigger
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">IDLE</span>
                    <span class="entry_type_enum_notes"><p>The trigger is idle.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">START</span>
                    <span class="entry_type_enum_notes"><p>Autofocus will trigger now.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CANCEL</span>
                    <span class="entry_type_enum_notes"><p>Autofocus will return to its initial
state,<wbr/> and cancel any currently active trigger.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether the camera device will trigger autofocus for this request.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This entry is normally set to IDLE,<wbr/> or is not
included at all in the request settings.<wbr/></p>
<p>When included and set to START,<wbr/> the camera device will trigger the
autofocus algorithm.<wbr/> If autofocus is disabled,<wbr/> this trigger has no effect.<wbr/></p>
<p>When set to CANCEL,<wbr/> the camera device will cancel any active trigger,<wbr/>
and return to its initial AF state.<wbr/></p>
<p>Generally,<wbr/> applications should set this entry to START or CANCEL for only a
single capture,<wbr/> and then return it to IDLE (or not set at all).<wbr/> Specifying
START for multiple captures in a row means restarting the AF operation over
and over again.<wbr/></p>
<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>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.afState">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>af<wbr/>State
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">INACTIVE</span>
                    <span class="entry_type_enum_notes"><p>AF is off or has not yet tried to scan/<wbr/>been asked
to scan.<wbr/></p>
<p>When a camera device is opened,<wbr/> it starts in this
state.<wbr/> This is a transient state,<wbr/> the camera device may
skip reporting this state in capture
result.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PASSIVE_SCAN</span>
                    <span class="entry_type_enum_notes"><p>AF is currently performing an AF scan initiated the
camera device in a continuous autofocus mode.<wbr/></p>
<p>Only used by CONTINUOUS_<wbr/>* AF modes.<wbr/> This is a transient
state,<wbr/> the camera device may skip reporting this state in
capture result.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PASSIVE_FOCUSED</span>
                    <span class="entry_type_enum_notes"><p>AF currently believes it is in focus,<wbr/> but may
restart scanning at any time.<wbr/></p>
<p>Only used by CONTINUOUS_<wbr/>* AF modes.<wbr/> This is a transient
state,<wbr/> the camera device may skip reporting this state in
capture result.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ACTIVE_SCAN</span>
                    <span class="entry_type_enum_notes"><p>AF is performing an AF scan because it was
triggered by AF trigger.<wbr/></p>
<p>Only used by AUTO or MACRO AF modes.<wbr/> This is a transient
state,<wbr/> the camera device may skip reporting this state in
capture result.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FOCUSED_LOCKED</span>
                    <span class="entry_type_enum_notes"><p>AF believes it is focused correctly and has locked
focus.<wbr/></p>
<p>This state is reached only after an explicit START AF trigger has been
sent (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>),<wbr/> when good focus has been obtained.<wbr/></p>
<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
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>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">NOT_FOCUSED_LOCKED</span>
                    <span class="entry_type_enum_notes"><p>AF has failed to focus successfully and has locked
focus.<wbr/></p>
<p>This state is reached only after an explicit START AF trigger has been
sent (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>),<wbr/> when good focus cannot be obtained.<wbr/></p>
<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
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>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PASSIVE_UNFOCUSED</span>
                    <span class="entry_type_enum_notes"><p>AF finished a passive scan without finding focus,<wbr/>
and may restart scanning at any time.<wbr/></p>
<p>Only used by CONTINUOUS_<wbr/>* AF modes.<wbr/> This is a transient state,<wbr/> the camera
device may skip reporting this state in capture result.<wbr/></p>
<p>LEGACY camera devices do not support this state.<wbr/> When a passive
scan has finished,<wbr/> it will always go to PASSIVE_<wbr/>FOCUSED.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Current state of auto-focus (AF) algorithm.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Switching between or enabling AF modes (<a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>) always
resets the AF state to INACTIVE.<wbr/> Similarly,<wbr/> switching between <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a>,<wbr/>
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
the algorithm states to INACTIVE.<wbr/></p>
<p>The camera device can do several state transitions between two results,<wbr/> if it is
allowed by the state transition table.<wbr/> For example: INACTIVE may never actually be
seen in a result.<wbr/></p>
<p>The state in the result is the state for this image (in sync with this image): if
AF state becomes FOCUSED,<wbr/> then the image data associated with this result should
be sharp.<wbr/></p>
<p>Below are state transition tables for different AF modes.<wbr/></p>
<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>
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center"></td>
<td align="center">INACTIVE</td>
<td align="center">Never changes</td>
</tr>
</tbody>
</table>
<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>
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">ACTIVE_<wbr/>SCAN</td>
<td align="center">Start AF sweep,<wbr/> Lens now moving</td>
</tr>
<tr>
<td align="center">ACTIVE_<wbr/>SCAN</td>
<td align="center">AF sweep done</td>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">Focused,<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">ACTIVE_<wbr/>SCAN</td>
<td align="center">AF sweep done</td>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">Not focused,<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">ACTIVE_<wbr/>SCAN</td>
<td align="center">AF_<wbr/>CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Cancel/<wbr/>reset AF,<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Cancel/<wbr/>reset AF</td>
</tr>
<tr>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">ACTIVE_<wbr/>SCAN</td>
<td align="center">Start new sweep,<wbr/> Lens now moving</td>
</tr>
<tr>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Cancel/<wbr/>reset AF</td>
</tr>
<tr>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">ACTIVE_<wbr/>SCAN</td>
<td align="center">Start new sweep,<wbr/> Lens now moving</td>
</tr>
<tr>
<td align="center">Any state</td>
<td align="center">Mode change</td>
<td align="center">INACTIVE</td>
<td align="center"></td>
</tr>
</tbody>
</table>
<p>For the above table,<wbr/> the camera device may skip reporting any state changes that happen
without application intervention (i.<wbr/>e.<wbr/> mode switch,<wbr/> trigger,<wbr/> locking).<wbr/> Any state that
can be skipped in that manner is called a transient state.<wbr/></p>
<p>For example,<wbr/> for these AF modes (AF_<wbr/>MODE_<wbr/>AUTO and AF_<wbr/>MODE_<wbr/>MACRO),<wbr/> in addition to the
state transitions listed in above table,<wbr/> it is also legal for the camera device to skip
one or more transient states between two results.<wbr/> See below table for examples:</p>
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">Focus is already good or good after a scan,<wbr/> lens is now locked.<wbr/></td>
</tr>
<tr>
<td align="center">INACTIVE</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">Focus failed after a scan,<wbr/> lens is now locked.<wbr/></td>
</tr>
<tr>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">Focus is already good or good after a scan,<wbr/> lens is now locked.<wbr/></td>
</tr>
<tr>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">Focus is good after a scan,<wbr/> lens is not locked.<wbr/></td>
</tr>
</tbody>
</table>
<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>
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center">Camera device initiates new scan</td>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">Start AF scan,<wbr/> Lens now moving</td>
</tr>
<tr>
<td align="center">INACTIVE</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF state query,<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">Camera device completes current scan</td>
<td align="center">PASSIVE_<wbr/>FOCUSED</td>
<td align="center">End AF scan,<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">Camera device fails current scan</td>
<td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
<td align="center">End AF scan,<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">Immediate transition,<wbr/> if focus is good.<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">Immediate transition,<wbr/> if focus is bad.<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">AF_<wbr/>CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Reset lens position,<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>FOCUSED</td>
<td align="center">Camera device initiates new scan</td>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">Start AF scan,<wbr/> Lens now moving</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
<td align="center">Camera device initiates new scan</td>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">Start AF scan,<wbr/> Lens now moving</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>FOCUSED</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">Immediate transition,<wbr/> lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">Immediate transition,<wbr/> lens now locked</td>
</tr>
<tr>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">No effect</td>
</tr>
<tr>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Restart AF scan</td>
</tr>
<tr>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">No effect</td>
</tr>
<tr>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Restart AF scan</td>
</tr>
</tbody>
</table>
<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>
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center">Camera device initiates new scan</td>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">Start AF scan,<wbr/> Lens now moving</td>
</tr>
<tr>
<td align="center">INACTIVE</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF state query,<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">Camera device completes current scan</td>
<td align="center">PASSIVE_<wbr/>FOCUSED</td>
<td align="center">End AF scan,<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">Camera device fails current scan</td>
<td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
<td align="center">End AF scan,<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">Eventual transition once the focus is good.<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">Eventual transition if cannot find focus.<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">AF_<wbr/>CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Reset lens position,<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>FOCUSED</td>
<td align="center">Camera device initiates new scan</td>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">Start AF scan,<wbr/> Lens now moving</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
<td align="center">Camera device initiates new scan</td>
<td align="center">PASSIVE_<wbr/>SCAN</td>
<td align="center">Start AF scan,<wbr/> Lens now moving</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>FOCUSED</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">Immediate trans.<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">Immediate trans.<wbr/> Lens now locked</td>
</tr>
<tr>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">No effect</td>
</tr>
<tr>
<td align="center">FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Restart AF scan</td>
</tr>
<tr>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>TRIGGER</td>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">No effect</td>
</tr>
<tr>
<td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
<td align="center">AF_<wbr/>CANCEL</td>
<td align="center">INACTIVE</td>
<td align="center">Restart AF scan</td>
</tr>
</tbody>
</table>
<p>When switch between AF_<wbr/>MODE_<wbr/>CONTINUOUS_<wbr/>* (CAF modes) and AF_<wbr/>MODE_<wbr/>AUTO/<wbr/>AF_<wbr/>MODE_<wbr/>MACRO
(AUTO modes),<wbr/> the initial INACTIVE or PASSIVE_<wbr/>SCAN states may be skipped by the
camera device.<wbr/> When a trigger is included in a mode switch request,<wbr/> the trigger
will be evaluated in the context of the new mode in the request.<wbr/>
See below table for examples:</p>
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">any state</td>
<td align="center">CAF--&gt;AUTO mode switch</td>
<td align="center">INACTIVE</td>
<td align="center">Mode switch without trigger,<wbr/> initial state must be INACTIVE</td>
</tr>
<tr>
<td align="center">any state</td>
<td align="center">CAF--&gt;AUTO mode switch with AF_<wbr/>TRIGGER</td>
<td align="center">trigger-reachable states from INACTIVE</td>
<td align="center">Mode switch with trigger,<wbr/> INACTIVE is skipped</td>
</tr>
<tr>
<td align="center">any state</td>
<td align="center">AUTO--&gt;CAF mode switch</td>
<td align="center">passively reachable states from INACTIVE</td>
<td align="center">Mode switch without trigger,<wbr/> passive transient state is skipped</td>
</tr>
</tbody>
</table>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.afTriggerId">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>control.<wbr/>af<wbr/>Trigger<wbr/>Id
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [system]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The ID sent with the latest
CAMERA2_<wbr/>TRIGGER_<wbr/>AUTOFOCUS call</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Must be 0 if no CAMERA2_<wbr/>TRIGGER_<wbr/>AUTOFOCUS trigger
received yet by HAL.<wbr/> Always updated even if AF algorithm
ignores the trigger</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.awbLock">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>awb<wbr/>Lock
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public as boolean]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Auto-white balance lock is disabled; the AWB
algorithm is free to update its parameters if in AUTO
mode.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_notes"><p>Auto-white balance lock is enabled; the AWB
algorithm will not update its parameters while the lock
is active.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether auto-white balance (AWB) is currently locked to its
latest calculated values.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When set to <code>true</code> (ON),<wbr/> the AWB algorithm is locked to its latest parameters,<wbr/>
and will not change color balance settings until the lock is set to <code>false</code> (OFF).<wbr/></p>
<p>Since the camera device has a pipeline of in-flight requests,<wbr/> the settings that
get locked do not necessarily correspond to the settings that were present in the
latest capture result received from the camera device,<wbr/> since additional captures
and AWB updates may have occurred even before the result was sent out.<wbr/> If an
application is switching between automatic and manual control and wishes to eliminate
any flicker during the switch,<wbr/> the following procedure is recommended:</p>
<ol>
<li>Starting in auto-AWB mode:</li>
<li>Lock AWB</li>
<li>Wait for the first result to be output that has the AWB locked</li>
<li>Copy AWB settings from that result into a request,<wbr/> set the request to manual AWB</li>
<li>Submit the capture request,<wbr/> proceed to run manual AWB as desired.<wbr/></li>
</ol>
<p>Note that AWB lock is only meaningful when
<a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> is in the AUTO mode; in other modes,<wbr/>
AWB is already fixed to a specific setting.<wbr/></p>
<p>Some LEGACY devices may not support ON; the value is then overridden to OFF.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.awbMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>awb<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled.<wbr/></p>
<p>The application-selected color transform matrix
(<a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>) and gains
(<a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a>) are used by the camera
device for manual white balance control.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">AUTO</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is active.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">INCANDESCENT</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses incandescent light as the assumed scene
illumination for white balance.<wbr/></p>
<p>While the exact white balance transforms are up to the
camera device,<wbr/> they will approximately match the CIE
standard illuminant A.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FLUORESCENT</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses fluorescent light as the assumed scene
illumination for white balance.<wbr/></p>
<p>While the exact white balance transforms are up to the
camera device,<wbr/> they will approximately match the CIE
standard illuminant F2.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">WARM_FLUORESCENT</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses warm fluorescent light as the assumed scene
illumination for white balance.<wbr/></p>
<p>While the exact white balance transforms are up to the
camera device,<wbr/> they will approximately match the CIE
standard illuminant F4.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">DAYLIGHT</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses daylight light as the assumed scene
illumination for white balance.<wbr/></p>
<p>While the exact white balance transforms are up to the
camera device,<wbr/> they will approximately match the CIE
standard illuminant D65.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CLOUDY_DAYLIGHT</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses cloudy daylight light as the assumed scene
illumination for white balance.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">TWILIGHT</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses twilight light as the assumed scene
illumination for white balance.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SHADE</span>
                    <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
the camera device uses shade light as the assumed scene
illumination for white balance.<wbr/></p>
<p>The application's values for <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> are ignored.<wbr/>
For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
values used by the camera device for the transform and gains
will be available in the capture result for this request.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether auto-white balance (AWB) is currently setting the color
transform fields,<wbr/> and what its illumination target
is.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.awbAvailableModes">android.<wbr/>control.<wbr/>awb<wbr/>Available<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control is only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is AUTO.<wbr/></p>
<p>When set to the ON mode,<wbr/> the camera device's auto-white balance
routine is enabled,<wbr/> overriding the application's selected
<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
<a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a>.<wbr/> Note that when <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>
is OFF,<wbr/> the behavior of AWB is device dependent.<wbr/> It is recommened to
also set AWB mode to OFF or lock AWB by using <a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> before
setting AE mode to OFF.<wbr/></p>
<p>When set to the OFF mode,<wbr/> the camera device's auto-white balance
routine is disabled.<wbr/> The application manually controls the white
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>
and <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a>.<wbr/></p>
<p>When set to any other modes,<wbr/> the camera device's auto-white
balance routine is disabled.<wbr/> The camera device uses each
particular illumination target for white balance
adjustment.<wbr/> The application's values for
<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
<a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> are ignored.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.awbRegions">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>awb<wbr/>Regions
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  5 x area_count
                </span>
              <span class="entry_type_visibility"> [public as meteringRectangle]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of metering areas to use for auto-white-balance illuminant
estimation.<wbr/></p>
            </td>

            <td class="entry_units">
              Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
            </td>

            <td class="entry_range">
              <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Not available if <a href="#static_android.control.maxRegionsAwb">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb</a> is 0.<wbr/>
Otherwise will always be present.<wbr/></p>
<p>The maximum number of regions supported by the device is determined by the value
of <a href="#static_android.control.maxRegionsAwb">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb</a>.<wbr/></p>
<p>The coordinate system is based on the active pixel array,<wbr/>
with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
(<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
bottom-right pixel in the active pixel array.<wbr/></p>
<p>The weight must range from 0 to 1000,<wbr/> and represents a weight
for every pixel in the area.<wbr/> This means that a large metering area
with the same weight as a smaller area will have more effect in
the metering result.<wbr/> Metering areas can partially overlap and the
camera device will add the weights in the overlap region.<wbr/></p>
<p>The weights are relative to weights of other white balance metering regions,<wbr/> so if
only one region is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with
0 weight is ignored.<wbr/></p>
<p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
camera device.<wbr/></p>
<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
capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
region and output only the intersection rectangle as the metering region in the result
metadata.<wbr/>  If the region is entirely outside the crop region,<wbr/> it will be ignored and
not reported in the result metadata.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The HAL level representation of MeteringRectangle[] is a
int[5 * area_<wbr/>count].<wbr/>
Every five elements represent a metering region of
(xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
exclusive on xmax and ymax.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.captureIntent">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>capture<wbr/>Intent
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">CUSTOM</span>
                    <span class="entry_type_enum_notes"><p>The goal of this request doesn't fall into the other
categories.<wbr/> The camera device will default to preview-like
behavior.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PREVIEW</span>
                    <span class="entry_type_enum_notes"><p>This request is for a preview-like use case.<wbr/></p>
<p>The precapture trigger may be used to start off a metering
w/<wbr/>flash sequence.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">STILL_CAPTURE</span>
                    <span class="entry_type_enum_notes"><p>This request is for a still capture-type
use case.<wbr/></p>
<p>If the flash unit is under automatic control,<wbr/> it may fire as needed.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">VIDEO_RECORD</span>
                    <span class="entry_type_enum_notes"><p>This request is for a video recording
use case.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">VIDEO_SNAPSHOT</span>
                    <span class="entry_type_enum_notes"><p>This request is for a video snapshot (still
image while recording video) use case.<wbr/></p>
<p>The camera device should take the highest-quality image
possible (given the other settings) without disrupting the
frame rate of video recording.<wbr/>  </p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ZERO_SHUTTER_LAG</span>
                    <span class="entry_type_enum_notes"><p>This request is for a ZSL usecase; the
application will stream full-resolution images and
reprocess one or several later for a final
capture.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">MANUAL</span>
                    <span class="entry_type_enum_notes"><p>This request is for manual capture use case where
the applications want to directly control the capture parameters.<wbr/></p>
<p>For example,<wbr/> the application may wish to manually control
<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>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Information to the camera device 3A (auto-exposure,<wbr/>
auto-focus,<wbr/> auto-white balance) routines about the purpose
of this capture,<wbr/> to help the camera device to decide optimal 3A
strategy.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control (except for MANUAL) is only effective if
<code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> != OFF</code> and any 3A routine is active.<wbr/></p>
<p>ZERO_<wbr/>SHUTTER_<wbr/>LAG will be supported if <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
contains ZSL.<wbr/> MANUAL will be supported if <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
contains MANUAL_<wbr/>SENSOR.<wbr/> Other intent values are always supported.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.awbState">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>awb<wbr/>State
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[limited] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">INACTIVE</span>
                    <span class="entry_type_enum_notes"><p>AWB is not in auto mode,<wbr/> or has not yet started metering.<wbr/></p>
<p>When a camera device is opened,<wbr/> it starts in this
state.<wbr/> This is a transient state,<wbr/> the camera device may
skip reporting this state in capture
result.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SEARCHING</span>
                    <span class="entry_type_enum_notes"><p>AWB doesn't yet have a good set of control
values for the current scene.<wbr/></p>
<p>This is a transient state,<wbr/> the camera device
may skip reporting this state in capture result.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CONVERGED</span>
                    <span class="entry_type_enum_notes"><p>AWB has a good set of control values for the
current scene.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">LOCKED</span>
                    <span class="entry_type_enum_notes"><p>AWB has been locked.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Current state of auto-white balance (AWB) algorithm.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Switching between or enabling AWB modes (<a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>) always
resets the AWB state to INACTIVE.<wbr/> Similarly,<wbr/> switching between <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a>,<wbr/>
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
the algorithm states to INACTIVE.<wbr/></p>
<p>The camera device can do several state transitions between two results,<wbr/> if it is
allowed by the state transition table.<wbr/> So INACTIVE may never actually be seen in
a result.<wbr/></p>
<p>The state in the result is the state for this image (in sync with this image): if
AWB state becomes CONVERGED,<wbr/> then the image data associated with this result should
be good to use.<wbr/></p>
<p>Below are state transition tables for different AWB modes.<wbr/></p>
<p>When <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != AWB_<wbr/>MODE_<wbr/>AUTO</code>:</p>
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center"></td>
<td align="center">INACTIVE</td>
<td align="center">Camera device auto white balance algorithm is disabled</td>
</tr>
</tbody>
</table>
<p>When <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> is AWB_<wbr/>MODE_<wbr/>AUTO:</p>
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center">Camera device initiates AWB scan</td>
<td align="center">SEARCHING</td>
<td align="center">Values changing</td>
</tr>
<tr>
<td align="center">INACTIVE</td>
<td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is ON</td>
<td align="center">LOCKED</td>
<td align="center">Values locked</td>
</tr>
<tr>
<td align="center">SEARCHING</td>
<td align="center">Camera device finishes AWB scan</td>
<td align="center">CONVERGED</td>
<td align="center">Good values,<wbr/> not changing</td>
</tr>
<tr>
<td align="center">SEARCHING</td>
<td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is ON</td>
<td align="center">LOCKED</td>
<td align="center">Values locked</td>
</tr>
<tr>
<td align="center">CONVERGED</td>
<td align="center">Camera device initiates AWB scan</td>
<td align="center">SEARCHING</td>
<td align="center">Values changing</td>
</tr>
<tr>
<td align="center">CONVERGED</td>
<td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is ON</td>
<td align="center">LOCKED</td>
<td align="center">Values locked</td>
</tr>
<tr>
<td align="center">LOCKED</td>
<td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is OFF</td>
<td align="center">SEARCHING</td>
<td align="center">Values not good after unlock</td>
</tr>
</tbody>
</table>
<p>For the above table,<wbr/> the camera device may skip reporting any state changes that happen
without application intervention (i.<wbr/>e.<wbr/> mode switch,<wbr/> trigger,<wbr/> locking).<wbr/> Any state that
can be skipped in that manner is called a transient state.<wbr/></p>
<p>For example,<wbr/> for this AWB mode (AWB_<wbr/>MODE_<wbr/>AUTO),<wbr/> in addition to the state transitions
listed in above table,<wbr/> it is also legal for the camera device to skip one or more
transient states between two results.<wbr/> See below table for examples:</p>
<table>
<thead>
<tr>
<th align="center">State</th>
<th align="center">Transition Cause</th>
<th align="center">New State</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">INACTIVE</td>
<td align="center">Camera device finished AWB scan</td>
<td align="center">CONVERGED</td>
<td align="center">Values are already good,<wbr/> transient states are skipped by camera device.<wbr/></td>
</tr>
<tr>
<td align="center">LOCKED</td>
<td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is OFF</td>
<td align="center">CONVERGED</td>
<td align="center">Values good after unlock,<wbr/> transient states are skipped by camera device.<wbr/></td>
</tr>
</tbody>
</table>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.effectMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>effect<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No color effect will be applied.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">MONO</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "monocolor" effect where the image is mapped into
a single color.<wbr/></p>
<p>This will typically be grayscale.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">NEGATIVE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "photo-negative" effect where the image's colors
are inverted.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SOLARIZE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "solarisation" effect (Sabattier effect) where the
image is wholly or partially reversed in
tone.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SEPIA</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "sepia" effect where the image is mapped into warm
gray,<wbr/> red,<wbr/> and brown tones.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">POSTERIZE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "posterization" effect where the image uses
discrete regions of tone rather than a continuous
gradient of tones.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">WHITEBOARD</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "whiteboard" effect where the image is typically displayed
as regions of white,<wbr/> with black or grey details.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">BLACKBOARD</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>A "blackboard" effect where the image is typically displayed
as regions of black,<wbr/> with white or grey details.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">AQUA</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>An "aqua" effect where a blue hue is added to the image.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A special color effect to apply.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.availableEffects">android.<wbr/>control.<wbr/>available<wbr/>Effects</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When this mode is set,<wbr/> a color effect will be applied
to images produced by the camera device.<wbr/> The interpretation
and implementation of these color effects is left to the
implementor of the camera device,<wbr/> and should not be
depended on to be consistent (or present) across all
devices.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Full application control of pipeline.<wbr/></p>
<p>All control by the device's metering and focusing (3A)
routines is disabled,<wbr/> and no other settings in
android.<wbr/>control.<wbr/>* have any effect,<wbr/> except that
<a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> may be used by the camera
device to select post-processing values for processing
blocks that do not allow for manual control,<wbr/> or are not
exposed by the camera API.<wbr/></p>
<p>However,<wbr/> the camera device's 3A routines may continue to
collect statistics and update their internal state so that
when control is switched to AUTO mode,<wbr/> good control values
can be immediately applied.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">AUTO</span>
                    <span class="entry_type_enum_notes"><p>Use settings for each individual 3A routine.<wbr/></p>
<p>Manual control of capture parameters is disabled.<wbr/> All
controls in android.<wbr/>control.<wbr/>* besides sceneMode take
effect.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">USE_SCENE_MODE</span>
                    <span class="entry_type_enum_notes"><p>Use a specific scene mode.<wbr/></p>
<p>Enabling this disables control.<wbr/>aeMode,<wbr/> control.<wbr/>awbMode and
control.<wbr/>afMode controls; the camera device will ignore
those settings while USE_<wbr/>SCENE_<wbr/>MODE is active (except for
FACE_<wbr/>PRIORITY scene mode).<wbr/> Other control entries are still
active.<wbr/>  This setting can only be used if scene mode is
supported (i.<wbr/>e.<wbr/> <a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a>
contain some modes other than DISABLED).<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">OFF_KEEP_STATE</span>
                    <span class="entry_type_enum_notes"><p>Same as OFF mode,<wbr/> except that this capture will not be
used by camera device background auto-exposure,<wbr/> auto-white balance and
auto-focus algorithms (3A) to update their statistics.<wbr/></p>
<p>Specifically,<wbr/> the 3A routines are locked to the last
values set from a request with AUTO,<wbr/> OFF,<wbr/> or
USE_<wbr/>SCENE_<wbr/>MODE,<wbr/> and any statistics or state updates
collected from manual captures with OFF_<wbr/>KEEP_<wbr/>STATE will be
discarded by the camera device.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Overall mode of 3A (auto-exposure,<wbr/> auto-white-balance,<wbr/> auto-focus) control
routines.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This is a top-level 3A control switch.<wbr/> When set to OFF,<wbr/> all 3A control
by the camera device is disabled.<wbr/> The application must set the fields for
capture parameters itself.<wbr/></p>
<p>When set to AUTO,<wbr/> the individual algorithm controls in
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>
<p>When set to USE_<wbr/>SCENE_<wbr/>MODE,<wbr/> the individual controls in
android.<wbr/>control.<wbr/>* are mostly disabled,<wbr/> and the camera device implements
one of the scene mode settings (such as ACTION,<wbr/> SUNSET,<wbr/> or PARTY)
as it wishes.<wbr/> The camera device scene mode 3A settings are provided by
<a href="#static_android.control.sceneModeOverrides">android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides</a>.<wbr/></p>
<p>When set to OFF_<wbr/>KEEP_<wbr/>STATE,<wbr/> it is similar to OFF mode,<wbr/> the only difference
is that this frame will not be used by camera device background 3A statistics
update,<wbr/> as if this frame is never captured.<wbr/> This mode can be used in the scenario
where the application doesn't want a 3A manual control capture to affect
the subsequent auto 3A capture results.<wbr/></p>
<p>LEGACY mode devices will only support AUTO and USE_<wbr/>SCENE_<wbr/>MODE modes.<wbr/>
LIMITED mode devices will only support OFF and OFF_<wbr/>KEEP_<wbr/>STATE if they
support the MANUAL_<wbr/>SENSOR and MANUAL_<wbr/>POST_<wbr/>PROCSESING capabilities.<wbr/>
FULL mode devices will always support OFF and OFF_<wbr/>KEEP_<wbr/>STATE.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.sceneMode">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>control.<wbr/>scene<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">DISABLED</span>
                    <span class="entry_type_enum_value">0</span>
                    <span class="entry_type_enum_notes"><p>Indicates that no scene modes are set for a given capture request.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FACE_PRIORITY</span>
                    <span class="entry_type_enum_notes"><p>If face detection support exists,<wbr/> use face
detection data for auto-focus,<wbr/> auto-white balance,<wbr/> and
auto-exposure routines.<wbr/></p>
<p>If face detection statistics are disabled
(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/>
this should still operate correctly (but will not return
face detection statistics to the framework).<wbr/></p>
<p>Unlike the other scene modes,<wbr/> <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/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>
remain active when FACE_<wbr/>PRIORITY is set.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ACTION</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for photos of quickly moving objects.<wbr/></p>
<p>Similar to SPORTS.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PORTRAIT</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for still photos of people.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">LANDSCAPE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for photos of distant macroscopic objects.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">NIGHT</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for low-light settings.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">NIGHT_PORTRAIT</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for still photos of people in low-light
settings.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">THEATRE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for dim,<wbr/> indoor settings where flash must
remain off.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">BEACH</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for bright,<wbr/> outdoor beach settings.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SNOW</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for bright,<wbr/> outdoor settings containing snow.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SUNSET</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for scenes of the setting sun.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">STEADYPHOTO</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized to avoid blurry photos due to small amounts of
device motion (for example: due to hand shake).<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FIREWORKS</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for nighttime photos of fireworks.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SPORTS</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for photos of quickly moving people.<wbr/></p>
<p>Similar to ACTION.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PARTY</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for dim,<wbr/> indoor settings with multiple moving
people.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CANDLELIGHT</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for dim settings where the main light source
is a flame.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">BARCODE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for accurately capturing a photo of barcode
for use by camera applications that wish to read the
barcode value.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_SPEED_VIDEO</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optimized for high speed video recording (frame rate &gt;=60fps) use case.<wbr/></p>
<p>The supported high speed video sizes and fps ranges are specified in
<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/> To get desired
output frame rates,<wbr/> the application is only allowed to select video size
and fps range combinations listed in this static metadata.<wbr/> The fps range
can be control via <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a>.<wbr/></p>
<p>In this mode,<wbr/> the camera device will override aeMode,<wbr/> awbMode,<wbr/> and afMode to
ON,<wbr/> ON,<wbr/> and CONTINUOUS_<wbr/>VIDEO,<wbr/> respectively.<wbr/> All post-processing block mode
controls will be overridden to be FAST.<wbr/> Therefore,<wbr/> no manual control of capture
and post-processing parameters is possible.<wbr/> All other controls operate the
same as when <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == AUTO.<wbr/> This means that all other
android.<wbr/>control.<wbr/>* fields continue to work,<wbr/> such as</p>
<ul>
<li><a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a></li>
<li><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a></li>
<li><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a></li>
<li><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a></li>
<li><a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a></li>
<li><a href="#controls_android.control.aeRegions">android.<wbr/>control.<wbr/>ae<wbr/>Regions</a></li>
<li><a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a></li>
<li><a href="#controls_android.control.awbRegions">android.<wbr/>control.<wbr/>awb<wbr/>Regions</a></li>
<li><a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a></li>
<li><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a></li>
</ul>
<p>Outside of android.<wbr/>control.<wbr/>*,<wbr/> the following controls will work:</p>
<ul>
<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>
<li><a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a> (if it is supported)</li>
<li><a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a></li>
<li><a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a></li>
</ul>
<p>For high speed recording use case,<wbr/> the actual maximum supported frame rate may
be lower than what camera can output,<wbr/> depending on the destination Surfaces for
the image data.<wbr/> For example,<wbr/> if the destination surface is from video encoder,<wbr/>
the application need check if the video encoder is capable of supporting the
high frame rate for a given video size,<wbr/> or it will end up with lower recording
frame rate.<wbr/> If the destination surface is from preview window,<wbr/> the preview frame
rate will be bounded by the screen refresh rate.<wbr/></p>
<p>The camera device will only support up to 2 output high speed streams
(processed non-stalling format defined in <a href="#static_android.request.maxNumOutputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams</a>)
in this mode.<wbr/> This control will be effective only if all of below conditions are true:</p>
<ul>
<li>The application created no more than maxNumHighSpeedStreams processed non-stalling
format output streams,<wbr/> where maxNumHighSpeedStreams is calculated as
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>
<li>The stream sizes are selected from the sizes reported by
<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/></li>
<li>No processed non-stalling or raw streams are configured.<wbr/></li>
</ul>
<p>When above conditions are NOT satistied,<wbr/> the controls of this mode and
<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/>
the camera device will fall back to <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> <code>==</code> AUTO,<wbr/>
and the returned capture result metadata will give the fps range choosen
by the camera device.<wbr/></p>
<p>Switching into or out of this mode may trigger some camera ISP/<wbr/>sensor
reconfigurations,<wbr/> which may introduce extra latency.<wbr/> It is recommended that
the application avoids unnecessary scene mode switch as much as possible.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HDR</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Turn on a device-specific high dynamic range (HDR) mode.<wbr/></p>
<p>In this scene mode,<wbr/> the camera device captures images
that keep a larger range of scene illumination levels
visible in the final image.<wbr/> For example,<wbr/> when taking a
picture of a object in front of a bright window,<wbr/> both
the object and the scene through the window may be
visible when using HDR mode,<wbr/> while in normal AUTO mode,<wbr/>
one or the other may be poorly exposed.<wbr/> As a tradeoff,<wbr/>
HDR mode generally takes much longer to capture a single
image,<wbr/> has no user control,<wbr/> and may have other artifacts
depending on the HDR method used.<wbr/></p>
<p>Therefore,<wbr/> HDR captures operate at a much slower rate
than regular captures.<wbr/></p>
<p>In this mode,<wbr/> on LIMITED or FULL devices,<wbr/> when a request
is made with a <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> of
STILL_<wbr/>CAPTURE,<wbr/> the camera device will capture an image
using a high dynamic range capture technique.<wbr/>  On LEGACY
devices,<wbr/> captures that target a JPEG-format output will
be captured with HDR,<wbr/> and the capture intent is not
relevant.<wbr/></p>
<p>The HDR capture may involve the device capturing a burst
of images internally and combining them into one,<wbr/> or it
may involve the device using specialized high dynamic
range capture hardware.<wbr/> In all cases,<wbr/> a single image is
produced in response to a capture request submitted
while in HDR mode.<wbr/></p>
<p>Since substantial post-processing is generally needed to
produce an HDR image,<wbr/> only YUV and JPEG outputs are
supported for LIMITED/<wbr/>FULL device HDR captures,<wbr/> and only
JPEG outputs are supported for LEGACY HDR
captures.<wbr/> Using a RAW output for HDR capture is not
supported.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Control for which scene mode is currently active.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Scene modes are custom camera modes optimized for a certain set of conditions and
capture settings.<wbr/></p>
<p>This is the mode that that is active when
<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/>
these modes will disable <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/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> while in use.<wbr/></p>
<p>The interpretation and implementation of these scene modes is left
to the implementor of the camera device.<wbr/> Their behavior will not be
consistent across all devices,<wbr/> and any given device may only implement
a subset of these modes.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>HAL implementations that include scene modes are expected to provide
the per-scene settings to use for <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/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> in
<a href="#static_android.control.sceneModeOverrides">android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides</a>.<wbr/></p>
<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/>
the HAL must list supported video size and fps range in
<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/>
1280x720,<wbr/> if the HAL has two different sensor configurations for normal streaming
mode and high speed streaming,<wbr/> when this scene mode is set/<wbr/>reset in a sequence of capture
requests,<wbr/> the HAL may have to switch between different sensor modes.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.control.videoStabilizationMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Video stabilization is disabled.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_notes"><p>Video stabilization is enabled.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether video stabilization is
active.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Video stabilization automatically translates and scales images from
the camera in order to stabilize motion between consecutive frames.<wbr/></p>
<p>If enabled,<wbr/> video stabilization can modify the
<a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> to keep the video stream stabilized.<wbr/></p>
<p>Switching between different video stabilization modes may take several
frames to initialize,<wbr/> the camera device will report the current mode
in capture result metadata.<wbr/> For example,<wbr/> When "ON" mode is requested,<wbr/>
the video stabilization modes in the first several capture results may
still be "OFF",<wbr/> and it will become "ON" when the initialization is
done.<wbr/></p>
<p>If a camera device supports both this mode and OIS
(<a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> turning both modes on may
produce undesirable interaction,<wbr/> so it is recommended not to enable
both at the same time.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_demosaic" class="section">demosaic</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.demosaic.mode">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>demosaic.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [system]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Minimal or no slowdown of frame rate compared to
Bayer RAW output.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>Improved processing quality but the frame rate is slowed down
relative to raw output.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Controls the quality of the demosaicing
processing.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_edge" class="section">edge</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.edge.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>edge.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No edge enhancement is applied.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Apply edge enhancement at a quality level that does not slow down frame rate relative to sensor
output</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>Apply high-quality edge enhancement,<wbr/> at a cost of reducing output frame rate.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Operation mode for edge
enhancement.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.edge.availableEdgeModes">android.<wbr/>edge.<wbr/>available<wbr/>Edge<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Edge enhancement improves sharpness and details in the captured image.<wbr/> OFF means
no enhancement will be applied by the camera device.<wbr/></p>
<p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean camera device determined enhancement
will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the
camera device will use the highest-quality enhancement algorithms,<wbr/>
even if it slows down capture rate.<wbr/> FAST means the camera device will
not slow down capture rate when applying edge enhancement.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.edge.strength">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>edge.<wbr/>strength
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Control the amount of edge enhancement
applied to the images</p>
            </td>

            <td class="entry_units">
              1-10; 10 is maximum sharpening
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.edge.availableEdgeModes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>edge.<wbr/>available<wbr/>Edge<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <div class="entry_type_notes">list of enums</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <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
device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.edge.mode">android.<wbr/>edge.<wbr/>mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Full-capability camera devices must always support OFF; all devices will list FAST.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.edge.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>edge.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No edge enhancement is applied.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Apply edge enhancement at a quality level that does not slow down frame rate relative to sensor
output</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>Apply high-quality edge enhancement,<wbr/> at a cost of reducing output frame rate.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Operation mode for edge
enhancement.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.edge.availableEdgeModes">android.<wbr/>edge.<wbr/>available<wbr/>Edge<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Edge enhancement improves sharpness and details in the captured image.<wbr/> OFF means
no enhancement will be applied by the camera device.<wbr/></p>
<p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean camera device determined enhancement
will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the
camera device will use the highest-quality enhancement algorithms,<wbr/>
even if it slows down capture rate.<wbr/> FAST means the camera device will
not slow down capture rate when applying edge enhancement.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_flash" class="section">flash</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.flash.firingPower">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>flash.<wbr/>firing<wbr/>Power
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Power for flash firing/<wbr/>torch</p>
            </td>

            <td class="entry_units">
              10 is max power; 0 is no flash.<wbr/> Linear
            </td>

            <td class="entry_range">
              <p>0 - 10</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Power for snapshot may use a different scale than
for torch mode.<wbr/> Only one entry for torch mode will be
used</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.flash.firingTime">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>flash.<wbr/>firing<wbr/>Time
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Firing time of flash relative to start of
exposure</p>
            </td>

            <td class="entry_units">
              nanoseconds
            </td>

            <td class="entry_range">
              <p>0-(exposure time-flash duration)</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Clamped to (0,<wbr/> exposure time - flash
duration).<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.flash.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>flash.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Do not fire the flash for this capture.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SINGLE</span>
                    <span class="entry_type_enum_notes"><p>If the flash is available and charged,<wbr/> fire flash
for this capture.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">TORCH</span>
                    <span class="entry_type_enum_notes"><p>Transition flash to continuously on.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired mode for for the camera device's flash control.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control is only effective when flash unit is available
(<code><a href="#static_android.flash.info.available">android.<wbr/>flash.<wbr/>info.<wbr/>available</a> == true</code>).<wbr/></p>
<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/>
Otherwise,<wbr/> the camera device auto-exposure related flash control (ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/>
ON_<wbr/>ALWAYS_<wbr/>FLASH,<wbr/> or ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE) will override this control.<wbr/></p>
<p>When set to OFF,<wbr/> the camera device will not fire flash for this capture.<wbr/></p>
<p>When set to SINGLE,<wbr/> the camera device will fire flash regardless of the camera
device's auto-exposure routine's result.<wbr/> When used in still capture case,<wbr/> this
control should be used along with auto-exposure (AE) precapture metering sequence
(<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>
<p>When set to TORCH,<wbr/> the flash will be on continuously.<wbr/> This mode can be used
for use cases such as preview,<wbr/> auto-focus assist,<wbr/> still capture,<wbr/> or video recording.<wbr/></p>
<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>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        
                
            

                
          <tr class="entry" id="static_android.flash.info.available">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>flash.<wbr/>info.<wbr/>available
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public as boolean]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">FALSE</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">TRUE</span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether this camera device has a
flash unit.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Will be <code>false</code> if no flash is available.<wbr/></p>
<p>If there is no flash unit,<wbr/> none of the flash controls do
anything.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.flash.info.chargeDuration">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>flash.<wbr/>info.<wbr/>charge<wbr/>Duration
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Time taken before flash can fire
again</p>
            </td>

            <td class="entry_units">
              nanoseconds
            </td>

            <td class="entry_range">
              <p>0-1e9</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>1 second too long/<wbr/>too short for recharge? Should
this be power-dependent?</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        
        

                
          <tr class="entry" id="static_android.flash.colorTemperature">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>flash.<wbr/>color<wbr/>Temperature
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The x,<wbr/>y whitepoint of the
flash</p>
            </td>

            <td class="entry_units">
              pair of floats
            </td>

            <td class="entry_range">
              <p>0-1 for both</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.flash.maxEnergy">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>flash.<wbr/>max<wbr/>Energy
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Max energy output of the flash for a full
power single flash</p>
            </td>

            <td class="entry_units">
              lumen-seconds
            </td>

            <td class="entry_range">
              <p>&gt;= 0</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.flash.firingPower">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>flash.<wbr/>firing<wbr/>Power
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Power for flash firing/<wbr/>torch</p>
            </td>

            <td class="entry_units">
              10 is max power; 0 is no flash.<wbr/> Linear
            </td>

            <td class="entry_range">
              <p>0 - 10</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Power for snapshot may use a different scale than
for torch mode.<wbr/> Only one entry for torch mode will be
used</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.flash.firingTime">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>flash.<wbr/>firing<wbr/>Time
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Firing time of flash relative to start of
exposure</p>
            </td>

            <td class="entry_units">
              nanoseconds
            </td>

            <td class="entry_range">
              <p>0-(exposure time-flash duration)</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Clamped to (0,<wbr/> exposure time - flash
duration).<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.flash.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>flash.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Do not fire the flash for this capture.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SINGLE</span>
                    <span class="entry_type_enum_notes"><p>If the flash is available and charged,<wbr/> fire flash
for this capture.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">TORCH</span>
                    <span class="entry_type_enum_notes"><p>Transition flash to continuously on.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired mode for for the camera device's flash control.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control is only effective when flash unit is available
(<code><a href="#static_android.flash.info.available">android.<wbr/>flash.<wbr/>info.<wbr/>available</a> == true</code>).<wbr/></p>
<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/>
Otherwise,<wbr/> the camera device auto-exposure related flash control (ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/>
ON_<wbr/>ALWAYS_<wbr/>FLASH,<wbr/> or ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE) will override this control.<wbr/></p>
<p>When set to OFF,<wbr/> the camera device will not fire flash for this capture.<wbr/></p>
<p>When set to SINGLE,<wbr/> the camera device will fire flash regardless of the camera
device's auto-exposure routine's result.<wbr/> When used in still capture case,<wbr/> this
control should be used along with auto-exposure (AE) precapture metering sequence
(<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>
<p>When set to TORCH,<wbr/> the flash will be on continuously.<wbr/> This mode can be used
for use cases such as preview,<wbr/> auto-focus assist,<wbr/> still capture,<wbr/> or video recording.<wbr/></p>
<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>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.flash.state">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>flash.<wbr/>state
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[limited] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">UNAVAILABLE</span>
                    <span class="entry_type_enum_notes"><p>No flash on camera.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CHARGING</span>
                    <span class="entry_type_enum_notes"><p>Flash is charging and cannot be fired.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">READY</span>
                    <span class="entry_type_enum_notes"><p>Flash is ready to fire.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FIRED</span>
                    <span class="entry_type_enum_notes"><p>Flash fired for this capture.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PARTIAL</span>
                    <span class="entry_type_enum_notes"><p>Flash partially illuminated this frame.<wbr/></p>
<p>This is usually due to the next or previous frame having
the flash fire,<wbr/> and the flash spilling into this capture
due to hardware limitations.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Current state of the flash
unit.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When the camera device doesn't have flash unit
(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/>
Other states indicate the current flash status.<wbr/></p>
<p>In certain conditions,<wbr/> this will be available on LEGACY devices:</p>
<ul>
<li>Flash-less cameras always return UNAVAILABLE.<wbr/></li>
<li>Using <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>==</code> ON_<wbr/>ALWAYS_<wbr/>FLASH
   will always return FIRED.<wbr/></li>
<li>Using <a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> <code>==</code> TORCH
   will always return FIRED.<wbr/></li>
</ul>
<p>In all other conditions the state will not be available on
LEGACY devices (i.<wbr/>e.<wbr/> it will be <code>null</code>).<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_hotPixel" class="section">hotPixel</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.hotPixel.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>hot<wbr/>Pixel.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No hot pixel correction is applied.<wbr/></p>
<p>The frame rate must not be reduced relative to sensor raw output
for this option.<wbr/></p>
<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>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Hot pixel correction is applied,<wbr/> without reducing frame
rate relative to sensor raw output.<wbr/></p>
<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>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>High-quality hot pixel correction is applied,<wbr/> at a cost
of reducing frame rate relative to sensor raw output.<wbr/></p>
<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>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Operational mode for hot pixel correction.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.hotPixel.availableHotPixelModes">android.<wbr/>hot<wbr/>Pixel.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Hotpixel correction interpolates out,<wbr/> or otherwise removes,<wbr/> pixels
that do not accurately measure the incoming light (i.<wbr/>e.<wbr/> pixels that
are stuck at an arbitrary value or are oversensitive).<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.hotPixel.availableHotPixelModes">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>hot<wbr/>Pixel.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>




                <div class="entry_type_notes">list of enums</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <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
camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.hotPixel.mode">android.<wbr/>hot<wbr/>Pixel.<wbr/>mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>FULL mode camera devices will always support FAST.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>To avoid performance issues,<wbr/> there will be significantly fewer hot
pixels than actual pixels on the camera sensor.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.hotPixel.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>hot<wbr/>Pixel.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No hot pixel correction is applied.<wbr/></p>
<p>The frame rate must not be reduced relative to sensor raw output
for this option.<wbr/></p>
<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>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Hot pixel correction is applied,<wbr/> without reducing frame
rate relative to sensor raw output.<wbr/></p>
<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>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>High-quality hot pixel correction is applied,<wbr/> at a cost
of reducing frame rate relative to sensor raw output.<wbr/></p>
<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>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Operational mode for hot pixel correction.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.hotPixel.availableHotPixelModes">android.<wbr/>hot<wbr/>Pixel.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Hotpixel correction interpolates out,<wbr/> or otherwise removes,<wbr/> pixels
that do not accurately measure the incoming light (i.<wbr/>e.<wbr/> pixels that
are stuck at an arbitrary value or are oversensitive).<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_jpeg" class="section">jpeg</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.jpeg.gpsLocation">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>jpeg.<wbr/>gps<wbr/>Location
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [public as location]</span>

              <span class="entry_type_synthetic">[synthetic] </span>

              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A location object to use when generating image GPS metadata.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Setting a location object in a request will include the GPS coordinates of the location
into any JPEG images captured based on the request.<wbr/> These coordinates can then be
viewed by anyone who receives the JPEG image.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.jpeg.gpsCoordinates">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>jpeg.<wbr/>gps<wbr/>Coordinates
            </td>
            <td class="entry_type">
                <span class="entry_type_name">double</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">latitude,<wbr/> longitude,<wbr/> altitude.<wbr/> First two in degrees,<wbr/> the third in meters</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>GPS coordinates to include in output JPEG
EXIF.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>(-180 - 180],<wbr/> [-90,<wbr/>90],<wbr/> [-inf,<wbr/> inf]</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.jpeg.gpsProcessingMethod">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>jpeg.<wbr/>gps<wbr/>Processing<wbr/>Method
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [hidden as string]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>32 characters describing GPS algorithm to
include in EXIF.<wbr/></p>
            </td>

            <td class="entry_units">
              UTF-8 null-terminated string
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.jpeg.gpsTimestamp">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>jpeg.<wbr/>gps<wbr/>Timestamp
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>

              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Time GPS fix was made to include in
EXIF.<wbr/></p>
            </td>

            <td class="entry_units">
              UTC in seconds since January 1,<wbr/> 1970
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.jpeg.orientation">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>jpeg.<wbr/>orientation
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The orientation for a JPEG image.<wbr/></p>
            </td>

            <td class="entry_units">
              Degrees in multiples of 90
            </td>

            <td class="entry_range">
              <p>0,<wbr/> 90,<wbr/> 180,<wbr/> 270</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The clockwise rotation angle in degrees,<wbr/> relative to the orientation
to the camera,<wbr/> that the JPEG picture needs to be rotated by,<wbr/> to be viewed
upright.<wbr/></p>
<p>Camera devices may either encode this value into the JPEG EXIF header,<wbr/> or
rotate the image data to match this orientation.<wbr/></p>
<p>Note that this orientation is relative to the orientation of the camera sensor,<wbr/> given
by <a href="#static_android.sensor.orientation">android.<wbr/>sensor.<wbr/>orientation</a>.<wbr/></p>
<p>To translate from the device orientation given by the Android sensor APIs,<wbr/> the following
sample code may be used:</p>
<pre><code>private int getJpegOrientation(CameraCharacteristics c,<wbr/> int deviceOrientation) {
    if (deviceOrientation == android.<wbr/>view.<wbr/>Orientation<wbr/>Event<wbr/>Listener.<wbr/>ORIENTATION_<wbr/>UNKNOWN) return 0;
    int sensorOrientation = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>SENSOR_<wbr/>ORIENTATION);

    //<wbr/> Round device orientation to a multiple of 90
    deviceOrientation = (deviceOrientation + 45) /<wbr/> 90 * 90;

    //<wbr/> Reverse device orientation for front-facing cameras
    boolean facingFront = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>LENS_<wbr/>FACING) == Camera<wbr/>Characteristics.<wbr/>LENS_<wbr/>FACING_<wbr/>FRONT;
    if (facingFront) deviceOrientation = -deviceOrientation;

    //<wbr/> Calculate desired JPEG orientation relative to camera orientation to make
    //<wbr/> the image upright relative to the device orientation
    int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360;

    return jpegOrientation;
}
</code></pre>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.jpeg.quality">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>jpeg.<wbr/>quality
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Compression quality of the final JPEG
image.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>1-100; larger is higher quality</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>85-95 is typical usage range.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.jpeg.thumbnailQuality">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Quality
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Compression quality of JPEG
thumbnail.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>1-100; larger is higher quality</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.jpeg.thumbnailSize">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Size
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [public as size]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Resolution of embedded JPEG thumbnail.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.jpeg.availableThumbnailSizes">android.<wbr/>jpeg.<wbr/>available<wbr/>Thumbnail<wbr/>Sizes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When set to (0,<wbr/> 0) value,<wbr/> the JPEG EXIF will not contain thumbnail,<wbr/>
but the captured JPEG will still be a valid image.<wbr/></p>
<p>For best results,<wbr/> when issuing a request for a JPEG image,<wbr/> the thumbnail size selected
should have the same aspect ratio as the main JPEG output.<wbr/></p>
<p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect
ratio,<wbr/> the camera device creates the thumbnail by cropping it from the primary image.<wbr/>
For example,<wbr/> if the primary image has 4:3 aspect ratio,<wbr/> the thumbnail image has
16:9 aspect ratio,<wbr/> the primary image will be cropped vertically (letterbox) to
generate the thumbnail image.<wbr/> The thumbnail image will always have a smaller Field
Of View (FOV) than the primary image when aspect ratios differ.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The HAL must not squeeze or stretch the downscaled primary image to generate thumbnail.<wbr/>
The cropping must be done on the primary jpeg image rather than the sensor active array.<wbr/>
The stream cropping rule specified by "S5.<wbr/> Cropping" in camera3.<wbr/>h doesn't apply to the
thumbnail image cropping.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.jpeg.availableThumbnailSizes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>jpeg.<wbr/>available<wbr/>Thumbnail<wbr/>Sizes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2 x n
                </span>
              <span class="entry_type_visibility"> [public as size]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of JPEG thumbnail sizes for <a href="#controls_android.jpeg.thumbnailSize">android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Size</a> supported by this
camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This list will include at least one non-zero resolution,<wbr/> plus <code>(0,<wbr/>0)</code> for indicating no
thumbnail should be generated.<wbr/></p>
<p>Below condiditions will be satisfied for this size list:</p>
<ul>
<li>The sizes will be sorted by increasing pixel area (width x height).<wbr/>
If several resolutions have the same area,<wbr/> they will be sorted by increasing width.<wbr/></li>
<li>The aspect ratio of the largest thumbnail size will be same as the
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/>
The largest size is defined as the size that has the largest pixel area
in a given size list.<wbr/></li>
<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
one corresponding size that has the same aspect ratio in availableThumbnailSizes,<wbr/>
and vice versa.<wbr/></li>
<li>All non-<code>(0,<wbr/> 0)</code> sizes will have non-zero widths and heights.<wbr/></li>
</ul>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.jpeg.maxSize">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>jpeg.<wbr/>max<wbr/>Size
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Maximum size in bytes for the compressed
JPEG buffer</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Must be large enough to fit any JPEG produced by
the camera</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This is used for sizing the gralloc buffers for
JPEG</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.jpeg.gpsLocation">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>jpeg.<wbr/>gps<wbr/>Location
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [public as location]</span>

              <span class="entry_type_synthetic">[synthetic] </span>

              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A location object to use when generating image GPS metadata.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Setting a location object in a request will include the GPS coordinates of the location
into any JPEG images captured based on the request.<wbr/> These coordinates can then be
viewed by anyone who receives the JPEG image.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.jpeg.gpsCoordinates">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>jpeg.<wbr/>gps<wbr/>Coordinates
            </td>
            <td class="entry_type">
                <span class="entry_type_name">double</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">latitude,<wbr/> longitude,<wbr/> altitude.<wbr/> First two in degrees,<wbr/> the third in meters</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>GPS coordinates to include in output JPEG
EXIF.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>(-180 - 180],<wbr/> [-90,<wbr/>90],<wbr/> [-inf,<wbr/> inf]</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.jpeg.gpsProcessingMethod">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>jpeg.<wbr/>gps<wbr/>Processing<wbr/>Method
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [hidden as string]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>32 characters describing GPS algorithm to
include in EXIF.<wbr/></p>
            </td>

            <td class="entry_units">
              UTF-8 null-terminated string
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.jpeg.gpsTimestamp">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>jpeg.<wbr/>gps<wbr/>Timestamp
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>

              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Time GPS fix was made to include in
EXIF.<wbr/></p>
            </td>

            <td class="entry_units">
              UTC in seconds since January 1,<wbr/> 1970
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.jpeg.orientation">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>jpeg.<wbr/>orientation
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The orientation for a JPEG image.<wbr/></p>
            </td>

            <td class="entry_units">
              Degrees in multiples of 90
            </td>

            <td class="entry_range">
              <p>0,<wbr/> 90,<wbr/> 180,<wbr/> 270</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The clockwise rotation angle in degrees,<wbr/> relative to the orientation
to the camera,<wbr/> that the JPEG picture needs to be rotated by,<wbr/> to be viewed
upright.<wbr/></p>
<p>Camera devices may either encode this value into the JPEG EXIF header,<wbr/> or
rotate the image data to match this orientation.<wbr/></p>
<p>Note that this orientation is relative to the orientation of the camera sensor,<wbr/> given
by <a href="#static_android.sensor.orientation">android.<wbr/>sensor.<wbr/>orientation</a>.<wbr/></p>
<p>To translate from the device orientation given by the Android sensor APIs,<wbr/> the following
sample code may be used:</p>
<pre><code>private int getJpegOrientation(CameraCharacteristics c,<wbr/> int deviceOrientation) {
    if (deviceOrientation == android.<wbr/>view.<wbr/>Orientation<wbr/>Event<wbr/>Listener.<wbr/>ORIENTATION_<wbr/>UNKNOWN) return 0;
    int sensorOrientation = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>SENSOR_<wbr/>ORIENTATION);

    //<wbr/> Round device orientation to a multiple of 90
    deviceOrientation = (deviceOrientation + 45) /<wbr/> 90 * 90;

    //<wbr/> Reverse device orientation for front-facing cameras
    boolean facingFront = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>LENS_<wbr/>FACING) == Camera<wbr/>Characteristics.<wbr/>LENS_<wbr/>FACING_<wbr/>FRONT;
    if (facingFront) deviceOrientation = -deviceOrientation;

    //<wbr/> Calculate desired JPEG orientation relative to camera orientation to make
    //<wbr/> the image upright relative to the device orientation
    int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360;

    return jpegOrientation;
}
</code></pre>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.jpeg.quality">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>jpeg.<wbr/>quality
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Compression quality of the final JPEG
image.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>1-100; larger is higher quality</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>85-95 is typical usage range.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.jpeg.size">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>jpeg.<wbr/>size
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The size of the compressed JPEG image,<wbr/> in
bytes</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>&gt;= 0</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If no JPEG output is produced for the request,<wbr/>
this must be 0.<wbr/></p>
<p>Otherwise,<wbr/> this describes the real size of the compressed
JPEG image placed in the output stream.<wbr/>  More specifically,<wbr/>
if <a href="#static_android.jpeg.maxSize">android.<wbr/>jpeg.<wbr/>max<wbr/>Size</a> = 1000000,<wbr/> and a specific capture
has <a href="#dynamic_android.jpeg.size">android.<wbr/>jpeg.<wbr/>size</a> = 500000,<wbr/> then the output buffer from
the JPEG stream will be 1000000 bytes,<wbr/> of which the first
500000 make up the real data.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.jpeg.thumbnailQuality">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Quality
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Compression quality of JPEG
thumbnail.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>1-100; larger is higher quality</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.jpeg.thumbnailSize">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Size
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [public as size]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Resolution of embedded JPEG thumbnail.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.jpeg.availableThumbnailSizes">android.<wbr/>jpeg.<wbr/>available<wbr/>Thumbnail<wbr/>Sizes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When set to (0,<wbr/> 0) value,<wbr/> the JPEG EXIF will not contain thumbnail,<wbr/>
but the captured JPEG will still be a valid image.<wbr/></p>
<p>For best results,<wbr/> when issuing a request for a JPEG image,<wbr/> the thumbnail size selected
should have the same aspect ratio as the main JPEG output.<wbr/></p>
<p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect
ratio,<wbr/> the camera device creates the thumbnail by cropping it from the primary image.<wbr/>
For example,<wbr/> if the primary image has 4:3 aspect ratio,<wbr/> the thumbnail image has
16:9 aspect ratio,<wbr/> the primary image will be cropped vertically (letterbox) to
generate the thumbnail image.<wbr/> The thumbnail image will always have a smaller Field
Of View (FOV) than the primary image when aspect ratios differ.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The HAL must not squeeze or stretch the downscaled primary image to generate thumbnail.<wbr/>
The cropping must be done on the primary jpeg image rather than the sensor active array.<wbr/>
The stream cropping rule specified by "S5.<wbr/> Cropping" in camera3.<wbr/>h doesn't apply to the
thumbnail image cropping.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_lens" class="section">lens</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.lens.aperture">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>aperture
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired lens aperture size,<wbr/> as a ratio of lens focal length to the
effective aperture diameter.<wbr/></p>
            </td>

            <td class="entry_units">
              The f-number (f/<wbr/>N)
            </td>

            <td class="entry_range">
              <p><a href="#static_android.lens.info.availableApertures">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Apertures</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Setting this value is only supported on the camera devices that have a variable
aperture lens.<wbr/></p>
<p>When this is supported and <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is OFF,<wbr/>
this can be set along with <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/> and <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>
to achieve manual exposure control.<wbr/></p>
<p>The requested aperture value may take several frames to reach the
requested value; the camera device will report the current (intermediate)
aperture size in capture result metadata while the aperture is changing.<wbr/>
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>
<p>When this is supported and <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is one of
the ON modes,<wbr/> this will be overridden by the camera device
auto-exposure algorithm,<wbr/> the overridden values are then provided
back to the user in the corresponding result.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.lens.filterDensity">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>filter<wbr/>Density
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired setting for the lens neutral density filter(s).<wbr/></p>
            </td>

            <td class="entry_units">
              Exposure Value (EV)
            </td>

            <td class="entry_range">
              <p><a href="#static_android.lens.info.availableFilterDensities">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Filter<wbr/>Densities</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control will not be supported on most camera devices.<wbr/></p>
<p>Lens filters are typically used to lower the amount of light the
sensor is exposed to (measured in steps of EV).<wbr/> As used here,<wbr/> an EV
step is the standard logarithmic representation,<wbr/> which are
non-negative,<wbr/> and inversely proportional to the amount of light
hitting the sensor.<wbr/>  For example,<wbr/> setting this to 0 would result
in no reduction of the incoming light,<wbr/> and setting this to 2 would
mean that the filter is set to reduce incoming light by two stops
(allowing 1/<wbr/>4 of the prior amount of light to the sensor).<wbr/></p>
<p>It may take several frames before the lens filter density changes
to the requested value.<wbr/> While the filter density is still changing,<wbr/>
<a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.lens.focalLength">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>focal<wbr/>Length
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired lens focal length; used for optical zoom.<wbr/></p>
            </td>

            <td class="entry_units">
              Millimeters
            </td>

            <td class="entry_range">
              <p><a href="#static_android.lens.info.availableFocalLengths">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Focal<wbr/>Lengths</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This setting controls the physical focal length of the camera
device's lens.<wbr/> Changing the focal length changes the field of
view of the camera device,<wbr/> and is usually used for optical zoom.<wbr/></p>
<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
setting won't be applied instantaneously,<wbr/> and it may take several
frames before the lens can change to the requested focal length.<wbr/>
While the focal length is still changing,<wbr/> <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will
be set to MOVING.<wbr/></p>
<p>Optical zoom will not be supported on most devices.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.lens.focusDistance">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>focus<wbr/>Distance
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Desired distance to plane of sharpest focus,<wbr/>
measured from frontmost surface of the lens.<wbr/></p>
            </td>

            <td class="entry_units">
              See android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details
            </td>

            <td class="entry_range">
              <p>&gt;= 0</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control can be used for setting manual focus,<wbr/> on devices that support
the MANUAL_<wbr/>SENSOR capability and have a variable-focus lens (see
<a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a>).<wbr/></p>
<p>A value of <code>0.<wbr/>0f</code> means infinity focus.<wbr/> The value set will be clamped to
<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>
<p>Like <a href="#controls_android.lens.focalLength">android.<wbr/>lens.<wbr/>focal<wbr/>Length</a>,<wbr/> this setting won't be applied
instantaneously,<wbr/> and it may take several frames before the lens
can move to the requested focus distance.<wbr/> While the lens is still moving,<wbr/>
<a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
<p>LEGACY devices support at most setting this to <code>0.<wbr/>0f</code>
for infinity focus.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.lens.opticalStabilizationMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[limited] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Optical stabilization is unavailable.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optical stabilization is enabled.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Sets whether the camera device uses optical image stabilization (OIS)
when capturing images.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>OIS is used to compensate for motion blur due to small
movements of the camera during capture.<wbr/> Unlike digital image
stabilization (<a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> OIS
makes use of mechanical elements to stabilize the camera
sensor,<wbr/> and thus allows for longer exposure times before
camera shake becomes apparent.<wbr/></p>
<p>Switching between different optical stabilization modes may take several
frames to initialize,<wbr/> the camera device will report the current mode in
capture result metadata.<wbr/> For example,<wbr/> When "ON" mode is requested,<wbr/> the
optical stabilization modes in the first several capture results may still
be "OFF",<wbr/> and it will become "ON" when the initialization is done.<wbr/></p>
<p>If a camera device supports both OIS and digital image stabilization
(<a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> turning both modes on may produce undesirable
interaction,<wbr/> so it is recommended not to enable both at the same time.<wbr/></p>
<p>Not all devices will support OIS; see
<a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a> for
available controls.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        
                
            

                
          <tr class="entry" id="static_android.lens.info.availableApertures">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Apertures
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of aperture size values for <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a> that are
supported by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
              The aperture f-number
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If the camera device doesn't support a variable lens aperture,<wbr/>
this list will contain only one value,<wbr/> which is the fixed aperture size.<wbr/></p>
<p>If the camera device supports a variable aperture,<wbr/> the aperture values
in this list will be sorted in ascending order.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.lens.info.availableFilterDensities">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Filter<wbr/>Densities
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of neutral density filter values for
<a href="#controls_android.lens.filterDensity">android.<wbr/>lens.<wbr/>filter<wbr/>Density</a> that are supported by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
              Exposure value (EV)
            </td>

            <td class="entry_range">
              <p>Values are &gt;= 0</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If a neutral density filter is not supported by this camera device,<wbr/>
this list will contain only 0.<wbr/> Otherwise,<wbr/> this list will include every
filter density supported by the camera device,<wbr/> in ascending order.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.lens.info.availableFocalLengths">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Focal<wbr/>Lengths
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">The list of available focal lengths</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <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
device.<wbr/></p>
            </td>

            <td class="entry_units">
              Millimeters
            </td>

            <td class="entry_range">
              <p>Values are &gt; 0</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If optical zoom is not supported,<wbr/> this list will only contain
a single value corresponding to the fixed focal length of the
device.<wbr/> Otherwise,<wbr/> this list will include every focal length supported
by the camera device,<wbr/> in ascending order.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.lens.info.availableOpticalStabilization">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[limited] </span>


                <div class="entry_type_notes">list of enums</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of optical image stabilization (OIS) modes for
<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>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If OIS is not supported by a given camera device,<wbr/> this list will
contain only OFF.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.lens.info.hyperfocalDistance">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>info.<wbr/>hyperfocal<wbr/>Distance
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[limited] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Hyperfocal distance for this lens.<wbr/></p>
            </td>

            <td class="entry_units">
              See android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details
            </td>

            <td class="entry_range">
              <p>If lens is fixed focus,<wbr/> &gt;= 0.<wbr/> If lens has focuser unit,<wbr/> the value is
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>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If the lens is not fixed focus,<wbr/> the camera device will report this
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>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.lens.info.minimumFocusDistance">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[limited] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Shortest distance from frontmost surface
of the lens that can be brought into sharp focus.<wbr/></p>
            </td>

            <td class="entry_units">
              See android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details
            </td>

            <td class="entry_range">
              <p>&gt;= 0</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If the lens is fixed-focus,<wbr/> this will be
0.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Mandatory for FULL devices; LIMITED devices
must always set this value to 0 for fixed-focus; and may omit
the minimum focus distance otherwise.<wbr/></p>
<p>This field is also mandatory for all devices advertising
the MANUAL_<wbr/>SENSOR capability.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.lens.info.shadingMapSize">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>info.<wbr/>shading<wbr/>Map<wbr/>Size
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [hidden as size]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <div class="entry_type_notes">width and height (N,<wbr/> M) of lens shading map provided by the camera device.<wbr/></div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Dimensions of lens shading map.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Both values &gt;= 1</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The map should be on the order of 30-40 rows and columns,<wbr/> and
must be smaller than 64x64.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.lens.info.focusDistanceCalibration">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[limited] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">UNCALIBRATED</span>
                    <span class="entry_type_enum_notes"><p>The lens focus distance is not accurate,<wbr/> and the units used for
<a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> do not correspond to any physical units.<wbr/></p>
<p>Setting the lens to the same focus distance on separate occasions may
result in a different real focus distance,<wbr/> depending on factors such
as the orientation of the device,<wbr/> the age of the focusing mechanism,<wbr/>
and the device temperature.<wbr/> The focus distance value will still be
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
represents the farthest focus.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">APPROXIMATE</span>
                    <span class="entry_type_enum_notes"><p>The lens focus distance is measured in diopters.<wbr/></p>
<p>However,<wbr/> setting the lens to the same focus distance
on separate occasions may result in a different real
focus distance,<wbr/> depending on factors such as the
orientation of the device,<wbr/> the age of the focusing
mechanism,<wbr/> and the device temperature.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CALIBRATED</span>
                    <span class="entry_type_enum_notes"><p>The lens focus distance is measured in diopters,<wbr/> and
is calibrated.<wbr/></p>
<p>The lens mechanism is calibrated so that setting the
same focus distance is repeatable on multiple
occasions with good accuracy,<wbr/> and the focus distance
corresponds to the real physical distance to the plane
of best focus.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The lens focus distance calibration quality.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The lens focus distance calibration quality determines the reliability of
focus related metadata entries,<wbr/> i.<wbr/>e.<wbr/> <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a>,<wbr/>
<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
<a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a>.<wbr/></p>
<p>APPROXIMATE and CALIBRATED devices report the focus metadata in
units of diopters (1/<wbr/>meter),<wbr/> so <code>0.<wbr/>0f</code> represents focusing at infinity,<wbr/>
and increasing positive numbers represent focusing closer and closer
to the camera device.<wbr/> The focus distance control also uses diopters
on these devices.<wbr/></p>
<p>UNCALIBRATED devices do not use units that are directly comparable
to any real physical measurement,<wbr/> but <code>0.<wbr/>0f</code> still represents farthest
focus,<wbr/> and <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> represents the
nearest focus the device can achieve.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For devices advertise APPROXIMATE quality or higher,<wbr/> diopters 0 (infinity
focus) must work.<wbr/> When autofocus is disabled (<a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> == OFF)
and the lens focus distance is set to 0 diopters
(<a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> == 0),<wbr/> the lens will move to focus at infinity
and is stably focused at infinity even if the device tilts.<wbr/> It may take the
lens some time to move; during the move the lens state should be MOVING and
the output diopter value should be changing toward 0.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        
        

                
          <tr class="entry" id="static_android.lens.facing">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>lens.<wbr/>facing
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">FRONT</span>
                    <span class="entry_type_enum_notes"><p>The camera device faces the same direction as the device's screen.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">BACK</span>
                    <span class="entry_type_enum_notes"><p>The camera device faces the opposite direction as the device's screen.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Direction the camera faces relative to
device screen.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.lens.opticalAxisAngle">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>optical<wbr/>Axis<wbr/>Angle
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [system]</span>




                <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>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Relative angle of camera optical axis to the
perpendicular axis from the display</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>[0-90) for first angle,<wbr/> [0-360) for second</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Examples:</p>
<p>(0,<wbr/>0) means that the camera optical axis
is perpendicular to the display surface;</p>
<p>(45,<wbr/>0) means that the camera points 45 degrees up when
device is held upright;</p>
<p>(45,<wbr/>90) means the camera points 45 degrees to the right when
the device is held upright.<wbr/></p>
<p>Use FACING field to determine perpendicular outgoing
direction</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.lens.position">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>lens.<wbr/>position
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3, location in mm, in the sensor coordinate
            system
                </span>
              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Coordinates of camera optical axis on
device</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.lens.aperture">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>aperture
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired lens aperture size,<wbr/> as a ratio of lens focal length to the
effective aperture diameter.<wbr/></p>
            </td>

            <td class="entry_units">
              The f-number (f/<wbr/>N)
            </td>

            <td class="entry_range">
              <p><a href="#static_android.lens.info.availableApertures">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Apertures</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Setting this value is only supported on the camera devices that have a variable
aperture lens.<wbr/></p>
<p>When this is supported and <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is OFF,<wbr/>
this can be set along with <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/> and <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>
to achieve manual exposure control.<wbr/></p>
<p>The requested aperture value may take several frames to reach the
requested value; the camera device will report the current (intermediate)
aperture size in capture result metadata while the aperture is changing.<wbr/>
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>
<p>When this is supported and <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is one of
the ON modes,<wbr/> this will be overridden by the camera device
auto-exposure algorithm,<wbr/> the overridden values are then provided
back to the user in the corresponding result.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.lens.filterDensity">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>filter<wbr/>Density
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired setting for the lens neutral density filter(s).<wbr/></p>
            </td>

            <td class="entry_units">
              Exposure Value (EV)
            </td>

            <td class="entry_range">
              <p><a href="#static_android.lens.info.availableFilterDensities">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Filter<wbr/>Densities</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control will not be supported on most camera devices.<wbr/></p>
<p>Lens filters are typically used to lower the amount of light the
sensor is exposed to (measured in steps of EV).<wbr/> As used here,<wbr/> an EV
step is the standard logarithmic representation,<wbr/> which are
non-negative,<wbr/> and inversely proportional to the amount of light
hitting the sensor.<wbr/>  For example,<wbr/> setting this to 0 would result
in no reduction of the incoming light,<wbr/> and setting this to 2 would
mean that the filter is set to reduce incoming light by two stops
(allowing 1/<wbr/>4 of the prior amount of light to the sensor).<wbr/></p>
<p>It may take several frames before the lens filter density changes
to the requested value.<wbr/> While the filter density is still changing,<wbr/>
<a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.lens.focalLength">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>focal<wbr/>Length
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired lens focal length; used for optical zoom.<wbr/></p>
            </td>

            <td class="entry_units">
              Millimeters
            </td>

            <td class="entry_range">
              <p><a href="#static_android.lens.info.availableFocalLengths">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Focal<wbr/>Lengths</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This setting controls the physical focal length of the camera
device's lens.<wbr/> Changing the focal length changes the field of
view of the camera device,<wbr/> and is usually used for optical zoom.<wbr/></p>
<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
setting won't be applied instantaneously,<wbr/> and it may take several
frames before the lens can change to the requested focal length.<wbr/>
While the focal length is still changing,<wbr/> <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will
be set to MOVING.<wbr/></p>
<p>Optical zoom will not be supported on most devices.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.lens.focusDistance">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>focus<wbr/>Distance
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Desired distance to plane of sharpest focus,<wbr/>
measured from frontmost surface of the lens.<wbr/></p>
            </td>

            <td class="entry_units">
              See android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details
            </td>

            <td class="entry_range">
              <p>&gt;= 0</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Should be zero for fixed-focus cameras</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.lens.focusRange">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>focus<wbr/>Range
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [public as pairFloatFloat]</span>


              <span class="entry_type_hwlevel">[limited] </span>


                <div class="entry_type_notes">Range of scene distances that are in focus</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The range of scene distances that are in
sharp focus (depth of field).<wbr/></p>
            </td>

            <td class="entry_units">
              A pair of focus distances in diopters: (near,<wbr/>
          far); see android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details.<wbr/>
            </td>

            <td class="entry_range">
              <p>&gt;=0</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If variable focus not supported,<wbr/> can still report
fixed depth of field range</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.lens.opticalStabilizationMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[limited] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Optical stabilization is unavailable.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Optical stabilization is enabled.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Sets whether the camera device uses optical image stabilization (OIS)
when capturing images.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>OIS is used to compensate for motion blur due to small
movements of the camera during capture.<wbr/> Unlike digital image
stabilization (<a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> OIS
makes use of mechanical elements to stabilize the camera
sensor,<wbr/> and thus allows for longer exposure times before
camera shake becomes apparent.<wbr/></p>
<p>Switching between different optical stabilization modes may take several
frames to initialize,<wbr/> the camera device will report the current mode in
capture result metadata.<wbr/> For example,<wbr/> When "ON" mode is requested,<wbr/> the
optical stabilization modes in the first several capture results may still
be "OFF",<wbr/> and it will become "ON" when the initialization is done.<wbr/></p>
<p>If a camera device supports both OIS and digital image stabilization
(<a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> turning both modes on may produce undesirable
interaction,<wbr/> so it is recommended not to enable both at the same time.<wbr/></p>
<p>Not all devices will support OIS; see
<a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a> for
available controls.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.lens.state">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>lens.<wbr/>state
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[limited] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">STATIONARY</span>
                    <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/>
<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>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">MOVING</span>
                    <span class="entry_type_enum_notes"><p>One or several of 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/>
<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
currently changing.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Current lens status.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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/>
<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/>
they may take several frames to reach the requested values.<wbr/> This state indicates
the current status of the lens parameters.<wbr/></p>
<p>When the state is STATIONARY,<wbr/> the lens parameters are not changing.<wbr/> This could be
either because the parameters are all fixed,<wbr/> or because the lens has had enough
time to reach the most recently-requested values.<wbr/>
If all these lens parameters are not changable for a camera device,<wbr/> as listed below:</p>
<ul>
<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
<a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> parameter will always be 0.<wbr/></li>
<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/>
which means the optical zoom is not supported.<wbr/></li>
<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>
<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>
</ul>
<p>Then this state will always be STATIONARY.<wbr/></p>
<p>When the state is MOVING,<wbr/> it indicates that at least one of the lens parameters
is changing.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_noiseReduction" class="section">noiseReduction</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.noiseReduction.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>noise<wbr/>Reduction.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No noise reduction is applied.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Noise reduction is applied without reducing frame rate relative to sensor
output.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>High-quality noise reduction is applied,<wbr/> at the cost of reducing frame rate
relative to sensor output.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Mode of operation for the noise reduction algorithm.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The noise reduction algorithm attempts to improve image quality by removing
excessive noise added by the capture process,<wbr/> especially in dark conditions.<wbr/>
OFF means no noise reduction will be applied by the camera device.<wbr/></p>
<p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean camera device determined noise filtering
will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the camera device
will use the highest-quality noise filtering algorithms,<wbr/>
even if it slows down capture rate.<wbr/> FAST means the camera device will not
slow down capture rate when applying noise filtering.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.noiseReduction.strength">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>noise<wbr/>Reduction.<wbr/>strength
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Control the amount of noise reduction
applied to the images</p>
            </td>

            <td class="entry_units">
              1-10; 10 is max noise reduction
            </td>

            <td class="entry_range">
              <p>1 - 10</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.noiseReduction.availableNoiseReductionModes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[limited] </span>


                <div class="entry_type_notes">list of enums</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of noise reduction modes for <a href="#controls_android.noiseReduction.mode">android.<wbr/>noise<wbr/>Reduction.<wbr/>mode</a> that are supported
by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.noiseReduction.mode">android.<wbr/>noise<wbr/>Reduction.<wbr/>mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Full-capability camera devices will always support OFF and FAST.<wbr/></p>
<p>Legacy-capability camera devices will only support FAST mode.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.noiseReduction.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>noise<wbr/>Reduction.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No noise reduction is applied.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Noise reduction is applied without reducing frame rate relative to sensor
output.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>High-quality noise reduction is applied,<wbr/> at the cost of reducing frame rate
relative to sensor output.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Mode of operation for the noise reduction algorithm.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The noise reduction algorithm attempts to improve image quality by removing
excessive noise added by the capture process,<wbr/> especially in dark conditions.<wbr/>
OFF means no noise reduction will be applied by the camera device.<wbr/></p>
<p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean camera device determined noise filtering
will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the camera device
will use the highest-quality noise filtering algorithms,<wbr/>
even if it slows down capture rate.<wbr/> FAST means the camera device will not
slow down capture rate when applying noise filtering.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_quirks" class="section">quirks</td></tr>


      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.quirks.meteringCropRegion">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>quirks.<wbr/>metering<wbr/>Crop<wbr/>Region
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [system]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>If set to 1,<wbr/> the camera service does not
scale 'normalized' coordinates with respect to the crop
region.<wbr/> This applies to metering input (a{e,<wbr/>f,<wbr/>wb}Region
and output (face rectangles).<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Normalized coordinates refer to those in the
(-1000,<wbr/>1000) range mentioned in the
android.<wbr/>hardware.<wbr/>Camera API.<wbr/></p>
<p>HAL implementations should instead always use and emit
sensor array-relative coordinates for all region data.<wbr/> Does
not need to be listed in static metadata.<wbr/> Support will be
removed in future versions of camera service.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.quirks.triggerAfWithAuto">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>quirks.<wbr/>trigger<wbr/>Af<wbr/>With<wbr/>Auto
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [system]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>If set to 1,<wbr/> then the camera service always
switches to FOCUS_<wbr/>MODE_<wbr/>AUTO before issuing a AF
trigger.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>HAL implementations should implement AF trigger
modes for AUTO,<wbr/> MACRO,<wbr/> CONTINUOUS_<wbr/>FOCUS,<wbr/> and
CONTINUOUS_<wbr/>PICTURE modes instead of using this flag.<wbr/> Does
not need to be listed in static metadata.<wbr/> Support will be
removed in future versions of camera service</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.quirks.useZslFormat">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>quirks.<wbr/>use<wbr/>Zsl<wbr/>Format
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [system]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>If set to 1,<wbr/> the camera service uses
CAMERA2_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>ZSL instead of
HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>IMPLEMENTATION_<wbr/>DEFINED for the zero
shutter lag stream</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>HAL implementations should use gralloc usage flags
to determine that a stream will be used for
zero-shutter-lag,<wbr/> instead of relying on an explicit
format setting.<wbr/> Does not need to be listed in static
metadata.<wbr/> Support will be removed in future versions of
camera service.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.quirks.usePartialResult">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="5">
              android.<wbr/>quirks.<wbr/>use<wbr/>Partial<wbr/>Result
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [hidden]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>If set to 1,<wbr/> the HAL will always split result
metadata for a single capture into multiple buffers,<wbr/>
returned using multiple process_<wbr/>capture_<wbr/>result calls.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Does not need to be listed in static
metadata.<wbr/> Support for partial results will be reworked in
future versions of camera service.<wbr/> This quirk will stop
working at that point; DO NOT USE without careful
consideration of future support.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Refer to <code>camera3_<wbr/>capture_<wbr/>result::partial_<wbr/>result</code>
for information on how to implement partial results.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.quirks.partialResult">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="5">
              android.<wbr/>quirks.<wbr/>partial<wbr/>Result
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [hidden as boolean]</span>



              <span class="entry_type_deprecated">[deprecated] </span>


                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">FINAL</span>
                    <span class="entry_type_enum_notes"><p>The last or only metadata result buffer
for this capture.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PARTIAL</span>
                    <span class="entry_type_enum_notes"><p>A partial buffer of result metadata for this
capture.<wbr/> More result buffers for this capture will be sent
by the camera device,<wbr/> the last of which will be marked
FINAL.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether a result given to the framework is the
final one for the capture,<wbr/> or only a partial that contains a
subset of the full set of dynamic metadata
values.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
              <p>Optional.<wbr/> Default value is FINAL.<wbr/></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The entries in the result metadata buffers for a
single capture may not overlap,<wbr/> except for this entry.<wbr/> The
FINAL buffers must retain FIFO ordering relative to the
requests that generate them,<wbr/> so the FINAL buffer for frame 3 must
always be sent to the framework after the FINAL buffer for frame 2,<wbr/> and
before the FINAL buffer for frame 4.<wbr/> PARTIAL buffers may be returned
in any order relative to other frames,<wbr/> but all PARTIAL buffers for a given
capture must arrive before the FINAL buffer for that capture.<wbr/> This entry may
only be used by the camera device if quirks.<wbr/>usePartialResult is set to 1.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Refer to <code>camera3_<wbr/>capture_<wbr/>result::partial_<wbr/>result</code>
for information on how to implement partial results.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_request" class="section">request</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.request.frameCount">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="1">
              android.<wbr/>request.<wbr/>frame<wbr/>Count
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [system]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A frame counter set by the framework.<wbr/> Must
be maintained unchanged in output frame.<wbr/> This value monotonically
increases with every new result (that is,<wbr/> each new result has a unique
frameCount value).<wbr/></p>
            </td>

            <td class="entry_units">
              incrementing integer
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
              <p>Any int.<wbr/></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.request.id">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>request.<wbr/>id
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [hidden]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>An application-specified ID for the current
request.<wbr/> Must be maintained unchanged in output
frame</p>
            </td>

            <td class="entry_units">
              arbitrary integer assigned by application
            </td>

            <td class="entry_range">
              <p>Any int</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.request.inputStreams">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>request.<wbr/>input<wbr/>Streams
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [system]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List which camera reprocess stream is used
for the source of reprocessing data.<wbr/></p>
            </td>

            <td class="entry_units">
              List of camera reprocess stream IDs
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
              <p>Typically,<wbr/> only one entry allowed,<wbr/> must be a valid reprocess stream ID.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_HAL2">HAL2</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Only meaningful when <a href="#controls_android.request.type">android.<wbr/>request.<wbr/>type</a> ==
REPROCESS.<wbr/> Ignored otherwise</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.request.metadataMode">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>request.<wbr/>metadata<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [system]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">NONE</span>
                    <span class="entry_type_enum_notes"><p>No metadata should be produced on output,<wbr/> except
for application-bound buffer data.<wbr/> If no
application-bound streams exist,<wbr/> no frame should be
placed in the output frame queue.<wbr/> If such streams
exist,<wbr/> a frame should be placed on the output queue
with null metadata but with the necessary output buffer
information.<wbr/> Timestamp information should still be
included with any output stream buffers</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FULL</span>
                    <span class="entry_type_enum_notes"><p>All metadata should be produced.<wbr/> Statistics will
only be produced if they are separately
enabled</p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>How much metadata to produce on
output</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.request.outputStreams">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>request.<wbr/>output<wbr/>Streams
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [system]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Lists which camera output streams image data
from this capture must be sent to</p>
            </td>

            <td class="entry_units">
              List of camera stream IDs
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
              <p>List must only include streams that have been
created</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_HAL2">HAL2</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If no output streams are listed,<wbr/> then the image
data should simply be discarded.<wbr/> The image data must
still be captured for metadata and statistics production,<wbr/>
and the lens and flash must operate as requested.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.request.type">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="1">
              android.<wbr/>request.<wbr/>type
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [system]</span>



              <span class="entry_type_deprecated">[deprecated] </span>


                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">CAPTURE</span>
                    <span class="entry_type_enum_notes"><p>Capture a new image from the imaging hardware,<wbr/>
and process it according to the
settings</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">REPROCESS</span>
                    <span class="entry_type_enum_notes"><p>Process previously captured data; the
<a href="#controls_android.request.inputStreams">android.<wbr/>request.<wbr/>input<wbr/>Streams</a> parameter determines the
source reprocessing stream.<wbr/> TODO: Mark dynamic metadata
needed for reprocessing with [RP]</p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The type of the request; either CAPTURE or
REPROCESS.<wbr/> For HAL3,<wbr/> this tag is redundant.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_HAL2">HAL2</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.request.maxNumOutputStreams">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The maximum numbers of different types of output streams
that can be configured and used simultaneously by a camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>For processed (and stalling) format streams,<wbr/> &gt;= 1.<wbr/></p>
<p>For Raw format (either stalling or non-stalling) streams,<wbr/> &gt;= 0.<wbr/></p>
<p>For processed (but not stalling) format streams,<wbr/> &gt;= 3
for FULL mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL</code>);
&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>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This is a 3 element tuple that contains the max number of output simultaneous
streams for raw sensor,<wbr/> processed (but not stalling),<wbr/> and processed (and stalling)
formats respectively.<wbr/> For example,<wbr/> assuming that JPEG is typically a processed and
stalling stream,<wbr/> if max raw sensor format output stream number is 1,<wbr/> max YUV streams
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>
<p>This lists the upper bound of the number of output streams supported by
the camera device.<wbr/> Using more streams simultaneously may require more hardware and
CPU resources that will consume more power.<wbr/> The image format for an output stream can
be any supported format provided by <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a>.<wbr/>
The formats defined in <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a> can be catergorized
into the 3 stream types as below:</p>
<ul>
<li>Processed (but stalling): any non-RAW format with a stallDurations &gt; 0.<wbr/>
Typically JPEG format (ImageFormat#JPEG).<wbr/></li>
<li>Raw formats: ImageFormat#RAW_<wbr/>SENSOR,<wbr/> ImageFormat#RAW10 and ImageFormat#RAW_<wbr/>OPAQUE.<wbr/></li>
<li>Processed (but not-stalling): any non-RAW format without a stall duration.<wbr/>
Typically Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888,<wbr/> ImageFormat#NV21,<wbr/> ImageFormat#YV12.<wbr/></li>
</ul>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.request.maxNumOutputRaw">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Raw
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>

              <span class="entry_type_synthetic">[synthetic] </span>

              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The maximum numbers of different types of output streams
that can be configured and used simultaneously by a camera device
for any <code>RAW</code> formats.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>&gt;= 0</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This value contains the max number of output simultaneous
streams from the raw sensor.<wbr/></p>
<p>This lists the upper bound of the number of output streams supported by
the camera device.<wbr/> Using more streams simultaneously may require more hardware and
CPU resources that will consume more power.<wbr/> The image format for this kind of an output stream can
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>
<p>In particular,<wbr/> a <code>RAW</code> format is typically one of:</p>
<ul>
<li>ImageFormat#RAW_<wbr/>SENSOR</li>
<li>ImageFormat#RAW10</li>
<li>Opaque <code>RAW</code></li>
</ul>
<p>LEGACY mode devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> <code>==</code> LEGACY)
never support raw streams.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.request.maxNumOutputProc">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Proc
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>

              <span class="entry_type_synthetic">[synthetic] </span>

              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The maximum numbers of different types of output streams
that can be configured and used simultaneously by a camera device
for any processed (but not-stalling) formats.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>&gt;= 3
for FULL mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL</code>);
&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>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This value contains the max number of output simultaneous
streams for any processed (but not-stalling) formats.<wbr/></p>
<p>This lists the upper bound of the number of output streams supported by
the camera device.<wbr/> Using more streams simultaneously may require more hardware and
CPU resources that will consume more power.<wbr/> The image format for this kind of an output stream can
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>
<p>Processed (but not-stalling) is defined as any non-RAW format without a stall duration.<wbr/>
Typically:</p>
<ul>
<li>Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</li>
<li>ImageFormat#NV21</li>
<li>ImageFormat#YV12</li>
<li>Implementation-defined formats,<wbr/> i.<wbr/>e.<wbr/> StreamConfiguration#isOutputSupportedFor(Class)</li>
</ul>
<p>For full guarantees,<wbr/> query StreamConfigurationMap#getOutputStallDuration with
a processed format -- it will return 0 for a non-stalling stream.<wbr/></p>
<p>LEGACY devices will support at least 2 processing/<wbr/>non-stalling streams.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.request.maxNumOutputProcStalling">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Proc<wbr/>Stalling
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>

              <span class="entry_type_synthetic">[synthetic] </span>

              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The maximum numbers of different types of output streams
that can be configured and used simultaneously by a camera device
for any processed (and stalling) formats.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>&gt;= 1</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This value contains the max number of output simultaneous
streams for any processed (but not-stalling) formats.<wbr/></p>
<p>This lists the upper bound of the number of output streams supported by
the camera device.<wbr/> Using more streams simultaneously may require more hardware and
CPU resources that will consume more power.<wbr/> The image format for this kind of an output stream can
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>
<p>A processed and stalling format is defined as any non-RAW format with a stallDurations &gt; 0.<wbr/>
Typically only the <code>JPEG</code> format (ImageFormat#JPEG) is a stalling format.<wbr/></p>
<p>For full guarantees,<wbr/> query StreamConfigurationMap#getOutputStallDuration with
a processed format -- it will return a non-0 value for a stalling stream.<wbr/></p>
<p>LEGACY devices will support up to 1 processing/<wbr/>stalling stream.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.request.maxNumReprocessStreams">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Reprocess<wbr/>Streams
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  1
                </span>
              <span class="entry_type_visibility"> [system]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>How many reprocessing streams of any type
can be allocated at the same time.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
              <p>&gt;= 0</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_HAL2">HAL2</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Only used by HAL2.<wbr/>x.<wbr/></p>
<p>When set to 0,<wbr/> it means no reprocess stream is supported.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.request.maxNumInputStreams">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Input<wbr/>Streams
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The maximum numbers of any type of input streams
that can be configured and used simultaneously by a camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>0 or 1.<wbr/></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When set to 0,<wbr/> it means no input stream is supported.<wbr/></p>
<p>The image format for a input stream can be any supported
format provided by
<a href="#static_android.scaler.availableInputOutputFormatsMap">android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map</a>.<wbr/> When using an
input stream,<wbr/> there must be at least one output stream
configured to to receive the reprocessed images.<wbr/></p>
<p>For example,<wbr/> for Zero Shutter Lag (ZSL) still capture use case,<wbr/> the input
stream image format will be RAW_<wbr/>OPAQUE,<wbr/> the associated output stream image format
should be JPEG.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.request.pipelineMaxDepth">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>request.<wbr/>pipeline<wbr/>Max<wbr/>Depth
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Specifies the number of maximum pipeline stages a frame
has to go through from when it's exposed to when it's available
to the framework.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>A typical minimum value for this is 2 (one stage to expose,<wbr/>
one stage to readout) from the sensor.<wbr/> The ISP then usually adds
its own stages to do custom HW processing.<wbr/> Further stages may be
added by SW processing.<wbr/></p>
<p>Depending on what settings are used (e.<wbr/>g.<wbr/> YUV,<wbr/> JPEG) and what
processing is enabled (e.<wbr/>g.<wbr/> face detection),<wbr/> the actual pipeline
depth (specified by <a href="#dynamic_android.request.pipelineDepth">android.<wbr/>request.<wbr/>pipeline<wbr/>Depth</a>) may be less than
the max pipeline depth.<wbr/></p>
<p>A pipeline depth of X stages is equivalent to a pipeline latency of
X frame intervals.<wbr/></p>
<p>This value will be 8 or less.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This value should be 4 or less.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.request.partialResultCount">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>request.<wbr/>partial<wbr/>Result<wbr/>Count
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Defines how many sub-components
a result will be composed of.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>&gt;= 1</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>In order to combat the pipeline latency,<wbr/> partial results
may be delivered to the application layer from the camera device as
soon as they are available.<wbr/></p>
<p>Optional; defaults to 1.<wbr/> A value of 1 means that partial
results are not supported,<wbr/> and only the final TotalCaptureResult will
be produced by the camera device.<wbr/></p>
<p>A typical use case for this might be: after requesting an
auto-focus (AF) lock the new AF state might be available 50%
of the way through the pipeline.<wbr/>  The camera device could
then immediately dispatch this state via a partial result to
the application,<wbr/> and the rest of the metadata via later
partial results.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.request.availableCapabilities">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>request.<wbr/>available<wbr/>Capabilities
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">BACKWARD_COMPATIBLE</span>
                    <span class="entry_type_enum_notes"><p>The minimal set of capabilities that every camera
device (regardless of <a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a>)
supports.<wbr/></p>
<p>This capability is listed by all devices,<wbr/> and
indicates that the camera device has a feature set
that's comparable to the baseline requirements for the
older android.<wbr/>hardware.<wbr/>Camera API.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">MANUAL_SENSOR</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>The camera device can be manually controlled (3A algorithms such
as auto-exposure,<wbr/> and auto-focus can be bypassed).<wbr/>
The camera device supports basic manual control of the sensor image
acquisition related stages.<wbr/> This means the following controls are
guaranteed to be supported:</p>
<ul>
<li>Manual frame duration control<ul>
<li><a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a></li>
<li><a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a></li>
</ul>
</li>
<li>Manual exposure control<ul>
<li><a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a></li>
<li><a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a></li>
</ul>
</li>
<li>Manual sensitivity control<ul>
<li><a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a></li>
<li><a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a></li>
</ul>
</li>
<li>Manual lens control (if the lens is adjustable)<ul>
<li>android.<wbr/>lens.<wbr/>*</li>
</ul>
</li>
<li>Manual flash control (if a flash unit is present)<ul>
<li>android.<wbr/>flash.<wbr/>*</li>
</ul>
</li>
<li>Manual black level locking<ul>
<li><a href="#controls_android.blackLevel.lock">android.<wbr/>black<wbr/>Level.<wbr/>lock</a></li>
</ul>
</li>
</ul>
<p>If any of the above 3A algorithms are enabled,<wbr/> then the camera
device will accurately report the values applied by 3A in the
result.<wbr/></p>
<p>A given camera device may also support additional manual sensor controls,<wbr/>
but this capability only covers the above list of controls.<wbr/></p>
<p>If this is supported,<wbr/> <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> will
additionally return a min frame duration that is greater than
zero for each supported size-format combination.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">MANUAL_POST_PROCESSING</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>The camera device post-processing stages can be manually controlled.<wbr/>
The camera device supports basic manual control of the image post-processing
stages.<wbr/> This means the following controls are guaranteed to be supported:</p>
<ul>
<li>Manual tonemap control<ul>
<li><a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a></li>
<li><a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a></li>
<li><a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></li>
</ul>
</li>
<li>Manual white balance control<ul>
<li><a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a></li>
<li><a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a></li>
</ul>
</li>
<li>Manual lens shading map control<ul>
<li><a href="#controls_android.shading.mode">android.<wbr/>shading.<wbr/>mode</a></li>
<li><a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a></li>
<li><a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a></li>
<li><a href="#static_android.lens.info.shadingMapSize">android.<wbr/>lens.<wbr/>info.<wbr/>shading<wbr/>Map<wbr/>Size</a></li>
</ul>
</li>
<li>Manual aberration correction control (if aberration correction is supported)<ul>
<li><a href="#controls_android.colorCorrection.aberrationMode">android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode</a></li>
<li><a href="#static_android.colorCorrection.availableAberrationModes">android.<wbr/>color<wbr/>Correction.<wbr/>available<wbr/>Aberration<wbr/>Modes</a></li>
</ul>
</li>
</ul>
<p>If auto white balance is enabled,<wbr/> then the camera device
will accurately report the values applied by AWB in the result.<wbr/></p>
<p>A given camera device may also support additional post-processing
controls,<wbr/> but this capability only covers the above list of controls.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">RAW</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>The camera device supports outputting RAW buffers and
metadata for interpreting them.<wbr/></p>
<p>Devices supporting the RAW capability allow both for
saving DNG files,<wbr/> and for direct application processing of
raw sensor images.<wbr/></p>
<ul>
<li>RAW_<wbr/>SENSOR is supported as an output format.<wbr/></li>
<li>The maximum available resolution for RAW_<wbr/>SENSOR streams
  will match either the value in
  <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a> or
  <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></li>
<li>All DNG-related optional metadata entries are provided
  by the camera device.<wbr/></li>
</ul></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ZSL</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_optional">[hidden]</span>
                    <span class="entry_type_enum_notes"><p>The camera device supports the Zero Shutter Lag use case.<wbr/></p>
<ul>
<li>At least one input stream can be used.<wbr/></li>
<li>RAW_<wbr/>OPAQUE is supported as an output/<wbr/>input format</li>
<li>Using RAW_<wbr/>OPAQUE does not cause a frame rate drop
  relative to the sensor's maximum capture rate (at that
  resolution).<wbr/></li>
<li>RAW_<wbr/>OPAQUE will be reprocessable into both YUV_<wbr/>420_<wbr/>888
  and JPEG formats.<wbr/></li>
<li>The maximum available resolution for RAW_<wbr/>OPAQUE streams
  (both input/<wbr/>output) will match the maximum available
  resolution of JPEG streams.<wbr/></li>
</ul></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">READ_SENSOR_SETTINGS</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>The camera device supports accurately reporting the sensor settings for many of
the sensor controls while the built-in 3A algorithm is running.<wbr/>  This allows
reporting of sensor settings even when these settings cannot be manually changed.<wbr/></p>
<p>The values reported for the following controls are guaranteed to be available
in the CaptureResult,<wbr/> including when 3A is enabled:</p>
<ul>
<li>Exposure control<ul>
<li><a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a></li>
</ul>
</li>
<li>Sensitivity control<ul>
<li><a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a></li>
</ul>
</li>
<li>Lens controls (if the lens is adjustable)<ul>
<li><a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a></li>
<li><a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a></li>
</ul>
</li>
</ul>
<p>This capability is a subset of the MANUAL_<wbr/>SENSOR control capability,<wbr/> and will
always be included if the MANUAL_<wbr/>SENSOR capability is available.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">BURST_CAPTURE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>The camera device supports capturing maximum-resolution
images at &gt;= 20 frames per second,<wbr/> in at least the
uncompressed YUV format,<wbr/> when post-processing settings
are set to FAST.<wbr/></p>
<p>More specifically,<wbr/> this means that a size matching the
camera device's active array size is listed as a
supported size for the YUV_<wbr/>420_<wbr/>888 format in
<a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>,<wbr/> the minimum frame
duration for that format and size is &lt;= 1/<wbr/>20 s,<wbr/> and
the <a href="#static_android.control.aeAvailableTargetFpsRanges">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Target<wbr/>Fps<wbr/>Ranges</a> entry
lists at least one FPS range where the minimum FPS is</p>
<blockquote>
<p>= 1 /<wbr/> minimumFrameDuration for the maximum-size
YUV_<wbr/>420_<wbr/>888 format.<wbr/></p>
</blockquote>
<p>In addition,<wbr/> the <a href="#static_android.sync.maxLatency">android.<wbr/>sync.<wbr/>max<wbr/>Latency</a> field is
guaranted to have a value between 0 and 4,<wbr/> inclusive.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of capabilities that this camera device
advertises as fully supporting.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>A capability is a contract that the camera device makes in order
to be able to satisfy one or more use cases.<wbr/></p>
<p>Listing a capability guarantees that the whole set of features
required to support a common use will all be available.<wbr/></p>
<p>Using a subset of the functionality provided by an unsupported
capability may be possible on a specific camera device implementation;
to do this query each of <a href="#static_android.request.availableRequestKeys">android.<wbr/>request.<wbr/>available<wbr/>Request<wbr/>Keys</a>,<wbr/>
<a href="#static_android.request.availableResultKeys">android.<wbr/>request.<wbr/>available<wbr/>Result<wbr/>Keys</a>,<wbr/>
<a href="#static_android.request.availableCharacteristicsKeys">android.<wbr/>request.<wbr/>available<wbr/>Characteristics<wbr/>Keys</a>.<wbr/></p>
<p>The following capabilities are guaranteed to be available on
<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> <code>==</code> FULL devices:</p>
<ul>
<li>MANUAL_<wbr/>SENSOR</li>
<li>MANUAL_<wbr/>POST_<wbr/>PROCESSING</li>
</ul>
<p>Other capabilities may be available on either FULL or LIMITED
devices,<wbr/> but the application should query this key to be sure.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Additional constraint details per-capability will be available
in the Compatibility Test Suite.<wbr/></p>
<p>Minimum baseline requirements required for the
BACKWARD_<wbr/>COMPATIBLE capability are not explicitly listed.<wbr/>
Instead refer to "BC" tags and the camera CTS tests in the
android.<wbr/>hardware.<wbr/>camera2.<wbr/>cts package.<wbr/></p>
<p>Listed controls that can be either request or result (e.<wbr/>g.<wbr/>
<a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>) must be available both in the
request and the result in order to be considered to be
capability-compliant.<wbr/></p>
<p>For example,<wbr/> if the HAL claims to support MANUAL control,<wbr/>
then exposure time must be configurable via the request <em>and</em>
the actual exposure applied must be available via
the result.<wbr/></p>
<p>If MANUAL_<wbr/>SENSOR is omitted,<wbr/> the HAL may choose to omit the
<a href="#static_android.scaler.availableMinFrameDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Min<wbr/>Frame<wbr/>Durations</a> static property entirely.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.request.availableRequestKeys">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>request.<wbr/>available<wbr/>Request<wbr/>Keys
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A list of all keys that the camera device has available
to use with CaptureRequest.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Attempting to set a key into a CaptureRequest that is not
listed here will result in an invalid request and will be rejected
by the camera device.<wbr/></p>
<p>This field can be used to query the feature set of a camera device
at a more granular level than capabilities.<wbr/> This is especially
important for optional keys that are not listed under any capability
in <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Vendor tags must not be listed here.<wbr/> Use the vendor tag metadata
extensions C api instead (refer to camera3.<wbr/>h for more details).<wbr/></p>
<p>Setting/<wbr/>getting vendor tags will be checked against the metadata
vendor extensions API and not against this field.<wbr/></p>
<p>The HAL must not consume any request tags that are not listed either
here or in the vendor tag list.<wbr/></p>
<p>The public camera2 API will always make the vendor tags visible
via CameraCharacteristics#getAvailableCaptureRequestKeys.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.request.availableResultKeys">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>request.<wbr/>available<wbr/>Result<wbr/>Keys
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A list of all keys that the camera device has available
to use with CaptureResult.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Attempting to get a key from a CaptureResult that is not
listed here will always return a <code>null</code> value.<wbr/> Getting a key from
a CaptureResult that is listed here will generally never return a <code>null</code>
value.<wbr/></p>
<p>The following keys may return <code>null</code> unless they are enabled:</p>
<ul>
<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>
</ul>
<p>(Those sometimes-null keys will nevertheless be listed here
if they are available.<wbr/>)</p>
<p>This field can be used to query the feature set of a camera device
at a more granular level than capabilities.<wbr/> This is especially
important for optional keys that are not listed under any capability
in <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Tags listed here must always have an entry in the result metadata,<wbr/>
even if that size is 0 elements.<wbr/> Only array-type tags (e.<wbr/>g.<wbr/> lists,<wbr/>
matrices,<wbr/> strings) are allowed to have 0 elements.<wbr/></p>
<p>Vendor tags must not be listed here.<wbr/> Use the vendor tag metadata
extensions C api instead (refer to camera3.<wbr/>h for more details).<wbr/></p>
<p>Setting/<wbr/>getting vendor tags will be checked against the metadata
vendor extensions API and not against this field.<wbr/></p>
<p>The HAL must not produce any result tags that are not listed either
here or in the vendor tag list.<wbr/></p>
<p>The public camera2 API will always make the vendor tags visible
via CameraCharacteristics#getAvailableCaptureResultKeys.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.request.availableCharacteristicsKeys">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>request.<wbr/>available<wbr/>Characteristics<wbr/>Keys
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A list of all keys that the camera device has available
to use with CameraCharacteristics.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This entry follows the same rules as
<a href="#static_android.request.availableResultKeys">android.<wbr/>request.<wbr/>available<wbr/>Result<wbr/>Keys</a> (except that it applies for
CameraCharacteristics instead of CaptureResult).<wbr/> See above for more
details.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Keys listed here must always have an entry in the static info metadata,<wbr/>
even if that size is 0 elements.<wbr/> Only array-type tags (e.<wbr/>g.<wbr/> lists,<wbr/>
matrices,<wbr/> strings) are allowed to have 0 elements.<wbr/></p>
<p>Vendor tags must not be listed here.<wbr/> Use the vendor tag metadata
extensions C api instead (refer to camera3.<wbr/>h for more details).<wbr/></p>
<p>Setting/<wbr/>getting vendor tags will be checked against the metadata
vendor extensions API and not against this field.<wbr/></p>
<p>The HAL must not have any tags in its static info that are not listed
either here or in the vendor tag list.<wbr/></p>
<p>The public camera2 API will always make the vendor tags visible
via CameraCharacteristics#getKeys.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.request.frameCount">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>request.<wbr/>frame<wbr/>Count
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [hidden]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A frame counter set by the framework.<wbr/> This value monotonically
increases with every new result (that is,<wbr/> each new result has a unique
frameCount value).<wbr/></p>
            </td>

            <td class="entry_units">
              count of frames
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
              <p>&gt; 0</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Reset on release()</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.request.id">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>request.<wbr/>id
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [hidden]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>An application-specified ID for the current
request.<wbr/> Must be maintained unchanged in output
frame</p>
            </td>

            <td class="entry_units">
              arbitrary integer assigned by application
            </td>

            <td class="entry_range">
              <p>Any int</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.request.metadataMode">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>request.<wbr/>metadata<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [system]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">NONE</span>
                    <span class="entry_type_enum_notes"><p>No metadata should be produced on output,<wbr/> except
for application-bound buffer data.<wbr/> If no
application-bound streams exist,<wbr/> no frame should be
placed in the output frame queue.<wbr/> If such streams
exist,<wbr/> a frame should be placed on the output queue
with null metadata but with the necessary output buffer
information.<wbr/> Timestamp information should still be
included with any output stream buffers</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FULL</span>
                    <span class="entry_type_enum_notes"><p>All metadata should be produced.<wbr/> Statistics will
only be produced if they are separately
enabled</p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>How much metadata to produce on
output</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.request.outputStreams">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>request.<wbr/>output<wbr/>Streams
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [system]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Lists which camera output streams image data
from this capture must be sent to</p>
            </td>

            <td class="entry_units">
              List of camera stream IDs
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
              <p>List must only include streams that have been
created</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_HAL2">HAL2</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If no output streams are listed,<wbr/> then the image
data should simply be discarded.<wbr/> The image data must
still be captured for metadata and statistics production,<wbr/>
and the lens and flash must operate as requested.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.request.pipelineDepth">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>request.<wbr/>pipeline<wbr/>Depth
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Specifies the number of pipeline stages the frame went
through from when it was exposed to when the final completed result
was available to the framework.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>&lt;= <a href="#static_android.request.pipelineMaxDepth">android.<wbr/>request.<wbr/>pipeline<wbr/>Max<wbr/>Depth</a></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Depending on what settings are used in the request,<wbr/> and
what streams are configured,<wbr/> the data may undergo less processing,<wbr/>
and some pipeline stages skipped.<wbr/></p>
<p>See <a href="#static_android.request.pipelineMaxDepth">android.<wbr/>request.<wbr/>pipeline<wbr/>Max<wbr/>Depth</a> for more details.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This value must always represent the accurate count of how many
pipeline stages were actually used.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_scaler" class="section">scaler</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.scaler.cropRegion">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>scaler.<wbr/>crop<wbr/>Region
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4
                </span>
              <span class="entry_type_visibility"> [public as rectangle]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired region of the sensor to read out for this capture.<wbr/></p>
            </td>

            <td class="entry_units">
              Pixel coordinates relative to
          android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control can be used to implement digital zoom.<wbr/></p>
<p>The crop region coordinate system is based off
<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
top-left corner of the sensor active array.<wbr/></p>
<p>Output streams use this rectangle to produce their output,<wbr/>
cropping to a smaller region if necessary to maintain the
stream's aspect ratio,<wbr/> then scaling the sensor input to
match the output's configured resolution.<wbr/></p>
<p>The crop region is applied after the RAW to other color
space (e.<wbr/>g.<wbr/> YUV) conversion.<wbr/> Since raw streams
(e.<wbr/>g.<wbr/> RAW16) don't have the conversion stage,<wbr/> they are not
croppable.<wbr/> The crop region will be ignored by raw streams.<wbr/></p>
<p>For non-raw streams,<wbr/> any additional per-stream cropping will
be done to maximize the final pixel area of the stream.<wbr/></p>
<p>For example,<wbr/> if the crop region is set to a 4:3 aspect
ratio,<wbr/> then 4:3 streams will use the exact crop
region.<wbr/> 16:9 streams will further crop vertically
(letterbox).<wbr/></p>
<p>Conversely,<wbr/> if the crop region is set to a 16:9,<wbr/> then 4:3
outputs will crop horizontally (pillarbox),<wbr/> and 16:9
streams will match exactly.<wbr/> These additional crops will
be centered within the crop region.<wbr/></p>
<p>The width and height of the crop region cannot
be set to be smaller than
<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
<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>
<p>The camera device may adjust the crop region to account
for rounding and other hardware requirements; the final
crop region used will be included in the output capture
result.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The output streams must maintain square pixels at all
times,<wbr/> no matter what the relative aspect ratios of the
crop region and the stream are.<wbr/>  Negative values for
corner are allowed for raw output if full pixel array is
larger than active pixel array.<wbr/> Width and height may be
rounded to nearest larger supportable width,<wbr/> especially
for raw output,<wbr/> where only a few fixed scales may be
possible.<wbr/></p>
<p>HAL2.<wbr/>x uses only (x,<wbr/> y,<wbr/> width)</p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.scaler.availableFormats">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="5">
              android.<wbr/>scaler.<wbr/>available<wbr/>Formats
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [hidden as imageFormat]</span>



              <span class="entry_type_deprecated">[deprecated] </span>


                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">RAW16</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_value">0x20</span>
                    <span class="entry_type_enum_notes"><p>RAW16 is a standard,<wbr/> cross-platform format for raw image
buffers with 16-bit pixels.<wbr/></p>
<p>Buffers of this format are typically expected to have a
Bayer Color Filter Array (CFA) layout,<wbr/> which is given in
<a href="#static_android.sensor.info.colorFilterArrangement">android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement</a>.<wbr/> Sensors with
CFAs that are not representable by a format in
<a href="#static_android.sensor.info.colorFilterArrangement">android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement</a> should not
use this format.<wbr/></p>
<p>Buffers of this format will also follow the constraints given for
RAW_<wbr/>OPAQUE buffers,<wbr/> but with relaxed performance constraints.<wbr/></p>
<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 performance guarantees.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">RAW_OPAQUE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_value">0x24</span>
                    <span class="entry_type_enum_notes"><p>RAW_<wbr/>OPAQUE is a format for raw image buffers coming from an
image sensor.<wbr/></p>
<p>The actual structure of buffers of this format is
platform-specific,<wbr/> but must follow several constraints:</p>
<ol>
<li>No image post-processing operations may have been applied to
buffers of this type.<wbr/> These buffers contain raw image data coming
directly from the image sensor.<wbr/></li>
<li>If a buffer of this format is passed to the camera device for
reprocessing,<wbr/> the resulting images will be identical to the images
produced if the buffer had come directly from the sensor and was
processed with the same settings.<wbr/></li>
</ol>
<p>The intended use for this format is to allow access to the native
raw format buffers coming directly from the camera sensor without
any additional conversions or decrease in framerate.<wbr/></p>
<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
performance guarantees.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">YV12</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_value">0x32315659</span>
                    <span class="entry_type_enum_notes"><p>YCrCb 4:2:0 Planar</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">YCrCb_420_SP</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_value">0x11</span>
                    <span class="entry_type_enum_notes"><p>NV21</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">IMPLEMENTATION_DEFINED</span>
                    <span class="entry_type_enum_value">0x22</span>
                    <span class="entry_type_enum_notes"><p>System internal format,<wbr/> not application-accessible</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">YCbCr_420_888</span>
                    <span class="entry_type_enum_value">0x23</span>
                    <span class="entry_type_enum_notes"><p>Flexible YUV420 Format</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">BLOB</span>
                    <span class="entry_type_enum_value">0x21</span>
                    <span class="entry_type_enum_notes"><p>JPEG format</p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The list of image formats that are supported by this
camera device for output streams.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>All camera devices will support JPEG and YUV_<wbr/>420_<wbr/>888 formats.<wbr/></p>
<p>When set to YUV_<wbr/>420_<wbr/>888,<wbr/> application can access the YUV420 data directly.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>These format values are from HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>* in
system/<wbr/>core/<wbr/>include/<wbr/>system/<wbr/>graphics.<wbr/>h.<wbr/></p>
<p>When IMPLEMENTATION_<wbr/>DEFINED is used,<wbr/> the platform
gralloc module will select a format based on the usage flags provided
by the camera HAL device and the other endpoint of the stream.<wbr/> It is
usually used by preview and recording streams,<wbr/> where the application doesn't
need access the image data.<wbr/></p>
<p>YCb<wbr/>Cr_<wbr/>420_<wbr/>888 format must be supported by the HAL.<wbr/> When an image stream
needs CPU/<wbr/>application direct access,<wbr/> this format will be used.<wbr/></p>
<p>The BLOB format must be supported by the HAL.<wbr/> This is used for the JPEG stream.<wbr/></p>
<p>A RAW_<wbr/>OPAQUE buffer should contain only pixel data.<wbr/> It is strongly
recommended that any information used by the camera device when
processing images is fully expressed by the result metadata
for that image buffer.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.availableJpegMinDurations">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>scaler.<wbr/>available<wbr/>Jpeg<wbr/>Min<wbr/>Durations
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [hidden]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The minimum frame duration that is supported
for each resolution in <a href="#static_android.scaler.availableJpegSizes">android.<wbr/>scaler.<wbr/>available<wbr/>Jpeg<wbr/>Sizes</a>.<wbr/></p>
            </td>

            <td class="entry_units">
              Nanoseconds
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
              <p>TODO: Remove property.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This corresponds to the minimum steady-state frame duration when only
that JPEG stream is active and captured in a burst,<wbr/> with all
processing (typically in android.<wbr/>*.<wbr/>mode) set to FAST.<wbr/></p>
<p>When multiple streams are configured,<wbr/> the minimum
frame duration will be &gt;= max(individual stream min
durations)</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.availableJpegSizes">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="5">
              android.<wbr/>scaler.<wbr/>available<wbr/>Jpeg<wbr/>Sizes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 2
                </span>
              <span class="entry_type_visibility"> [hidden as size]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The JPEG resolutions that are supported by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
              <p>TODO: Remove property.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The resolutions are listed as <code>(width,<wbr/> height)</code> pairs.<wbr/> All camera devices will support
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>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The HAL must include 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/>
and should include half/<wbr/>quarter of sensor maximum resolution.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.availableMaxDigitalZoom">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>scaler.<wbr/>available<wbr/>Max<wbr/>Digital<wbr/>Zoom
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The maximum ratio between both active area width
and crop region width,<wbr/> and active area height and
crop region height,<wbr/> for <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a>.<wbr/></p>
            </td>

            <td class="entry_units">
              Zoom scale factor
            </td>

            <td class="entry_range">
              <p>&gt;=1</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This represents the maximum amount of zooming possible by
the camera device,<wbr/> or equivalently,<wbr/> the minimum cropping
window size.<wbr/></p>
<p>Crop regions that have a width or height that is smaller
than this ratio allows will be rounded up to the minimum
allowed size by the camera device.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.availableProcessedMinDurations">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>scaler.<wbr/>available<wbr/>Processed<wbr/>Min<wbr/>Durations
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [hidden]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>For each available processed output size (defined in
<a href="#static_android.scaler.availableProcessedSizes">android.<wbr/>scaler.<wbr/>available<wbr/>Processed<wbr/>Sizes</a>),<wbr/> this property lists the
minimum supportable frame duration for that size.<wbr/></p>
            </td>

            <td class="entry_units">
              Nanoseconds
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This should correspond to the frame duration when only that processed
stream is active,<wbr/> with all processing (typically in android.<wbr/>*.<wbr/>mode)
set to FAST.<wbr/></p>
<p>When multiple streams are configured,<wbr/> the minimum frame duration will
be &gt;= max(individual stream min durations).<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.availableProcessedSizes">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="5">
              android.<wbr/>scaler.<wbr/>available<wbr/>Processed<wbr/>Sizes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 2
                </span>
              <span class="entry_type_visibility"> [hidden as size]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The resolutions available for use with
processed output streams,<wbr/> such as YV12,<wbr/> NV12,<wbr/> and
platform opaque YUV/<wbr/>RGB streams to the GPU or video
encoders.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The resolutions are listed as <code>(width,<wbr/> height)</code> pairs.<wbr/></p>
<p>For a given use case,<wbr/> the actual maximum supported resolution
may be lower than what is listed here,<wbr/> depending on the destination
Surface for the image data.<wbr/> For example,<wbr/> for recording video,<wbr/>
the video encoder chosen may have a maximum size limit (e.<wbr/>g.<wbr/> 1080p)
smaller than what the camera (e.<wbr/>g.<wbr/> maximum resolution is 3264x2448)
can provide.<wbr/></p>
<p>Please reference the documentation for the image data destination to
check if it limits the maximum size for image data.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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/>
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>
and each below resolution if it is smaller than or equal to the sensor
maximum resolution (if they are not listed in JPEG sizes already):</p>
<ul>
<li>240p (320 x 240)</li>
<li>480p (640 x 480)</li>
<li>720p (1280 x 720)</li>
<li>1080p (1920 x 1080)</li>
</ul>
<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/>
the HAL only has to list up to the maximum video size supported by the devices.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.availableRawMinDurations">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>scaler.<wbr/>available<wbr/>Raw<wbr/>Min<wbr/>Durations
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [system]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>For each available raw output size (defined in
<a href="#static_android.scaler.availableRawSizes">android.<wbr/>scaler.<wbr/>available<wbr/>Raw<wbr/>Sizes</a>),<wbr/> this property lists the minimum
supportable frame duration for that size.<wbr/></p>
            </td>

            <td class="entry_units">
              Nanoseconds
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Should correspond to the frame duration when only the raw stream is
active.<wbr/></p>
<p>When multiple streams are configured,<wbr/> the minimum
frame duration will be &gt;= max(individual stream min
durations)</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.availableRawSizes">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="1">
              android.<wbr/>scaler.<wbr/>available<wbr/>Raw<wbr/>Sizes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 2
                </span>
              <span class="entry_type_visibility"> [system as size]</span>



              <span class="entry_type_deprecated">[deprecated] </span>



            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The resolutions available for use with raw
sensor output streams,<wbr/> listed as width,<wbr/>
height</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.availableInputOutputFormatsMap">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [hidden as imageFormat]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The mapping of image formats that are supported by this
camera device for input streams,<wbr/> to their corresponding output formats.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>All camera devices with at least 1
<a href="#static_android.request.maxNumInputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Input<wbr/>Streams</a> will have at least one
available input format.<wbr/></p>
<p>The camera device will support the following map of formats,<wbr/>
if its dependent capability is supported:</p>
<table>
<thead>
<tr>
<th align="left">Input Format</th>
<th align="left">Output Format</th>
<th align="left">Capability</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">RAW_<wbr/>OPAQUE</td>
<td align="left">JPEG</td>
<td align="left">ZSL</td>
</tr>
<tr>
<td align="left">RAW_<wbr/>OPAQUE</td>
<td align="left">YUV_<wbr/>420_<wbr/>888</td>
<td align="left">ZSL</td>
</tr>
<tr>
<td align="left">RAW_<wbr/>OPAQUE</td>
<td align="left">RAW16</td>
<td align="left">RAW</td>
</tr>
<tr>
<td align="left">RAW16</td>
<td align="left">YUV_<wbr/>420_<wbr/>888</td>
<td align="left">RAW</td>
</tr>
<tr>
<td align="left">RAW16</td>
<td align="left">JPEG</td>
<td align="left">RAW</td>
</tr>
</tbody>
</table>
<p>For ZSL-capable camera devices,<wbr/> using the RAW_<wbr/>OPAQUE format
as either input or output will never hurt maximum frame rate (i.<wbr/>e.<wbr/>
Stream<wbr/>Configuration<wbr/>Map#get<wbr/>Output<wbr/>Stall<wbr/>Duration(int,<wbr/>Size)
for a <code>format =</code> RAW_<wbr/>OPAQUE is always 0).<wbr/></p>
<p>Attempting to configure an input stream with output streams not
listed as available in this map is not valid.<wbr/></p>
<p>TODO: typedef to ReprocessFormatMap</p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For the formats,<wbr/> see <code>system/<wbr/>core/<wbr/>include/<wbr/>system/<wbr/>graphics.<wbr/>h</code> for a definition
of the image format enumerations.<wbr/></p>
<p>This value is encoded as a variable-size array-of-arrays.<wbr/>
The inner array always contains <code>[format,<wbr/> length,<wbr/> ...<wbr/>]</code> where
<code>...<wbr/></code> has <code>length</code> elements.<wbr/> An inner array is followed by another
inner array if the total metadata entry size hasn't yet been exceeded.<wbr/></p>
<p>A code sample to read/<wbr/>write this encoding (with a device that
supports reprocessing RAW_<wbr/>OPAQUE to RAW16,<wbr/> YUV_<wbr/>420_<wbr/>888,<wbr/> and JPEG,<wbr/>
and reprocessing RAW16 to YUV_<wbr/>420_<wbr/>888 and JPEG):</p>
<pre><code>//<wbr/> reading
int32_<wbr/>t* contents = &amp;entry.<wbr/>i32[0];
for (size_<wbr/>t i = 0; i &lt; entry.<wbr/>count; ) {
    int32_<wbr/>t format = contents[i++];
    int32_<wbr/>t length = contents[i++];
    int32_<wbr/>t output_<wbr/>formats[length];
    memcpy(&amp;output_<wbr/>formats[0],<wbr/> &amp;contents[i],<wbr/>
           length * sizeof(int32_<wbr/>t));
    i += length;
}

//<wbr/> writing (static example,<wbr/> RAW+ZSL)
int32_<wbr/>t[] contents = {
  RAW_<wbr/>OPAQUE,<wbr/> 3,<wbr/> RAW16,<wbr/> YUV_<wbr/>420_<wbr/>888,<wbr/> BLOB,<wbr/>
  RAW16,<wbr/> 2,<wbr/> YUV_<wbr/>420_<wbr/>888,<wbr/> BLOB,<wbr/>
};
update_<wbr/>camera_<wbr/>metadata_<wbr/>entry(metadata,<wbr/> index,<wbr/> &amp;contents[0],<wbr/>
      sizeof(contents)/<wbr/>sizeof(contents[0]),<wbr/> &amp;updated_<wbr/>entry);
</code></pre>
<p>If the HAL claims to support any of the capabilities listed in the
above details,<wbr/> then it must also support all the input-output
combinations listed for that capability.<wbr/> It can optionally support
additional formats if it so chooses.<wbr/></p>
<p>Refer to <a href="#static_android.scaler.availableFormats">android.<wbr/>scaler.<wbr/>available<wbr/>Formats</a> for the enum values
which correspond to HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>* in
system/<wbr/>core/<wbr/>include/<wbr/>system/<wbr/>graphics.<wbr/>h.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.availableStreamConfigurations">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 4
                </span>
              <span class="entry_type_visibility"> [hidden as streamConfiguration]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OUTPUT</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">INPUT</span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The available stream configurations that this
camera device supports
(i.<wbr/>e.<wbr/> format,<wbr/> width,<wbr/> height,<wbr/> output/<wbr/>input stream).<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The configurations are listed as <code>(format,<wbr/> width,<wbr/> height,<wbr/> input?)</code>
tuples.<wbr/></p>
<p>For a given use case,<wbr/> the actual maximum supported resolution
may be lower than what is listed here,<wbr/> depending on the destination
Surface for the image data.<wbr/> For example,<wbr/> for recording video,<wbr/>
the video encoder chosen may have a maximum size limit (e.<wbr/>g.<wbr/> 1080p)
smaller than what the camera (e.<wbr/>g.<wbr/> maximum resolution is 3264x2448)
can provide.<wbr/></p>
<p>Please reference the documentation for the image data destination to
check if it limits the maximum size for image data.<wbr/></p>
<p>Not all output formats may be supported in a configuration with
an input stream of a particular format.<wbr/> For more details,<wbr/> see
<a href="#static_android.scaler.availableInputOutputFormatsMap">android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map</a>.<wbr/></p>
<p>The following table describes the minimum required output stream
configurations based on the hardware level
(<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a>):</p>
<table>
<thead>
<tr>
<th align="center">Format</th>
<th align="center">Size</th>
<th align="center">Hardware Level</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">JPEG</td>
<td align="center"><a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></td>
<td align="center">Any</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">1920x1080 (1080p)</td>
<td align="center">Any</td>
<td align="center">if 1080p &lt;= activeArraySize</td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">1280x720 (720)</td>
<td align="center">Any</td>
<td align="center">if 720p &lt;= activeArraySize</td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">640x480 (480p)</td>
<td align="center">Any</td>
<td align="center">if 480p &lt;= activeArraySize</td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">320x240 (240p)</td>
<td align="center">Any</td>
<td align="center">if 240p &lt;= activeArraySize</td>
</tr>
<tr>
<td align="center">YUV_<wbr/>420_<wbr/>888</td>
<td align="center">all output sizes available for JPEG</td>
<td align="center">FULL</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">YUV_<wbr/>420_<wbr/>888</td>
<td align="center">all output sizes available for JPEG,<wbr/> up to the maximum video size</td>
<td align="center">LIMITED</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">IMPLEMENTATION_<wbr/>DEFINED</td>
<td align="center">same as YUV_<wbr/>420_<wbr/>888</td>
<td align="center">Any</td>
<td align="center"></td>
</tr>
</tbody>
</table>
<p>Refer to <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> for additional
mandatory stream configurations on a per-capability basis.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>It is recommended (but not mandatory) to also include half/<wbr/>quarter
of sensor maximum resolution for JPEG formats (regardless of hardware
level).<wbr/></p>
<p>(The following is a rewording of the above required table):</p>
<p>For JPEG format,<wbr/> the sizes may be restricted by below conditions:</p>
<ul>
<li>The HAL may choose the aspect ratio of each Jpeg size to be one of well known ones
(e.<wbr/>g.<wbr/> 4:3,<wbr/> 16:9,<wbr/> 3:2 etc.<wbr/>).<wbr/> If the sensor maximum resolution
(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/>
it does not have to be included in the supported JPEG sizes.<wbr/></li>
<li>Some hardware JPEG encoders may have pixel boundary alignment requirements,<wbr/> such as
the dimensions being a multiple of 16.<wbr/></li>
</ul>
<p>Therefore,<wbr/> the maximum JPEG size may be smaller than sensor maximum resolution.<wbr/>
However,<wbr/> the largest JPEG size must be as close as possible to the sensor maximum
resolution given above constraints.<wbr/> It is required that after aspect ratio adjustments,<wbr/>
additional size reduction due to other issues must be less than 3% in area.<wbr/> For example,<wbr/>
if the sensor maximum resolution is 3280x2464,<wbr/> if the maximum JPEG size has aspect
ratio 4:3,<wbr/> the JPEG encoder alignment requirement is 16,<wbr/> the maximum JPEG size will be
3264x2448.<wbr/></p>
<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/>
the HAL must include all YUV_<wbr/>420_<wbr/>888 sizes that have JPEG sizes listed
here as output streams.<wbr/></p>
<p>It must also include each below resolution if it is smaller than or
equal to the sensor maximum resolution (for both YUV_<wbr/>420_<wbr/>888 and JPEG
formats),<wbr/> as output streams:</p>
<ul>
<li>240p (320 x 240)</li>
<li>480p (640 x 480)</li>
<li>720p (1280 x 720)</li>
<li>1080p (1920 x 1080)</li>
</ul>
<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/>
the HAL only has to list up to the maximum video size
supported by the device.<wbr/></p>
<p>Regardless of hardware level,<wbr/> every output resolution available for
YUV_<wbr/>420_<wbr/>888 must also be available for IMPLEMENTATION_<wbr/>DEFINED.<wbr/></p>
<p>This supercedes the following fields,<wbr/> which are now deprecated:</p>
<ul>
<li>availableFormats</li>
<li>available[Processed,<wbr/>Raw,<wbr/>Jpeg]Sizes</li>
</ul>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.availableMinFrameDurations">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>scaler.<wbr/>available<wbr/>Min<wbr/>Frame<wbr/>Durations
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4 x n
                </span>
              <span class="entry_type_visibility"> [hidden as streamConfigurationDuration]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>This lists the minimum frame duration for each
format/<wbr/>size combination.<wbr/></p>
            </td>

            <td class="entry_units">
              (format,<wbr/> width,<wbr/> height,<wbr/> ns) x n
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This should correspond to the frame duration when only that
stream is active,<wbr/> with all processing (typically in android.<wbr/>*.<wbr/>mode)
set to either OFF or FAST.<wbr/></p>
<p>When multiple streams are used in a request,<wbr/> the minimum frame
duration will be max(individual stream min durations).<wbr/></p>
<p>The minimum frame duration of a stream (of a particular format,<wbr/> size)
is the same regardless of whether the stream is input or output.<wbr/></p>
<p>See <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> and
<a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a> for more details about
calculating the max frame rate.<wbr/></p>
<p>(Keep in sync with
StreamConfigurationMap#getOutputMinFrameDuration)</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.availableStallDurations">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4 x n
                </span>
              <span class="entry_type_visibility"> [hidden as streamConfigurationDuration]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>This lists the maximum stall duration for each
format/<wbr/>size combination.<wbr/></p>
            </td>

            <td class="entry_units">
              (format,<wbr/> width,<wbr/> height,<wbr/> ns) x n
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>A stall duration is how much extra time would get added
to the normal minimum frame duration for a repeating request
that has streams with non-zero stall.<wbr/></p>
<p>For example,<wbr/> consider JPEG captures which have the following
characteristics:</p>
<ul>
<li>JPEG streams act like processed YUV streams in requests for which
they are not included; in requests in which they are directly
referenced,<wbr/> they act as JPEG streams.<wbr/> This is because supporting a
JPEG stream requires the underlying YUV data to always be ready for
use by a JPEG encoder,<wbr/> but the encoder will only be used (and impact
frame duration) on requests that actually reference a JPEG stream.<wbr/></li>
<li>The JPEG processor can run concurrently to the rest of the camera
pipeline,<wbr/> but cannot process more than 1 capture at a time.<wbr/></li>
</ul>
<p>In other words,<wbr/> using a repeating YUV request would result
in a steady frame rate (let's say it's 30 FPS).<wbr/> If a single
JPEG request is submitted periodically,<wbr/> the frame rate will stay
at 30 FPS (as long as we wait for the previous JPEG to return each
time).<wbr/> If we try to submit a repeating YUV + JPEG request,<wbr/> then
the frame rate will drop from 30 FPS.<wbr/></p>
<p>In general,<wbr/> submitting a new request with a non-0 stall time
stream will <em>not</em> cause a frame rate drop unless there are still
outstanding buffers for that stream from previous requests.<wbr/></p>
<p>Submitting a repeating request with streams (call this <code>S</code>)
is the same as setting the minimum frame duration from
the normal minimum frame duration corresponding to <code>S</code>,<wbr/> added with
the maximum stall duration for <code>S</code>.<wbr/></p>
<p>If interleaving requests with and without a stall duration,<wbr/>
a request will stall by the maximum of the remaining times
for each can-stall stream with outstanding buffers.<wbr/></p>
<p>This means that a stalling request will not have an exposure start
until the stall has completed.<wbr/></p>
<p>This should correspond to the stall duration when only that stream is
active,<wbr/> with all processing (typically in android.<wbr/>*.<wbr/>mode) set to FAST
or OFF.<wbr/> Setting any of the processing modes to HIGH_<wbr/>QUALITY
effectively results in an indeterminate stall duration for all
streams in a request (the regular stall calculation rules are
ignored).<wbr/></p>
<p>The following formats may always have a stall duration:</p>
<ul>
<li>ImageFormat#JPEG</li>
<li>ImageFormat#RAW_<wbr/>SENSOR</li>
</ul>
<p>The following formats will never have a stall duration:</p>
<ul>
<li>Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</li>
</ul>
<p>All other formats may or may not have an allowed stall duration on
a per-capability basis; refer to <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
for more details.<wbr/></p>
<p>See <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> for more information about
calculating the max frame rate (absent stalls).<wbr/></p>
<p>(Keep up to date with
StreamConfigurationMap#getOutputStallDuration(int,<wbr/> Size) )</p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If possible,<wbr/> it is recommended that all non-JPEG formats
(such as RAW16) should not have a stall duration.<wbr/> RAW10,<wbr/> RAW_<wbr/>OPAQUE and
IMPLEMENTATION_<wbr/>DEFINED must not have stall durations.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.streamConfigurationMap">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public as streamConfigurationMap]</span>

              <span class="entry_type_synthetic">[synthetic] </span>

              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The available stream configurations that this
camera device supports; also includes the minimum frame durations
and the stall durations for each format/<wbr/>size combination.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>All camera devices will support sensor maximum resolution (defined by
<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>
<p>For a given use case,<wbr/> the actual maximum supported resolution
may be lower than what is listed here,<wbr/> depending on the destination
Surface for the image data.<wbr/> For example,<wbr/> for recording video,<wbr/>
the video encoder chosen may have a maximum size limit (e.<wbr/>g.<wbr/> 1080p)
smaller than what the camera (e.<wbr/>g.<wbr/> maximum resolution is 3264x2448)
can provide.<wbr/></p>
<p>Please reference the documentation for the image data destination to
check if it limits the maximum size for image data.<wbr/></p>
<p>The following table describes the minimum required output stream
configurations based on the hardware level
(<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a>):</p>
<table>
<thead>
<tr>
<th align="center">Format</th>
<th align="center">Size</th>
<th align="center">Hardware Level</th>
<th align="center">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">JPEG</td>
<td align="center"><a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></td>
<td align="center">Any</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">1920x1080 (1080p)</td>
<td align="center">Any</td>
<td align="center">if 1080p &lt;= activeArraySize</td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">1280x720 (720)</td>
<td align="center">Any</td>
<td align="center">if 720p &lt;= activeArraySize</td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">640x480 (480p)</td>
<td align="center">Any</td>
<td align="center">if 480p &lt;= activeArraySize</td>
</tr>
<tr>
<td align="center">JPEG</td>
<td align="center">320x240 (240p)</td>
<td align="center">Any</td>
<td align="center">if 240p &lt;= activeArraySize</td>
</tr>
<tr>
<td align="center">YUV_<wbr/>420_<wbr/>888</td>
<td align="center">all output sizes available for JPEG</td>
<td align="center">FULL</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">YUV_<wbr/>420_<wbr/>888</td>
<td align="center">all output sizes available for JPEG,<wbr/> up to the maximum video size</td>
<td align="center">LIMITED</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">IMPLEMENTATION_<wbr/>DEFINED</td>
<td align="center">same as YUV_<wbr/>420_<wbr/>888</td>
<td align="center">Any</td>
<td align="center"></td>
</tr>
</tbody>
</table>
<p>Refer to <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> for additional
mandatory stream configurations on a per-capability basis.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Do not set this property directly
(it is synthetic and will not be available at the HAL layer);
set the <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a> instead.<wbr/></p>
<p>Not all output formats may be supported in a configuration with
an input stream of a particular format.<wbr/> For more details,<wbr/> see
<a href="#static_android.scaler.availableInputOutputFormatsMap">android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map</a>.<wbr/></p>
<p>It is recommended (but not mandatory) to also include half/<wbr/>quarter
of sensor maximum resolution for JPEG formats (regardless of hardware
level).<wbr/></p>
<p>(The following is a rewording of the above required table):</p>
<p>The HAL must include 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>
<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/>
the HAL must include all YUV_<wbr/>420_<wbr/>888 sizes that have JPEG sizes listed
here as output streams.<wbr/></p>
<p>It must also include each below resolution if it is smaller than or
equal to the sensor maximum resolution (for both YUV_<wbr/>420_<wbr/>888 and JPEG
formats),<wbr/> as output streams:</p>
<ul>
<li>240p (320 x 240)</li>
<li>480p (640 x 480)</li>
<li>720p (1280 x 720)</li>
<li>1080p (1920 x 1080)</li>
</ul>
<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/>
the HAL only has to list up to the maximum video size
supported by the device.<wbr/></p>
<p>Regardless of hardware level,<wbr/> every output resolution available for
YUV_<wbr/>420_<wbr/>888 must also be available for IMPLEMENTATION_<wbr/>DEFINED.<wbr/></p>
<p>This supercedes the following fields,<wbr/> which are now deprecated:</p>
<ul>
<li>availableFormats</li>
<li>available[Processed,<wbr/>Raw,<wbr/>Jpeg]Sizes</li>
</ul>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.scaler.croppingType">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>scaler.<wbr/>cropping<wbr/>Type
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">CENTER_ONLY</span>
                    <span class="entry_type_enum_notes"><p>The camera device only supports centered crop regions.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FREEFORM</span>
                    <span class="entry_type_enum_notes"><p>The camera device supports arbitrarily chosen crop regions.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The crop type that this camera device supports.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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
device that only supports CENTER_<wbr/>ONLY cropping,<wbr/> the camera device will move the
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>)
and keep the crop region width and height unchanged.<wbr/> The camera device will return the
final used crop region in metadata result <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a>.<wbr/></p>
<p>Camera devices that support FREEFORM cropping will support any crop region that
is inside of the active array.<wbr/> The camera device will apply the same crop region and
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>
<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
FREEFORM cropping.<wbr/> LEGACY capability devices will only support CENTER_<wbr/>ONLY cropping.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.scaler.cropRegion">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>scaler.<wbr/>crop<wbr/>Region
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4
                </span>
              <span class="entry_type_visibility"> [public as rectangle]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The desired region of the sensor to read out for this capture.<wbr/></p>
            </td>

            <td class="entry_units">
              Pixel coordinates relative to
          android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This control can be used to implement digital zoom.<wbr/></p>
<p>The crop region coordinate system is based off
<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
top-left corner of the sensor active array.<wbr/></p>
<p>Output streams use this rectangle to produce their output,<wbr/>
cropping to a smaller region if necessary to maintain the
stream's aspect ratio,<wbr/> then scaling the sensor input to
match the output's configured resolution.<wbr/></p>
<p>The crop region is applied after the RAW to other color
space (e.<wbr/>g.<wbr/> YUV) conversion.<wbr/> Since raw streams
(e.<wbr/>g.<wbr/> RAW16) don't have the conversion stage,<wbr/> they are not
croppable.<wbr/> The crop region will be ignored by raw streams.<wbr/></p>
<p>For non-raw streams,<wbr/> any additional per-stream cropping will
be done to maximize the final pixel area of the stream.<wbr/></p>
<p>For example,<wbr/> if the crop region is set to a 4:3 aspect
ratio,<wbr/> then 4:3 streams will use the exact crop
region.<wbr/> 16:9 streams will further crop vertically
(letterbox).<wbr/></p>
<p>Conversely,<wbr/> if the crop region is set to a 16:9,<wbr/> then 4:3
outputs will crop horizontally (pillarbox),<wbr/> and 16:9
streams will match exactly.<wbr/> These additional crops will
be centered within the crop region.<wbr/></p>
<p>The width and height of the crop region cannot
be set to be smaller than
<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
<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>
<p>The camera device may adjust the crop region to account
for rounding and other hardware requirements; the final
crop region used will be included in the output capture
result.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The output streams must maintain square pixels at all
times,<wbr/> no matter what the relative aspect ratios of the
crop region and the stream are.<wbr/>  Negative values for
corner are allowed for raw output if full pixel array is
larger than active pixel array.<wbr/> Width and height may be
rounded to nearest larger supportable width,<wbr/> especially
for raw output,<wbr/> where only a few fixed scales may be
possible.<wbr/></p>
<p>HAL2.<wbr/>x uses only (x,<wbr/> y,<wbr/> width)</p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_sensor" class="section">sensor</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.sensor.exposureTime">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>exposure<wbr/>Time
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Duration each pixel is exposed to
light.<wbr/></p>
            </td>

            <td class="entry_units">
              Nanoseconds
            </td>

            <td class="entry_range">
              <p><a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If the sensor can't expose this exact duration,<wbr/> it will shorten the
duration exposed to the nearest possible value (rather than expose longer).<wbr/>
The final exposure time used will be available in the output capture result.<wbr/></p>
<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
OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.sensor.frameDuration">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>frame<wbr/>Duration
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Duration from start of frame exposure to
start of next frame exposure.<wbr/></p>
            </td>

            <td class="entry_units">
              Nanoseconds
            </td>

            <td class="entry_range">
              <p>See <a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a>,<wbr/>
<a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/> The duration
is capped to <code>max(duration,<wbr/> exposureTime + overhead)</code>.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The maximum frame rate that can be supported by a camera subsystem is
a function of many factors:</p>
<ul>
<li>Requested resolutions of output image streams</li>
<li>Availability of binning /<wbr/> skipping modes on the imager</li>
<li>The bandwidth of the imager interface</li>
<li>The bandwidth of the various ISP processing blocks</li>
</ul>
<p>Since these factors can vary greatly between different ISPs and
sensors,<wbr/> the camera abstraction tries to represent the bandwidth
restrictions with as simple a model as possible.<wbr/></p>
<p>The model presented has the following characteristics:</p>
<ul>
<li>The image sensor is always configured to output the smallest
resolution possible given the application's requested output stream
sizes.<wbr/>  The smallest resolution is defined as being at least as large
as the largest requested output stream size; the camera pipeline must
never digitally upsample sensor data when the crop region covers the
whole sensor.<wbr/> In general,<wbr/> this means that if only small output stream
resolutions are configured,<wbr/> the sensor can provide a higher frame
rate.<wbr/></li>
<li>Since any request may use any or all the currently configured
output streams,<wbr/> the sensor and ISP must be configured to support
scaling a single capture to all the streams at the same time.<wbr/>  This
means the camera pipeline must be ready to produce the largest
requested output size without any delay.<wbr/>  Therefore,<wbr/> the overall
frame rate of a given configured stream set is governed only by the
largest requested stream resolution.<wbr/></li>
<li>Using more than one output stream in a request does not affect the
frame duration.<wbr/></li>
<li>Certain format-streams may need to do additional background processing
before data is consumed/<wbr/>produced by that stream.<wbr/> These processors
can run concurrently to the rest of the camera pipeline,<wbr/> but
cannot process more than 1 capture at a time.<wbr/></li>
</ul>
<p>The necessary information for the application,<wbr/> given the model above,<wbr/>
is provided via the <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> field
using StreamConfigurationMap#getOutputMinFrameDuration(int,<wbr/> Size).<wbr/>
These are used to determine the maximum frame rate /<wbr/> minimum frame
duration that is possible for a given stream configuration.<wbr/></p>
<p>Specifically,<wbr/> the application can use the following rules to
determine the minimum frame duration it can request from the camera
device:</p>
<ol>
<li>Let the set of currently configured input/<wbr/>output streams
be called <code>S</code>.<wbr/></li>
<li>Find the minimum frame durations for each stream in <code>S</code>,<wbr/> by
looking it up in <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> using
StreamConfigurationMap#getOutputMinFrameDuration(int,<wbr/> Size) (with
its respective size/<wbr/>format).<wbr/> Let this set of frame durations be called
<code>F</code>.<wbr/></li>
<li>For any given request <code>R</code>,<wbr/> the minimum frame duration allowed
for <code>R</code> is the maximum out of all values in <code>F</code>.<wbr/> Let the streams
used in <code>R</code> be called <code>S_<wbr/>r</code>.<wbr/></li>
</ol>
<p>If none of the streams in <code>S_<wbr/>r</code> have a stall time (listed in
StreamConfigurationMap#getOutputStallDuration(int,<wbr/>Size) using its
respective size/<wbr/>format),<wbr/> then the frame duration in
<code>F</code> determines the steady state frame rate that the application will
get if it uses <code>R</code> as a repeating request.<wbr/> Let this special kind
of request be called <code>Rsimple</code>.<wbr/></p>
<p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved
by a single capture of a new request <code>Rstall</code> (which has at least
one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the
same minimum frame duration this will not cause a frame rate loss
if all buffers from the previous <code>Rstall</code> have already been
delivered.<wbr/></p>
<p>For more details about stalling,<wbr/> see
StreamConfigurationMap#getOutputStallDuration(int,<wbr/>Size).<wbr/></p>
<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
OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For more details about stalling,<wbr/> see
<a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a>.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.sensor.sensitivity">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>sensitivity
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The amount of gain applied to sensor data
before processing.<wbr/></p>
            </td>

            <td class="entry_units">
              ISO arithmetic units
            </td>

            <td class="entry_range">
              <p><a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The sensitivity is the standard ISO sensitivity value,<wbr/>
as defined in ISO 12232:2006.<wbr/></p>
<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
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
is guaranteed to use only analog amplification for applying the gain.<wbr/></p>
<p>If the camera device cannot apply the exact sensitivity
requested,<wbr/> it will reduce the gain to the nearest supported
value.<wbr/> The final sensitivity used will be available in the
output capture result.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>ISO 12232:2006 REI method is acceptable.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.sensor.testPatternData">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Data
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4
                </span>
              <span class="entry_type_visibility"> [public]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A pixel <code>[R,<wbr/> G_<wbr/>even,<wbr/> G_<wbr/>odd,<wbr/> B]</code> that supplies the test pattern
when <a href="#controls_android.sensor.testPatternMode">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode</a> is SOLID_<wbr/>COLOR.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Each color channel is treated as an unsigned 32-bit integer.<wbr/>
The camera device then uses the most significant X bits
that correspond to how many bits are in its Bayer raw sensor
output.<wbr/></p>
<p>For example,<wbr/> a sensor with RAW10 Bayer output would use the
10 most significant bits from each color channel.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.sensor.testPatternMode">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">int32</span>

              <span class="entry_type_visibility"> [public]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No test pattern mode is used,<wbr/> and the camera
device returns captures from the image sensor.<wbr/></p>
<p>This is the default if the key is not set.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SOLID_COLOR</span>
                    <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
respective color channel provided in
<a href="#controls_android.sensor.testPatternData">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Data</a>.<wbr/></p>
<p>For example:</p>
<pre><code>android.<wbr/>testPatternData = [0,<wbr/> 0xFFFFFFFF,<wbr/> 0xFFFFFFFF,<wbr/> 0]
</code></pre>
<p>All green pixels are 100% green.<wbr/> All red/<wbr/>blue pixels are black.<wbr/></p>
<pre><code>android.<wbr/>testPatternData = [0xFFFFFFFF,<wbr/> 0,<wbr/> 0xFFFFFFFF,<wbr/> 0]
</code></pre>
<p>All red pixels are 100% red.<wbr/> Only the odd green pixels
are 100% green.<wbr/> All blue pixels are 100% black.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">COLOR_BARS</span>
                    <span class="entry_type_enum_notes"><p>All pixel data is replaced with an 8-bar color pattern.<wbr/></p>
<p>The vertical bars (left-to-right) are as follows:</p>
<ul>
<li>100% white</li>
<li>yellow</li>
<li>cyan</li>
<li>green</li>
<li>magenta</li>
<li>red</li>
<li>blue</li>
<li>black</li>
</ul>
<p>In general the image would look like the following:</p>
<pre><code>W Y C G M R B K
W Y C G M R B K
W Y C G M R B K
W Y C G M R B K
W Y C G M R B K
.<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
.<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
.<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>

(B = Blue,<wbr/> K = Black)
</code></pre>
<p>Each bar should take up 1/<wbr/>8 of the sensor pixel array width.<wbr/>
When this is not possible,<wbr/> the bar size should be rounded
down to the nearest integer and the pattern can repeat
on the right side.<wbr/></p>
<p>Each bar's height must always take up the full sensor
pixel array height.<wbr/></p>
<p>Each pixel in this test pattern must be set to either
0% intensity or 100% intensity.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">COLOR_BARS_FADE_TO_GRAY</span>
                    <span class="entry_type_enum_notes"><p>The test pattern is similar to COLOR_<wbr/>BARS,<wbr/> except that
each bar should start at its specified color at the top,<wbr/>
and fade to gray at the bottom.<wbr/></p>
<p>Furthermore each bar is further subdivided into a left and
right half.<wbr/> The left half should have a smooth gradient,<wbr/>
and the right half should have a quantized gradient.<wbr/></p>
<p>In particular,<wbr/> the right half's should consist of blocks of the
same color for 1/<wbr/>16th active sensor pixel array width.<wbr/></p>
<p>The least significant bits in the quantized gradient should
be copied from the most significant bits of the smooth gradient.<wbr/></p>
<p>The height of each bar should always be a multiple of 128.<wbr/>
When this is not the case,<wbr/> the pattern should repeat at the bottom
of the image.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PN9</span>
                    <span class="entry_type_enum_notes"><p>All pixel data is replaced by a pseudo-random sequence
generated from a PN9 512-bit sequence (typically implemented
in hardware with a linear feedback shift register).<wbr/></p>
<p>The generator should be reset at the beginning of each frame,<wbr/>
and thus each subsequent raw frame with this test pattern should
be exactly the same as the last.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CUSTOM1</span>
                    <span class="entry_type_enum_value">256</span>
                    <span class="entry_type_enum_notes"><p>The first custom test pattern.<wbr/> All custom patterns that are
available only on this camera device are at least this numeric
value.<wbr/></p>
<p>All of the custom test patterns will be static
(that is the raw image must not vary from frame to frame).<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>When enabled,<wbr/> the sensor sends a test pattern instead of
doing a real exposure from the camera.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.sensor.availableTestPatternModes">android.<wbr/>sensor.<wbr/>available<wbr/>Test<wbr/>Pattern<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When a test pattern is enabled,<wbr/> all manual sensor controls specified
by android.<wbr/>sensor.<wbr/>* will be ignored.<wbr/> All other controls should
work as normal.<wbr/></p>
<p>For example,<wbr/> if manual flash is enabled,<wbr/> flash firing should still
occur (and that the test pattern remain unmodified,<wbr/> since the flash
would not actually affect it).<wbr/></p>
<p>Defaults to OFF.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>All test patterns are specified in the Bayer domain.<wbr/></p>
<p>The HAL may choose to substitute test patterns from the sensor
with test patterns from on-device memory.<wbr/> In that case,<wbr/> it should be
indistinguishable to the ISP whether the data came from the
sensor interconnect bus (such as CSI2) or memory.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        
                
            

                
          <tr class="entry" id="static_android.sensor.info.activeArraySize">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4
                </span>
              <span class="entry_type_visibility"> [public as rectangle]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">Four ints defining the active pixel rectangle</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The area of the image sensor which corresponds to
active pixels.<wbr/></p>
            </td>

            <td class="entry_units">
              Pixel coordinates on the image sensor
            </td>

            <td class="entry_range">
              
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This is the region of the sensor that actually receives light from the scene.<wbr/>
Therefore,<wbr/> the size of this region determines the maximum field of view and the maximum
number of pixels that an image from this sensor can contain.<wbr/></p>
<p>The rectangle is defined in terms of the full pixel array; (0,<wbr/>0) is the top-left of the
full pixel array,<wbr/> and the size of the full pixel array is given by
<a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/></p>
<p>Most other keys listing pixel coordinates have their coordinate systems based on the
active array,<wbr/> with <code>(0,<wbr/> 0)</code> being the top-left of the active array rectangle.<wbr/></p>
<p>The active array may be smaller than the full pixel array,<wbr/> since the full array may
include black calibration pixels or other inactive regions.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This array contains <code>(xmin,<wbr/> ymin,<wbr/> width,<wbr/> height)</code>.<wbr/> The <code>(xmin,<wbr/> ymin)</code> must be
&gt;= <code>(0,<wbr/>0)</code>.<wbr/>
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>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.info.sensitivityRange">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [public as rangeInt]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <div class="entry_type_notes">Range of supported sensitivities</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Range of sensitivities for <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a> supported by this
camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Min &lt;= 100,<wbr/> Max &gt;= 800</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The values are the standard ISO sensitivity values,<wbr/>
as defined in ISO 12232:2006.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.info.colorFilterArrangement">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">RGGB</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">GRBG</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">GBRG</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">BGGR</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">RGB</span>
                    <span class="entry_type_enum_notes"><p>Sensor is not Bayer; output has 3 16-bit
values for each pixel,<wbr/> instead of just 1 16-bit value
per pixel.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The arrangement of color filters on sensor;
represents the colors in the top-left 2x2 section of
the sensor,<wbr/> in reading order.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.info.exposureTimeRange">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [public as rangeLong]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <div class="entry_type_notes">nanoseconds</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The range of image exposure times for <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a> supported
by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
              Nanoseconds
            </td>

            <td class="entry_range">
              <p>The minimum exposure time will be less than 100 us.<wbr/> For FULL
capability devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL),<wbr/>
the maximum exposure time will be greater than 100ms.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For FULL capability devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL),<wbr/>
The maximum of the range SHOULD be at least 1 second (1e9),<wbr/> MUST be at least
100ms.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.info.maxFrameDuration">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The maximum possible frame duration (minimum frame rate) for
<a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> that is supported this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
              Nanoseconds
            </td>

            <td class="entry_range">
              <p>For FULL capability devices
(<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL),<wbr/> at least 100ms.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Attempting to use frame durations beyond the maximum will result in the frame
duration being clipped to the maximum.<wbr/> See that control for a full definition of frame
durations.<wbr/></p>
<p>Refer to StreamConfigurationMap#getOutputMinFrameDuration(int,<wbr/>Size) for the minimum
frame duration values.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For FULL capability devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL),<wbr/>
The maximum of the range SHOULD be at least
1 second (1e9),<wbr/> MUST be at least 100ms (100e6).<wbr/></p>
<p><a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a> must be greater or
equal to the <a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a> max
value (since exposure time overrides frame duration).<wbr/></p>
<p>Available minimum frame durations for JPEG must be no greater
than that of the YUV_<wbr/>420_<wbr/>888/<wbr/>IMPLEMENTATION_<wbr/>DEFINED
minimum frame durations (for that respective size).<wbr/></p>
<p>Since JPEG processing is considered offline and can take longer than
a single uncompressed capture,<wbr/> refer to
<a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a>
for details about encoding this scenario.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.info.physicalSize">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>info.<wbr/>physical<wbr/>Size
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [public as sizeF]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">width x height</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The physical dimensions of the full pixel
array.<wbr/></p>
            </td>

            <td class="entry_units">
              Millimeters
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This is the physical size of the sensor pixel
array defined by <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Needed for FOV calculation for old API</p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.info.pixelArraySize">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [public as size]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Dimensions of the full pixel array,<wbr/> possibly
including black calibration pixels.<wbr/></p>
            </td>

            <td class="entry_units">
              Pixels
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The pixel count of the full pixel array,<wbr/>
which covers <a href="#static_android.sensor.info.physicalSize">android.<wbr/>sensor.<wbr/>info.<wbr/>physical<wbr/>Size</a> area.<wbr/></p>
<p>If a camera device supports raw sensor formats,<wbr/> either this
or <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a> is the maximum output
raw size listed in <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/>
If a size corresponding to pixelArraySize is listed,<wbr/> the resulting
raw sensor image will include black pixels.<wbr/></p>
<p>Some parts of the full pixel array may not receive light from the scene,<wbr/>
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
defines the rectangle of active pixels that actually forms an image.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.info.whiteLevel">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>info.<wbr/>white<wbr/>Level
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Maximum raw value output by sensor.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>&gt; 255 (8-bit output)</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This specifies the fully-saturated encoding level for the raw
sample values from the sensor.<wbr/>  This is typically caused by the
sensor becoming highly non-linear or clipping.<wbr/> The minimum for
each channel is specified by the offset in the
<a href="#static_android.sensor.blackLevelPattern">android.<wbr/>sensor.<wbr/>black<wbr/>Level<wbr/>Pattern</a> key.<wbr/></p>
<p>The white level is typically determined either by sensor bit depth
(8-14 bits is expected),<wbr/> or by the point where the sensor response
becomes too non-linear to be useful.<wbr/>  The default value for this is
maximum representable value for a 16-bit raw sample (2^16 - 1).<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The full bit depth of the sensor must be available in the raw data,<wbr/>
so the value for linear sensors should not be significantly lower
than maximum raw value supported,<wbr/> i.<wbr/>e.<wbr/> 2^(sensor bits per pixel).<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.info.timestampSource">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">UNKNOWN</span>
                    <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/>
but can not be compared to timestamps from other subsystems
(e.<wbr/>g.<wbr/> accelerometer,<wbr/> gyro etc.<wbr/>),<wbr/> or other instances of the same or different
camera devices in the same system.<wbr/> Timestamps between streams and results for
a single camera instance are comparable,<wbr/> and the timestamps for all buffers
and the result metadata generated by a single capture are identical.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">REALTIME</span>
                    <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
android.<wbr/>os.<wbr/>System<wbr/>Clock#elapsed<wbr/>Realtime<wbr/>Nanos(),<wbr/>
and they can be compared to other timestamps using that base.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The time base source for sensor capture start timestamps.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The timestamps provided for captures are always in nanoseconds and monotonic,<wbr/> but
may not based on a time source that can be compared to other system time sources.<wbr/></p>
<p>This characteristic defines the source for the timestamps,<wbr/> and therefore whether they
can be compared against other system time sources/<wbr/>timestamps.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        
        

                
          <tr class="entry" id="static_android.sensor.referenceIlluminant1">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">DAYLIGHT</span>
                    <span class="entry_type_enum_value">1</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FLUORESCENT</span>
                    <span class="entry_type_enum_value">2</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">TUNGSTEN</span>
                    <span class="entry_type_enum_value">3</span>
                    <span class="entry_type_enum_notes"><p>Incandescent light</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FLASH</span>
                    <span class="entry_type_enum_value">4</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FINE_WEATHER</span>
                    <span class="entry_type_enum_value">9</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CLOUDY_WEATHER</span>
                    <span class="entry_type_enum_value">10</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SHADE</span>
                    <span class="entry_type_enum_value">11</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">DAYLIGHT_FLUORESCENT</span>
                    <span class="entry_type_enum_value">12</span>
                    <span class="entry_type_enum_notes"><p>D 5700 - 7100K</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">DAY_WHITE_FLUORESCENT</span>
                    <span class="entry_type_enum_value">13</span>
                    <span class="entry_type_enum_notes"><p>N 4600 - 5400K</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">COOL_WHITE_FLUORESCENT</span>
                    <span class="entry_type_enum_value">14</span>
                    <span class="entry_type_enum_notes"><p>W 3900 - 4500K</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">WHITE_FLUORESCENT</span>
                    <span class="entry_type_enum_value">15</span>
                    <span class="entry_type_enum_notes"><p>WW 3200 - 3700K</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">STANDARD_A</span>
                    <span class="entry_type_enum_value">17</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">STANDARD_B</span>
                    <span class="entry_type_enum_value">18</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">STANDARD_C</span>
                    <span class="entry_type_enum_value">19</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">D55</span>
                    <span class="entry_type_enum_value">20</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">D65</span>
                    <span class="entry_type_enum_value">21</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">D75</span>
                    <span class="entry_type_enum_value">22</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">D50</span>
                    <span class="entry_type_enum_value">23</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ISO_STUDIO_TUNGSTEN</span>
                    <span class="entry_type_enum_value">24</span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The standard reference illuminant used as the scene light source when
calculating the <a href="#static_android.sensor.colorTransform1">android.<wbr/>sensor.<wbr/>color<wbr/>Transform1</a>,<wbr/>
<a href="#static_android.sensor.calibrationTransform1">android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform1</a>,<wbr/> and
<a href="#static_android.sensor.forwardMatrix1">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix1</a> matrices.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The values in this key correspond to the values defined for the
EXIF LightSource tag.<wbr/> These illuminants are standard light sources
that are often used calibrating camera devices.<wbr/></p>
<p>If this key is present,<wbr/> then <a href="#static_android.sensor.colorTransform1">android.<wbr/>sensor.<wbr/>color<wbr/>Transform1</a>,<wbr/>
<a href="#static_android.sensor.calibrationTransform1">android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform1</a>,<wbr/> and
<a href="#static_android.sensor.forwardMatrix1">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix1</a> will also be present.<wbr/></p>
<p>Some devices may choose to provide a second set of calibration
information for improved quality,<wbr/> including
<a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a> and its corresponding matrices.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The first reference illuminant (<a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a>)
and corresponding matrices must be present to support the RAW capability
and DNG output.<wbr/></p>
<p>When producing raw images with a color profile that has only been
calibrated against a single light source,<wbr/> it is valid to omit
<a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a> along with the
<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/>
and <a href="#static_android.sensor.forwardMatrix2">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix2</a> matrices.<wbr/></p>
<p>If only <a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a> is included,<wbr/> it should be
chosen so that it is representative of typical scene lighting.<wbr/>  In
general,<wbr/> D50 or DAYLIGHT will be chosen for this case.<wbr/></p>
<p>If both <a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a> and
<a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a> are included,<wbr/> they should be
chosen to represent the typical range of scene lighting conditions.<wbr/>
In general,<wbr/> low color temperature illuminant such as Standard-A will
be chosen for the first reference illuminant and a higher color
temperature illuminant such as D65 will be chosen for the second
reference illuminant.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.referenceIlluminant2">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [public]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The standard reference illuminant used as the scene light source when
calculating the <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/> and
<a href="#static_android.sensor.forwardMatrix2">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix2</a> matrices.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>See <a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a> for more details.<wbr/></p>
<p>If this key is present,<wbr/> then <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/> and
<a href="#static_android.sensor.forwardMatrix2">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix2</a> will also be present.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.calibrationTransform1">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform1
            </td>
            <td class="entry_type">
                <span class="entry_type_name">rational</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3 x 3
                </span>
              <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>




                <div class="entry_type_notes">3x3 matrix in row-major-order</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A per-device calibration transform matrix that maps from the
reference sensor colorspace to the actual device sensor colorspace.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This matrix is used to correct for per-device variations in the
sensor colorspace,<wbr/> and is used for processing raw buffer data.<wbr/></p>
<p>The matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and
contains a per-device calibration transform that maps colors
from reference sensor color space (i.<wbr/>e.<wbr/> the "golden module"
colorspace) into this camera device's native sensor color
space under the first reference illuminant
(<a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a>).<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.calibrationTransform2">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform2
            </td>
            <td class="entry_type">
                <span class="entry_type_name">rational</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3 x 3
                </span>
              <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>




                <div class="entry_type_notes">3x3 matrix in row-major-order</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A per-device calibration transform matrix that maps from the
reference sensor colorspace to the actual device sensor colorspace
(this is the colorspace of the raw buffer data).<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This matrix is used to correct for per-device variations in the
sensor colorspace,<wbr/> and is used for processing raw buffer data.<wbr/></p>
<p>The matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and
contains a per-device calibration transform that maps colors
from reference sensor color space (i.<wbr/>e.<wbr/> the "golden module"
colorspace) into this camera device's native sensor color
space under the second reference illuminant
(<a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a>).<wbr/></p>
<p>This matrix will only be present if the second reference
illuminant is present.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.colorTransform1">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>color<wbr/>Transform1
            </td>
            <td class="entry_type">
                <span class="entry_type_name">rational</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3 x 3
                </span>
              <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>




                <div class="entry_type_notes">3x3 matrix in row-major-order</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A matrix that transforms color values from CIE XYZ color space to
reference sensor color space.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This matrix is used to convert from the standard CIE XYZ color
space to the reference sensor colorspace,<wbr/> and is used when processing
raw buffer data.<wbr/></p>
<p>The matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and
contains a color transform matrix that maps colors from the CIE
XYZ color space to the reference sensor color space (i.<wbr/>e.<wbr/> the
"golden module" colorspace) under the first reference illuminant
(<a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a>).<wbr/></p>
<p>The white points chosen in both the reference sensor color space
and the CIE XYZ colorspace when calculating this transform will
match the standard white point for the first reference illuminant
(i.<wbr/>e.<wbr/> no chromatic adaptation will be applied by this transform).<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.colorTransform2">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>color<wbr/>Transform2
            </td>
            <td class="entry_type">
                <span class="entry_type_name">rational</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3 x 3
                </span>
              <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>




                <div class="entry_type_notes">3x3 matrix in row-major-order</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A matrix that transforms color values from CIE XYZ color space to
reference sensor color space.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This matrix is used to convert from the standard CIE XYZ color
space to the reference sensor colorspace,<wbr/> and is used when processing
raw buffer data.<wbr/></p>
<p>The matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and
contains a color transform matrix that maps colors from the CIE
XYZ color space to the reference sensor color space (i.<wbr/>e.<wbr/> the
"golden module" colorspace) under the second reference illuminant
(<a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a>).<wbr/></p>
<p>The white points chosen in both the reference sensor color space
and the CIE XYZ colorspace when calculating this transform will
match the standard white point for the second reference illuminant
(i.<wbr/>e.<wbr/> no chromatic adaptation will be applied by this transform).<wbr/></p>
<p>This matrix will only be present if the second reference
illuminant is present.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.forwardMatrix1">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix1
            </td>
            <td class="entry_type">
                <span class="entry_type_name">rational</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3 x 3
                </span>
              <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>




                <div class="entry_type_notes">3x3 matrix in row-major-order</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A matrix that transforms white balanced camera colors from the reference
sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This matrix is used to convert to the standard CIE XYZ colorspace,<wbr/> and
is used when processing raw buffer data.<wbr/></p>
<p>This matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and contains
a color transform matrix that maps white balanced colors from the
reference sensor color space to the CIE XYZ color space with a D50 white
point.<wbr/></p>
<p>Under the first reference illuminant (<a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a>)
this matrix is chosen so that the standard white point for this reference
illuminant in the reference sensor colorspace is mapped to D50 in the
CIE XYZ colorspace.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.forwardMatrix2">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix2
            </td>
            <td class="entry_type">
                <span class="entry_type_name">rational</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3 x 3
                </span>
              <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>




                <div class="entry_type_notes">3x3 matrix in row-major-order</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A matrix that transforms white balanced camera colors from the reference
sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This matrix is used to convert to the standard CIE XYZ colorspace,<wbr/> and
is used when processing raw buffer data.<wbr/></p>
<p>This matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and contains
a color transform matrix that maps white balanced colors from the
reference sensor color space to the CIE XYZ color space with a D50 white
point.<wbr/></p>
<p>Under the second reference illuminant (<a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a>)
this matrix is chosen so that the standard white point for this reference
illuminant in the reference sensor colorspace is mapped to D50 in the
CIE XYZ colorspace.<wbr/></p>
<p>This matrix will only be present if the second reference
illuminant is present.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.baseGainFactor">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>sensor.<wbr/>base<wbr/>Gain<wbr/>Factor
            </td>
            <td class="entry_type">
                <span class="entry_type_name">rational</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Gain factor from electrons to raw units when
ISO=100</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.blackLevelPattern">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>black<wbr/>Level<wbr/>Pattern
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4
                </span>
              <span class="entry_type_visibility"> [public as blackLevelPattern]</span>




                <div class="entry_type_notes">2x2 raw count block</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A fixed black level offset for each of the color filter arrangement
(CFA) mosaic channels.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>&gt;= 0 for each.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This key specifies the zero light value for each of the CFA mosaic
channels in the camera sensor.<wbr/>  The maximal value output by the
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>
<p>The values are given in the same order as channels listed for the CFA
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
nth value given corresponds to the black level offset for the nth
color channel listed in the CFA.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The values are given in row-column scan order,<wbr/> with the first value
corresponding to the element of the CFA in row=0,<wbr/> column=0.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.maxAnalogSensitivity">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>max<wbr/>Analog<wbr/>Sensitivity
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Maximum sensitivity that is implemented
purely through analog gain.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
                  <li><a href="#tag_FULL">FULL</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a> values less than or
equal to this,<wbr/> all applied gain must be analog.<wbr/> For
values above this,<wbr/> the gain applied can be a mix of analog and
digital.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.orientation">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>orientation
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Clockwise angle through which the output image needs to be rotated to be
upright on the device screen in its native orientation.<wbr/></p>
            </td>

            <td class="entry_units">
              Degrees of clockwise rotation; always a multiple of
          90
            </td>

            <td class="entry_range">
              <p>0,<wbr/> 90,<wbr/> 180,<wbr/> 270</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Also defines the direction of rolling shutter readout,<wbr/> which is from top to bottom in
the sensor's coordinate system.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.profileHueSatMapDimensions">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map<wbr/>Dimensions
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3
                </span>
              <span class="entry_type_visibility"> [system]</span>




                <div class="entry_type_notes">Number of samples for hue,<wbr/> saturation,<wbr/> and value</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The number of input samples for each dimension of
<a href="#dynamic_android.sensor.profileHueSatMap">android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map</a>.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Hue &gt;= 1,<wbr/>
Saturation &gt;= 2,<wbr/>
Value &gt;= 1</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The number of input samples for the hue,<wbr/> saturation,<wbr/> and value
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
dimensions given is hue,<wbr/> saturation,<wbr/> value; where hue is the 0th
element.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.sensor.availableTestPatternModes">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>available<wbr/>Test<wbr/>Pattern<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public]</span>




                <div class="entry_type_notes">list of enums</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of sensor test pattern modes for <a href="#controls_android.sensor.testPatternMode">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode</a>
supported by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.sensor.testPatternMode">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode</a></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Defaults to OFF,<wbr/> and always includes OFF if defined.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>All custom modes must be &gt;= CUSTOM1.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.sensor.exposureTime">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>exposure<wbr/>Time
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Duration each pixel is exposed to
light.<wbr/></p>
            </td>

            <td class="entry_units">
              Nanoseconds
            </td>

            <td class="entry_range">
              <p><a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If the sensor can't expose this exact duration,<wbr/> it will shorten the
duration exposed to the nearest possible value (rather than expose longer).<wbr/>
The final exposure time used will be available in the output capture result.<wbr/></p>
<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
OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.sensor.frameDuration">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>frame<wbr/>Duration
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Duration from start of frame exposure to
start of next frame exposure.<wbr/></p>
            </td>

            <td class="entry_units">
              Nanoseconds
            </td>

            <td class="entry_range">
              <p>See <a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a>,<wbr/>
<a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/> The duration
is capped to <code>max(duration,<wbr/> exposureTime + overhead)</code>.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The maximum frame rate that can be supported by a camera subsystem is
a function of many factors:</p>
<ul>
<li>Requested resolutions of output image streams</li>
<li>Availability of binning /<wbr/> skipping modes on the imager</li>
<li>The bandwidth of the imager interface</li>
<li>The bandwidth of the various ISP processing blocks</li>
</ul>
<p>Since these factors can vary greatly between different ISPs and
sensors,<wbr/> the camera abstraction tries to represent the bandwidth
restrictions with as simple a model as possible.<wbr/></p>
<p>The model presented has the following characteristics:</p>
<ul>
<li>The image sensor is always configured to output the smallest
resolution possible given the application's requested output stream
sizes.<wbr/>  The smallest resolution is defined as being at least as large
as the largest requested output stream size; the camera pipeline must
never digitally upsample sensor data when the crop region covers the
whole sensor.<wbr/> In general,<wbr/> this means that if only small output stream
resolutions are configured,<wbr/> the sensor can provide a higher frame
rate.<wbr/></li>
<li>Since any request may use any or all the currently configured
output streams,<wbr/> the sensor and ISP must be configured to support
scaling a single capture to all the streams at the same time.<wbr/>  This
means the camera pipeline must be ready to produce the largest
requested output size without any delay.<wbr/>  Therefore,<wbr/> the overall
frame rate of a given configured stream set is governed only by the
largest requested stream resolution.<wbr/></li>
<li>Using more than one output stream in a request does not affect the
frame duration.<wbr/></li>
<li>Certain format-streams may need to do additional background processing
before data is consumed/<wbr/>produced by that stream.<wbr/> These processors
can run concurrently to the rest of the camera pipeline,<wbr/> but
cannot process more than 1 capture at a time.<wbr/></li>
</ul>
<p>The necessary information for the application,<wbr/> given the model above,<wbr/>
is provided via the <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> field
using StreamConfigurationMap#getOutputMinFrameDuration(int,<wbr/> Size).<wbr/>
These are used to determine the maximum frame rate /<wbr/> minimum frame
duration that is possible for a given stream configuration.<wbr/></p>
<p>Specifically,<wbr/> the application can use the following rules to
determine the minimum frame duration it can request from the camera
device:</p>
<ol>
<li>Let the set of currently configured input/<wbr/>output streams
be called <code>S</code>.<wbr/></li>
<li>Find the minimum frame durations for each stream in <code>S</code>,<wbr/> by
looking it up in <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> using
StreamConfigurationMap#getOutputMinFrameDuration(int,<wbr/> Size) (with
its respective size/<wbr/>format).<wbr/> Let this set of frame durations be called
<code>F</code>.<wbr/></li>
<li>For any given request <code>R</code>,<wbr/> the minimum frame duration allowed
for <code>R</code> is the maximum out of all values in <code>F</code>.<wbr/> Let the streams
used in <code>R</code> be called <code>S_<wbr/>r</code>.<wbr/></li>
</ol>
<p>If none of the streams in <code>S_<wbr/>r</code> have a stall time (listed in
StreamConfigurationMap#getOutputStallDuration(int,<wbr/>Size) using its
respective size/<wbr/>format),<wbr/> then the frame duration in
<code>F</code> determines the steady state frame rate that the application will
get if it uses <code>R</code> as a repeating request.<wbr/> Let this special kind
of request be called <code>Rsimple</code>.<wbr/></p>
<p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved
by a single capture of a new request <code>Rstall</code> (which has at least
one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the
same minimum frame duration this will not cause a frame rate loss
if all buffers from the previous <code>Rstall</code> have already been
delivered.<wbr/></p>
<p>For more details about stalling,<wbr/> see
StreamConfigurationMap#getOutputStallDuration(int,<wbr/>Size).<wbr/></p>
<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
OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For more details about stalling,<wbr/> see
<a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a>.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.sensor.sensitivity">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>sensitivity
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The amount of gain applied to sensor data
before processing.<wbr/></p>
            </td>

            <td class="entry_units">
              ISO arithmetic units
            </td>

            <td class="entry_range">
              <p><a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The sensitivity is the standard ISO sensitivity value,<wbr/>
as defined in ISO 12232:2006.<wbr/></p>
<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
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
is guaranteed to use only analog amplification for applying the gain.<wbr/></p>
<p>If the camera device cannot apply the exact sensitivity
requested,<wbr/> it will reduce the gain to the nearest supported
value.<wbr/> The final sensitivity used will be available in the
output capture result.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>ISO 12232:2006 REI method is acceptable.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.sensor.timestamp">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>timestamp
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Time at start of exposure of first
row of the image sensor active array,<wbr/> in nanoseconds.<wbr/></p>
            </td>

            <td class="entry_units">
              Nanoseconds
            </td>

            <td class="entry_range">
              <p>&gt; 0</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The timestamps are also included in all image
buffers produced for the same capture,<wbr/> and will be identical
on all the outputs.<wbr/></p>
<p>When <a href="#static_android.sensor.info.timestampSource">android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source</a> <code>==</code> UNKNOWN,<wbr/>
the timestamps measure time since an unspecified starting point,<wbr/>
and are monotonically increasing.<wbr/> They can be compared with the
timestamps for other captures from the same camera device,<wbr/> but are
not guaranteed to be comparable to any other time source.<wbr/></p>
<p>When <a href="#static_android.sensor.info.timestampSource">android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source</a> <code>==</code> REALTIME,<wbr/>
the timestamps measure time in the same timebase as
android.<wbr/>os.<wbr/>System<wbr/>Clock#elapsed<wbr/>Realtime<wbr/>Nanos(),<wbr/> and they can be
compared to other timestamps from other subsystems that are using
that base.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>All timestamps must be in reference to the kernel's
CLOCK_<wbr/>BOOTTIME monotonic clock,<wbr/> which properly accounts for
time spent asleep.<wbr/> This allows for synchronization with
sensors that continue to operate while the system is
otherwise asleep.<wbr/></p>
<p>If <a href="#static_android.sensor.info.timestampSource">android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source</a> <code>==</code> REALTIME,<wbr/>
The timestamp must be synchronized with the timestamps from other
sensor subsystems that are using the same timebase.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.sensor.temperature">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>sensor.<wbr/>temperature
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The temperature of the sensor,<wbr/> sampled at the time
exposure began for this frame.<wbr/></p>
<p>The thermal diode being queried should be inside the sensor PCB,<wbr/> or
somewhere close to it.<wbr/></p>
            </td>

            <td class="entry_units">
              Celsius
            </td>

            <td class="entry_range">
              <p>Optional.<wbr/> This value is missing if no temperature is available.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.sensor.neutralColorPoint">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>neutral<wbr/>Color<wbr/>Point
            </td>
            <td class="entry_type">
                <span class="entry_type_name">rational</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3
                </span>
              <span class="entry_type_visibility"> [public]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The estimated camera neutral color in the native sensor colorspace at
the time of capture.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This value gives the neutral color point encoded as an RGB value in the
native sensor color space.<wbr/>  The neutral color point indicates the
currently estimated white point of the scene illumination.<wbr/>  It can be
used to interpolate between the provided color transforms when
processing raw sensor data.<wbr/></p>
<p>The order of the values is R,<wbr/> G,<wbr/> B; where R is in the lowest index.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.sensor.noiseProfile">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>noise<wbr/>Profile
            </td>
            <td class="entry_type">
                <span class="entry_type_name">double</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2 x CFA Channels
                </span>
              <span class="entry_type_visibility"> [public as pairDoubleDouble]</span>




                <div class="entry_type_notes">Pairs of noise model coefficients</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Noise model coefficients for each CFA mosaic channel.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This key contains two noise model coefficients for each CFA channel
corresponding to the sensor amplification (S) and sensor readout
noise (O).<wbr/>  These are given as pairs of coefficients for each channel
in the same order as channels listed for the CFA layout key
(see <a href="#static_android.sensor.info.colorFilterArrangement">android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement</a>).<wbr/>  This is
represented as an array of Pair&lt;Double,<wbr/> Double&gt;,<wbr/> where
the first member of the Pair at index n is the S coefficient and the
second member is the O coefficient for the nth color channel in the CFA.<wbr/></p>
<p>These coefficients are used in a two parameter noise model to describe
the amount of noise present in the image for each CFA channel.<wbr/>  The
noise model used here is:</p>
<p>N(x) = sqrt(Sx + O)</p>
<p>Where x represents the recorded signal of a CFA channel normalized to
the range [0,<wbr/> 1],<wbr/> and S and O are the noise model coeffiecients for
that channel.<wbr/></p>
<p>A more detailed description of the noise model can be found in the
Adobe DNG specification for the NoiseProfile tag.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For a CFA layout of RGGB,<wbr/> the list of coefficients would be given as
an array of doubles S0,<wbr/>O0,<wbr/>S1,<wbr/>O1,...,<wbr/> where S0 and O0 are the coefficients
for the red channel,<wbr/> S1 and O1 are the coefficients for the first green
channel,<wbr/> etc.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.sensor.profileHueSatMap">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  hue_samples x saturation_samples x value_samples x 3
                </span>
              <span class="entry_type_visibility"> [system]</span>




                <div class="entry_type_notes">Mapping for hue,<wbr/> saturation,<wbr/> and value</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A mapping containing a hue shift,<wbr/> saturation scale,<wbr/> and value scale
for each pixel.<wbr/></p>
            </td>

            <td class="entry_units">
              
          The hue shift is given in degrees; saturation and value scale factors are
          unitless and are between 0 and 1 inclusive
          
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>hue_<wbr/>samples,<wbr/> saturation_<wbr/>samples,<wbr/> and value_<wbr/>samples are given in
<a href="#static_android.sensor.profileHueSatMapDimensions">android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map<wbr/>Dimensions</a>.<wbr/></p>
<p>Each entry of this map contains three floats corresponding to the
hue shift,<wbr/> saturation scale,<wbr/> and value scale,<wbr/> respectively; where the
hue shift has the lowest index.<wbr/> The map entries are stored in the key
in nested loop order,<wbr/> with the value divisions in the outer loop,<wbr/> the
hue divisions in the middle loop,<wbr/> and the saturation divisions in the
inner loop.<wbr/> All zero input saturation entries are required to have a
value scale factor of 1.<wbr/>0.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.sensor.profileToneCurve">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>sensor.<wbr/>profile<wbr/>Tone<wbr/>Curve
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  samples x 2
                </span>
              <span class="entry_type_visibility"> [system]</span>




                <div class="entry_type_notes">Samples defining a spline for a tone-mapping curve</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A list of x,<wbr/>y samples defining a tone-mapping curve for gamma adjustment.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Each sample has an input range of <code>[0,<wbr/> 1]</code> and an output range of
<code>[0,<wbr/> 1]</code>.<wbr/>  The first sample is required to be <code>(0,<wbr/> 0)</code>,<wbr/> and the last
sample is required to be <code>(1,<wbr/> 1)</code>.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This key contains a default tone curve that can be applied while
processing the image as a starting point for user adjustments.<wbr/>
The curve is specified as a list of value pairs in linear gamma.<wbr/>
The curve is interpolated using a cubic spline.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.sensor.greenSplit">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>green<wbr/>Split
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The worst-case divergence between Bayer green channels.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>&gt;= 0</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This value is an estimate of the worst case split between the
Bayer green channels in the red and blue rows in the sensor color
filter array.<wbr/></p>
<p>The green split is calculated as follows:</p>
<ol>
<li>A 5x5 pixel (or larger) window W within the active sensor array is
chosen.<wbr/> The term 'pixel' here is taken to mean a group of 4 Bayer
mosaic channels (R,<wbr/> Gr,<wbr/> Gb,<wbr/> B).<wbr/>  The location and size of the window
chosen is implementation defined,<wbr/> and should be chosen to provide a
green split estimate that is both representative of the entire image
for this camera sensor,<wbr/> and can be calculated quickly.<wbr/></li>
<li>The arithmetic mean of the green channels from the red
rows (mean_<wbr/>Gr) within W is computed.<wbr/></li>
<li>The arithmetic mean of the green channels from the blue
rows (mean_<wbr/>Gb) within W is computed.<wbr/></li>
<li>The maximum ratio R of the two means is computed as follows:
<code>R = max((mean_<wbr/>Gr + 1)/<wbr/>(mean_<wbr/>Gb + 1),<wbr/> (mean_<wbr/>Gb + 1)/<wbr/>(mean_<wbr/>Gr + 1))</code></li>
</ol>
<p>The ratio R is the green split divergence reported for this property,<wbr/>
which represents how much the green channels differ in the mosaic
pattern.<wbr/>  This value is typically used to determine the treatment of
the green mosaic channels when demosaicing.<wbr/></p>
<p>The green split value can be roughly interpreted as follows:</p>
<ul>
<li>R &lt; 1.<wbr/>03 is a negligible split (&lt;3% divergence).<wbr/></li>
<li>1.<wbr/>20 &lt;= R &gt;= 1.<wbr/>03 will require some software
correction to avoid demosaic errors (3-20% divergence).<wbr/></li>
<li>R &gt; 1.<wbr/>20 will require strong software correction to produce
a usuable image (&gt;20% divergence).<wbr/></li>
</ul>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The green split given may be a static value based on prior
characterization of the camera sensor using the green split
calculation method given here over a large,<wbr/> representative,<wbr/> sample
set of images.<wbr/>  Other methods of calculation that produce equivalent
results,<wbr/> and can be interpreted in the same manner,<wbr/> may be used.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.sensor.testPatternData">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Data
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4
                </span>
              <span class="entry_type_visibility"> [public]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A pixel <code>[R,<wbr/> G_<wbr/>even,<wbr/> G_<wbr/>odd,<wbr/> B]</code> that supplies the test pattern
when <a href="#controls_android.sensor.testPatternMode">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode</a> is SOLID_<wbr/>COLOR.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Each color channel is treated as an unsigned 32-bit integer.<wbr/>
The camera device then uses the most significant X bits
that correspond to how many bits are in its Bayer raw sensor
output.<wbr/></p>
<p>For example,<wbr/> a sensor with RAW10 Bayer output would use the
10 most significant bits from each color channel.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.sensor.testPatternMode">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">int32</span>

              <span class="entry_type_visibility"> [public]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No test pattern mode is used,<wbr/> and the camera
device returns captures from the image sensor.<wbr/></p>
<p>This is the default if the key is not set.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SOLID_COLOR</span>
                    <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
respective color channel provided in
<a href="#controls_android.sensor.testPatternData">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Data</a>.<wbr/></p>
<p>For example:</p>
<pre><code>android.<wbr/>testPatternData = [0,<wbr/> 0xFFFFFFFF,<wbr/> 0xFFFFFFFF,<wbr/> 0]
</code></pre>
<p>All green pixels are 100% green.<wbr/> All red/<wbr/>blue pixels are black.<wbr/></p>
<pre><code>android.<wbr/>testPatternData = [0xFFFFFFFF,<wbr/> 0,<wbr/> 0xFFFFFFFF,<wbr/> 0]
</code></pre>
<p>All red pixels are 100% red.<wbr/> Only the odd green pixels
are 100% green.<wbr/> All blue pixels are 100% black.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">COLOR_BARS</span>
                    <span class="entry_type_enum_notes"><p>All pixel data is replaced with an 8-bar color pattern.<wbr/></p>
<p>The vertical bars (left-to-right) are as follows:</p>
<ul>
<li>100% white</li>
<li>yellow</li>
<li>cyan</li>
<li>green</li>
<li>magenta</li>
<li>red</li>
<li>blue</li>
<li>black</li>
</ul>
<p>In general the image would look like the following:</p>
<pre><code>W Y C G M R B K
W Y C G M R B K
W Y C G M R B K
W Y C G M R B K
W Y C G M R B K
.<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
.<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
.<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>

(B = Blue,<wbr/> K = Black)
</code></pre>
<p>Each bar should take up 1/<wbr/>8 of the sensor pixel array width.<wbr/>
When this is not possible,<wbr/> the bar size should be rounded
down to the nearest integer and the pattern can repeat
on the right side.<wbr/></p>
<p>Each bar's height must always take up the full sensor
pixel array height.<wbr/></p>
<p>Each pixel in this test pattern must be set to either
0% intensity or 100% intensity.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">COLOR_BARS_FADE_TO_GRAY</span>
                    <span class="entry_type_enum_notes"><p>The test pattern is similar to COLOR_<wbr/>BARS,<wbr/> except that
each bar should start at its specified color at the top,<wbr/>
and fade to gray at the bottom.<wbr/></p>
<p>Furthermore each bar is further subdivided into a left and
right half.<wbr/> The left half should have a smooth gradient,<wbr/>
and the right half should have a quantized gradient.<wbr/></p>
<p>In particular,<wbr/> the right half's should consist of blocks of the
same color for 1/<wbr/>16th active sensor pixel array width.<wbr/></p>
<p>The least significant bits in the quantized gradient should
be copied from the most significant bits of the smooth gradient.<wbr/></p>
<p>The height of each bar should always be a multiple of 128.<wbr/>
When this is not the case,<wbr/> the pattern should repeat at the bottom
of the image.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">PN9</span>
                    <span class="entry_type_enum_notes"><p>All pixel data is replaced by a pseudo-random sequence
generated from a PN9 512-bit sequence (typically implemented
in hardware with a linear feedback shift register).<wbr/></p>
<p>The generator should be reset at the beginning of each frame,<wbr/>
and thus each subsequent raw frame with this test pattern should
be exactly the same as the last.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">CUSTOM1</span>
                    <span class="entry_type_enum_value">256</span>
                    <span class="entry_type_enum_notes"><p>The first custom test pattern.<wbr/> All custom patterns that are
available only on this camera device are at least this numeric
value.<wbr/></p>
<p>All of the custom test patterns will be static
(that is the raw image must not vary from frame to frame).<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>When enabled,<wbr/> the sensor sends a test pattern instead of
doing a real exposure from the camera.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.sensor.availableTestPatternModes">android.<wbr/>sensor.<wbr/>available<wbr/>Test<wbr/>Pattern<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When a test pattern is enabled,<wbr/> all manual sensor controls specified
by android.<wbr/>sensor.<wbr/>* will be ignored.<wbr/> All other controls should
work as normal.<wbr/></p>
<p>For example,<wbr/> if manual flash is enabled,<wbr/> flash firing should still
occur (and that the test pattern remain unmodified,<wbr/> since the flash
would not actually affect it).<wbr/></p>
<p>Defaults to OFF.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>All test patterns are specified in the Bayer domain.<wbr/></p>
<p>The HAL may choose to substitute test patterns from the sensor
with test patterns from on-device memory.<wbr/> In that case,<wbr/> it should be
indistinguishable to the ISP whether the data came from the
sensor interconnect bus (such as CSI2) or memory.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.sensor.rollingShutterSkew">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sensor.<wbr/>rolling<wbr/>Shutter<wbr/>Skew
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int64</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[limited] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Duration between the start of first row exposure
and the start of last row exposure.<wbr/></p>
            </td>

            <td class="entry_units">
              Nanoseconds
            </td>

            <td class="entry_range">
              <p>&gt;= 0 and &lt;
StreamConfigurationMap#getOutputMinFrameDuration(int,<wbr/> Size).<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This is the exposure time skew between the first and last
row exposure start times.<wbr/> The first row and the last row are
the first and last rows inside of the
<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></p>
<p>For typical camera sensors that use rolling shutters,<wbr/> this is also equivalent
to the frame readout time.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The HAL must report <code>0</code> if the sensor is using global shutter,<wbr/> where all pixels begin
exposure at the same time.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_shading" class="section">shading</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.shading.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>shading.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No lens shading correction is applied.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Apply lens shading corrections,<wbr/> without slowing
frame rate relative to sensor raw output</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>Apply high-quality lens shading correction,<wbr/> at the
cost of reduced frame rate.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Quality of lens shading correction applied
to the image data.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When set to OFF mode,<wbr/> no lens shading correction will be applied by the
camera device,<wbr/> and an identity lens shading map data will be provided
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
shading map with size of <code>[ 4,<wbr/> 3 ]</code>,<wbr/>
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
map shown below:</p>
<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/>
 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/>
 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/>
 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/>
 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/>
 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 ]
</code></pre>
<p>When set to other modes,<wbr/> lens shading correction will be applied by the camera
device.<wbr/> Applications can request lens shading map data by setting
<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
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
data will be the one applied by the camera device for this capture request.<wbr/></p>
<p>The shading map data may depend on the auto-exposure (AE) and AWB statistics,<wbr/> therefore
the reliability of the map data may be affected by the AE and AWB algorithms.<wbr/> When AE and
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>
OFF),<wbr/> to get best results,<wbr/> it is recommended that the applications wait for the AE and AWB
to be converged before using the returned shading map data.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.shading.strength">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>shading.<wbr/>strength
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Control the amount of shading correction
applied to the images</p>
            </td>

            <td class="entry_units">
              unitless: 1-10; 10 is full shading
          compensation
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.shading.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>shading.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>No lens shading correction is applied.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Apply lens shading corrections,<wbr/> without slowing
frame rate relative to sensor raw output</p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>Apply high-quality lens shading correction,<wbr/> at the
cost of reduced frame rate.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Quality of lens shading correction applied
to the image data.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When set to OFF mode,<wbr/> no lens shading correction will be applied by the
camera device,<wbr/> and an identity lens shading map data will be provided
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
shading map with size of <code>[ 4,<wbr/> 3 ]</code>,<wbr/>
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
map shown below:</p>
<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/>
 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/>
 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/>
 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/>
 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/>
 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 ]
</code></pre>
<p>When set to other modes,<wbr/> lens shading correction will be applied by the camera
device.<wbr/> Applications can request lens shading map data by setting
<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
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
data will be the one applied by the camera device for this capture request.<wbr/></p>
<p>The shading map data may depend on the auto-exposure (AE) and AWB statistics,<wbr/> therefore
the reliability of the map data may be affected by the AE and AWB algorithms.<wbr/> When AE and
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>
OFF),<wbr/> to get best results,<wbr/> it is recommended that the applications wait for the AE and AWB
to be converged before using the returned shading map data.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_statistics" class="section">statistics</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.statistics.faceDetectMode">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Do not include face detection statistics in capture
results.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SIMPLE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Return face rectangle and confidence values only.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FULL</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Return all face
metadata.<wbr/></p>
<p>In this mode,<wbr/> face rectangles,<wbr/> scores,<wbr/> landmarks,<wbr/> and face IDs are all valid.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Operating mode for the face detector
unit.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.statistics.info.availableFaceDetectModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Face<wbr/>Detect<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Whether face detection is enabled,<wbr/> and whether it
should output just the basic fields or the full set of
fields.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>SIMPLE mode must fill in <a href="#dynamic_android.statistics.faceRectangles">android.<wbr/>statistics.<wbr/>face<wbr/>Rectangles</a> and
<a href="#dynamic_android.statistics.faceScores">android.<wbr/>statistics.<wbr/>face<wbr/>Scores</a>.<wbr/>
FULL mode must also fill in <a href="#dynamic_android.statistics.faceIds">android.<wbr/>statistics.<wbr/>face<wbr/>Ids</a>,<wbr/> and
<a href="#dynamic_android.statistics.faceLandmarks">android.<wbr/>statistics.<wbr/>face<wbr/>Landmarks</a>.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.statistics.histogramMode">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>statistics.<wbr/>histogram<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [system as boolean]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Operating mode for histogram
generation</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.statistics.sharpnessMapMode">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>statistics.<wbr/>sharpness<wbr/>Map<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [system as boolean]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Operating mode for sharpness map
generation</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.statistics.hotPixelMapMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public as boolean]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Hot pixel map production is disabled.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_notes"><p>Hot pixel map production is enabled.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Operating mode for hot pixel map generation.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <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>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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/>
If set to <code>false</code>,<wbr/> no hot pixel map will be returned.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.statistics.lensShadingMapMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Do not include a lens shading map in the capture result.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_notes"><p>Include a lens shading map in the capture result.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether the camera device will output the lens
shading map in output result metadata.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When set to ON,<wbr/>
<a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a> will be provided in
the output result metadata.<wbr/></p>
<p>ON is always supported on devices with the RAW capability.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        
                
            

                
          <tr class="entry" id="static_android.statistics.info.availableFaceDetectModes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Face<wbr/>Detect<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">List of enums from android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <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
supported by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>OFF is always supported.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.statistics.info.histogramBucketCount">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>statistics.<wbr/>info.<wbr/>histogram<wbr/>Bucket<wbr/>Count
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Number of histogram buckets
supported</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>&gt;= 64</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.statistics.info.maxFaceCount">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>statistics.<wbr/>info.<wbr/>max<wbr/>Face<wbr/>Count
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The maximum number of simultaneously detectable
faces.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>0 for cameras without available face detection; otherwise:
<code>&gt;=4</code> for LIMITED or FULL hwlevel devices or
<code>&gt;0</code> for LEGACY devices.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.statistics.info.maxHistogramCount">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>statistics.<wbr/>info.<wbr/>max<wbr/>Histogram<wbr/>Count
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Maximum value possible for a histogram
bucket</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.statistics.info.maxSharpnessMapValue">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>statistics.<wbr/>info.<wbr/>max<wbr/>Sharpness<wbr/>Map<wbr/>Value
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [system]</span>






            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Maximum value possible for a sharpness map
region.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.statistics.info.sharpnessMapSize">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>statistics.<wbr/>info.<wbr/>sharpness<wbr/>Map<wbr/>Size
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2
                </span>
              <span class="entry_type_visibility"> [system as size]</span>




                <div class="entry_type_notes">width x height</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Dimensions of the sharpness
map</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Must be at least 32 x 32</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.statistics.info.availableHotPixelMapModes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Map<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as boolean]</span>




                <div class="entry_type_notes">list of enums</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <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
supported by this camera device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.statistics.hotPixelMapMode">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map<wbr/>Mode</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If no hotpixel map output is available for this camera device,<wbr/> this will contain only
<code>false</code>.<wbr/></p>
<p>ON is always supported on devices with the RAW capability.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        
        

        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.statistics.faceDetectMode">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Do not include face detection statistics in capture
results.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">SIMPLE</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Return face rectangle and confidence values only.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FULL</span>
                    <span class="entry_type_enum_optional">[optional]</span>
                    <span class="entry_type_enum_notes"><p>Return all face
metadata.<wbr/></p>
<p>In this mode,<wbr/> face rectangles,<wbr/> scores,<wbr/> landmarks,<wbr/> and face IDs are all valid.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Operating mode for the face detector
unit.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.statistics.info.availableFaceDetectModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Face<wbr/>Detect<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Whether face detection is enabled,<wbr/> and whether it
should output just the basic fields or the full set of
fields.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>SIMPLE mode must fill in <a href="#dynamic_android.statistics.faceRectangles">android.<wbr/>statistics.<wbr/>face<wbr/>Rectangles</a> and
<a href="#dynamic_android.statistics.faceScores">android.<wbr/>statistics.<wbr/>face<wbr/>Scores</a>.<wbr/>
FULL mode must also fill in <a href="#dynamic_android.statistics.faceIds">android.<wbr/>statistics.<wbr/>face<wbr/>Ids</a>,<wbr/> and
<a href="#dynamic_android.statistics.faceLandmarks">android.<wbr/>statistics.<wbr/>face<wbr/>Landmarks</a>.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.faceIds">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>face<wbr/>Ids
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of unique IDs for detected faces.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Each detected face is given a unique ID that is valid for as long as the face is visible
to the camera device.<wbr/>  A face that leaves the field of view and later returns may be
assigned a new ID.<wbr/></p>
<p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> == FULL</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.faceLandmarks">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>face<wbr/>Landmarks
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 6
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">(leftEyeX,<wbr/> leftEyeY,<wbr/> rightEyeX,<wbr/> rightEyeY,<wbr/> mouthX,<wbr/> mouthY)</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of landmarks for detected
faces.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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
<code>(0,<wbr/> 0)</code> being the top-left pixel of the active array.<wbr/></p>
<p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> == FULL</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.faceRectangles">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>face<wbr/>Rectangles
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 4
                </span>
              <span class="entry_type_visibility"> [hidden as rectangle]</span>


              <span class="entry_type_hwlevel">[legacy] </span>


                <div class="entry_type_notes">(xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax).<wbr/> (0,<wbr/>0) is top-left of active pixel area</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of the bounding rectangles for detected
faces.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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
<code>(0,<wbr/> 0)</code> being the top-left pixel of the active array.<wbr/></p>
<p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> != OFF</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.faceScores">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>statistics.<wbr/>face<wbr/>Scores
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of the face confidence scores for
detected faces</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>1-100</p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_BC">BC</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> != OFF.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The value should be meaningful (for example,<wbr/> setting 100 at
all times is illegal).<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.faces">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>faces
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as face]</span>

              <span class="entry_type_synthetic">[synthetic] </span>

              <span class="entry_type_hwlevel">[legacy] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of the faces detected through camera face detection
in this capture.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.histogram">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>histogram
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 3
                </span>
              <span class="entry_type_visibility"> [system]</span>




                <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>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A 3-channel histogram based on the raw
sensor data</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The k'th bucket (0-based) covers the input range
(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/>
(k + 1) * w /<wbr/> N ).<wbr/> If only a monochrome sharpness map is
supported,<wbr/> all channels should have the same data</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.histogramMode">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>statistics.<wbr/>histogram<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [system as boolean]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Operating mode for histogram
generation</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.sharpnessMap">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>sharpness<wbr/>Map
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x m x 3
                </span>
              <span class="entry_type_visibility"> [system]</span>




                <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>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A 3-channel sharpness map,<wbr/> based on the raw
sensor data</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If only a monochrome sharpness map is supported,<wbr/>
all channels should have the same data</p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.sharpnessMapMode">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>statistics.<wbr/>sharpness<wbr/>Map<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [system as boolean]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Operating mode for sharpness map
generation</p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_FUTURE">FUTURE</a></li>
              </ul>
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.lensShadingCorrectionMap">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Correction<wbr/>Map
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>

              <span class="entry_type_visibility"> [public as lensShadingMap]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The shading map is a low-resolution floating-point map
that lists the coefficients used to correct for vignetting,<wbr/> for each
Bayer color channel.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Each gain factor is &gt;= 1</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The least shaded section of the image should have a gain factor
of 1; all other sections should have gains above 1.<wbr/></p>
<p>When <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> = TRANSFORM_<wbr/>MATRIX,<wbr/> the map
must take into account the colorCorrection settings.<wbr/></p>
<p>The shading map is for the entire active pixel array,<wbr/> and is not
affected by the crop region specified in the request.<wbr/> Each shading map
entry is the value of the shading compensation map over a specific
pixel on the sensor.<wbr/>  Specifically,<wbr/> with a (N x M) resolution shading
map,<wbr/> and an active pixel array size (W x H),<wbr/> shading map entry
(x,<wbr/>y) ϵ (0 ...<wbr/> N-1,<wbr/> 0 ...<wbr/> M-1) is the value of the shading map at
pixel ( ((W-1)/<wbr/>(N-1)) * x,<wbr/> ((H-1)/<wbr/>(M-1)) * y) for the four color channels.<wbr/>
The map is assumed to be bilinearly interpolated between the sample points.<wbr/></p>
<p>The channel order is [R,<wbr/> Geven,<wbr/> Godd,<wbr/> B],<wbr/> where Geven is the green
channel for the even rows of a Bayer pattern,<wbr/> and Godd is the odd rows.<wbr/>
The shading map is stored in a fully interleaved format.<wbr/></p>
<p>The shading map should have on the order of 30-40 rows and columns,<wbr/>
and must be smaller than 64x64.<wbr/></p>
<p>As an example,<wbr/> given a very small map defined as:</p>
<pre><code>width,<wbr/>height = [ 4,<wbr/> 3 ]
values =
[ 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/>
    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/>
  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/>
    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/>
  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/>
    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 ]
</code></pre>
<p>The low-resolution scaling map images for each channel are
(displayed using nearest-neighbor interpolation):</p>
<p><img alt="Red lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png"/>
<img alt="Green (even rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png"/>
<img alt="Green (odd rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png"/>
<img alt="Blue lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png"/></p>
<p>As a visualization only,<wbr/> inverting the full-color map to recover an
image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p>
<p><img alt="Image of a uniform white wall (inverse shading map)" src="images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png"/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.lensShadingMap">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4 x n x m
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <div class="entry_type_notes">2D array of float gain factors per channel to correct lens shading</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The shading map is a low-resolution floating-point map
that lists the coefficients used to correct for vignetting,<wbr/> for each
Bayer color channel.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Each gain factor is &gt;= 1</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The least shaded section of the image should have a gain factor
of 1; all other sections should have gains above 1.<wbr/></p>
<p>When <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> = TRANSFORM_<wbr/>MATRIX,<wbr/> the map
must take into account the colorCorrection settings.<wbr/></p>
<p>The shading map is for the entire active pixel array,<wbr/> and is not
affected by the crop region specified in the request.<wbr/> Each shading map
entry is the value of the shading compensation map over a specific
pixel on the sensor.<wbr/>  Specifically,<wbr/> with a (N x M) resolution shading
map,<wbr/> and an active pixel array size (W x H),<wbr/> shading map entry
(x,<wbr/>y) ϵ (0 ...<wbr/> N-1,<wbr/> 0 ...<wbr/> M-1) is the value of the shading map at
pixel ( ((W-1)/<wbr/>(N-1)) * x,<wbr/> ((H-1)/<wbr/>(M-1)) * y) for the four color channels.<wbr/>
The map is assumed to be bilinearly interpolated between the sample points.<wbr/></p>
<p>The channel order is [R,<wbr/> Geven,<wbr/> Godd,<wbr/> B],<wbr/> where Geven is the green
channel for the even rows of a Bayer pattern,<wbr/> and Godd is the odd rows.<wbr/>
The shading map is stored in a fully interleaved format,<wbr/> and its size
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>
<p>The shading map should have on the order of 30-40 rows and columns,<wbr/>
and must be smaller than 64x64.<wbr/></p>
<p>As an example,<wbr/> given a very small map defined as:</p>
<pre><code><a href="#static_android.lens.info.shadingMapSize">android.<wbr/>lens.<wbr/>info.<wbr/>shading<wbr/>Map<wbr/>Size</a> = [ 4,<wbr/> 3 ]
<a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a> =
[ 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/>
    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/>
  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/>
    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/>
  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/>
    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 ]
</code></pre>
<p>The low-resolution scaling map images for each channel are
(displayed using nearest-neighbor interpolation):</p>
<p><img alt="Red lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png"/>
<img alt="Green (even rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png"/>
<img alt="Green (odd rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png"/>
<img alt="Blue lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png"/></p>
<p>As a visualization only,<wbr/> inverting the full-color map to recover an
image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p>
<p><img alt="Image of a uniform white wall (inverse shading map)" src="images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png"/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The lens shading map calculation may depend on exposure and white balance statistics.<wbr/>
When AE and 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> OFF),<wbr/> the HAL
may have all the information it need to generate most accurate lens shading map.<wbr/> When
AE or AWB are in manual mode
(<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
may be adversely impacted by manual exposure or white balance parameters.<wbr/> To avoid
generating unreliable shading map data,<wbr/> the HAL may choose to lock the shading map with
the latest known good map generated when the AE and AWB are in AUTO modes.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.predictedColorGains">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>predicted<wbr/>Color<wbr/>Gains
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  4
                </span>
              <span class="entry_type_visibility"> [hidden]</span>



              <span class="entry_type_deprecated">[deprecated] </span>

                <div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The best-fit color channel gains calculated
by the camera device's statistics units for the current output frame.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This may be different than the gains used for this frame,<wbr/>
since statistics processing on data from a new frame
typically completes after the transform has already been
applied to that frame.<wbr/></p>
<p>The 4 channel gains are defined in Bayer domain,<wbr/>
see <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> for details.<wbr/></p>
<p>This value should always be calculated by the auto-white balance (AWB) block,<wbr/>
regardless of the android.<wbr/>control.<wbr/>* current values.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.predictedColorTransform">
            <td class="entry_name
                entry_name_deprecated
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>predicted<wbr/>Color<wbr/>Transform
            </td>
            <td class="entry_type">
                <span class="entry_type_name">rational</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  3 x 3
                </span>
              <span class="entry_type_visibility"> [hidden]</span>



              <span class="entry_type_deprecated">[deprecated] </span>

                <div class="entry_type_notes">3x3 rational matrix in row-major order</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The best-fit color transform matrix estimate
calculated by the camera device's statistics units for the current
output frame.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The camera device will provide the estimate from its
statistics unit on the white balance transforms to use
for the next frame.<wbr/> These are the values the camera device believes
are the best fit for the current output frame.<wbr/> This may
be different than the transform used for this frame,<wbr/> since
statistics processing on data from a new frame typically
completes after the transform has already been applied to
that frame.<wbr/></p>
<p>These estimates must be provided for all frames,<wbr/> even if
capture settings and color transforms are set by the application.<wbr/></p>
<p>This value should always be calculated by the auto-white balance (AWB) block,<wbr/>
regardless of the android.<wbr/>control.<wbr/>* current values.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.sceneFlicker">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>scene<wbr/>Flicker
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">NONE</span>
                    <span class="entry_type_enum_notes"><p>The camera device does not detect any flickering illumination
in the current scene.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">50HZ</span>
                    <span class="entry_type_enum_notes"><p>The camera device detects illumination flickering at 50Hz
in the current scene.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">60HZ</span>
                    <span class="entry_type_enum_notes"><p>The camera device detects illumination flickering at 60Hz
in the current scene.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The camera device estimated scene illumination lighting
frequency.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Many light sources,<wbr/> such as most fluorescent lights,<wbr/> flicker at a rate
that depends on the local utility power standards.<wbr/> This flicker must be
accounted for by auto-exposure routines to avoid artifacts in captured images.<wbr/>
The camera device uses this entry to tell the application what the scene
illuminant frequency is.<wbr/></p>
<p>When manual exposure control is enabled
(<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> ==
OFF</code>),<wbr/> the <a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a> doesn't perform
antibanding,<wbr/> and the application can ensure it selects
exposure times that do not cause banding issues by looking
into this metadata field.<wbr/> See
<a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a> for more details.<wbr/></p>
<p>Reports NONE if there doesn't appear to be flickering illumination.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.hotPixelMapMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public as boolean]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Hot pixel map production is disabled.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_notes"><p>Hot pixel map production is enabled.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Operating mode for hot pixel map generation.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <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>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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/>
If set to <code>false</code>,<wbr/> no hot pixel map will be returned.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.hotPixelMap">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  2 x n
                </span>
              <span class="entry_type_visibility"> [public as point]</span>




                <div class="entry_type_notes">list of coordinates based on android.<wbr/>sensor.<wbr/>pixel<wbr/>Array<wbr/>Size</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of <code>(x,<wbr/> y)</code> coordinates of hot/<wbr/>defective pixels on the sensor.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>n &lt;= number of pixels on the sensor.<wbr/>
The <code>(x,<wbr/> y)</code> coordinates must be bounded by
<a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>A coordinate <code>(x,<wbr/> y)</code> must lie between <code>(0,<wbr/> 0)</code>,<wbr/> and
<code>(width - 1,<wbr/> height - 1)</code> (inclusive),<wbr/> which are the top-left and
bottom-right of the pixel array,<wbr/> respectively.<wbr/> The width and
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/>
This may include hot pixels that lie outside of the active array
bounds given by <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>A hotpixel map contains the coordinates of pixels on the camera
sensor that do report valid values (usually due to defects in
the camera sensor).<wbr/> This includes pixels that are stuck at certain
values,<wbr/> or have a response that does not accuractly encode the
incoming light from the scene.<wbr/></p>
<p>To avoid performance issues,<wbr/> there should be significantly fewer hot
pixels than actual pixels on the camera sensor.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.statistics.lensShadingMapMode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                    <span class="entry_type_enum_notes"><p>Do not include a lens shading map in the capture result.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                    <span class="entry_type_enum_notes"><p>Include a lens shading map in the capture result.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether the camera device will output the lens
shading map in output result metadata.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_RAW">RAW</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When set to ON,<wbr/>
<a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a> will be provided in
the output result metadata.<wbr/></p>
<p>ON is always supported on devices with the RAW capability.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_tonemap" class="section">tonemap</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.tonemap.curveBlue">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>tonemap.<wbr/>curve<wbr/>Blue
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 2
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <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>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the blue
channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
CONTRAST_<wbr/>CURVE.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>See <a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> for more details.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.tonemap.curveGreen">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>tonemap.<wbr/>curve<wbr/>Green
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 2
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <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>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the green
channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
CONTRAST_<wbr/>CURVE.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>See <a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> for more details.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.tonemap.curveRed">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>tonemap.<wbr/>curve<wbr/>Red
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 2
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <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>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the red
channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
CONTRAST_<wbr/>CURVE.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>0-1 on both input and output coordinates,<wbr/> normalized
as a floating-point value such that 0 == black and 1 == white.<wbr/></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Each channel's curve is defined by an array of control points:</p>
<pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> =
  [ P0in,<wbr/> P0out,<wbr/> P1in,<wbr/> P1out,<wbr/> P2in,<wbr/> P2out,<wbr/> P3in,<wbr/> P3out,<wbr/> ...,<wbr/> PNin,<wbr/> PNout ]
2 &lt;= N &lt;= <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></code></pre>
<p>These are sorted in order of increasing <code>Pin</code>; it is
required that input values 0.<wbr/>0 and 1.<wbr/>0 are included in the list to
define a complete mapping.<wbr/> For input values between control points,<wbr/>
the camera device must linearly interpolate between the control
points.<wbr/></p>
<p>Each curve can have an independent number of points,<wbr/> and the number
of points can be less than max (that is,<wbr/> the request doesn't have to
always provide a curve with number of points equivalent to
<a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a>).<wbr/></p>
<p>A few examples,<wbr/> and their corresponding graphical mappings; these
only specify the red channel and the precision is limited to 4
digits,<wbr/> for conciseness.<wbr/></p>
<p>Linear mapping:</p>
<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 ]
</code></pre>
<p><img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/></p>
<p>Invert mapping:</p>
<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 ]
</code></pre>
<p><img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/></p>
<p>Gamma 1/<wbr/>2.<wbr/>2 mapping,<wbr/> with 16 control points:</p>
<pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [
  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/>
  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/>
  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/>
  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 ]
</code></pre>
<p><img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/></p>
<p>Standard sRGB gamma mapping,<wbr/> per IEC 61966-2-1:1999,<wbr/> with 16 control points:</p>
<pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [
  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/>
  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/>
  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/>
  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 ]
</code></pre>
<p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For good quality of mapping,<wbr/> at least 128 control points are
preferred.<wbr/></p>
<p>A typical use case of this would be a gamma-1/<wbr/>2.<wbr/>2 curve,<wbr/> with as many
control points used as are available.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.tonemap.curve">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>tonemap.<wbr/>curve
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public as tonemapCurve]</span>

              <span class="entry_type_synthetic">[synthetic] </span>

              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a>
is CONTRAST_<wbr/>CURVE.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The tonemapCurve consist of three curves for each of red,<wbr/> green,<wbr/> and blue
channels respectively.<wbr/> The following example uses the red channel as an
example.<wbr/> The same logic applies to green and blue channel.<wbr/>
Each channel's curve is defined by an array of control points:</p>
<pre><code>curveRed =
  [ 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) ]
2 &lt;= N &lt;= <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></code></pre>
<p>These are sorted in order of increasing <code>Pin</code>; it is always
guaranteed that input values 0.<wbr/>0 and 1.<wbr/>0 are included in the list to
define a complete mapping.<wbr/> For input values between control points,<wbr/>
the camera device must linearly interpolate between the control
points.<wbr/></p>
<p>Each curve can have an independent number of points,<wbr/> and the number
of points can be less than max (that is,<wbr/> the request doesn't have to
always provide a curve with number of points equivalent to
<a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a>).<wbr/></p>
<p>A few examples,<wbr/> and their corresponding graphical mappings; these
only specify the red channel and the precision is limited to 4
digits,<wbr/> for conciseness.<wbr/></p>
<p>Linear mapping:</p>
<pre><code>curveRed = [ (0,<wbr/> 0),<wbr/> (1.<wbr/>0,<wbr/> 1.<wbr/>0) ]
</code></pre>
<p><img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/></p>
<p>Invert mapping:</p>
<pre><code>curveRed = [ (0,<wbr/> 1.<wbr/>0),<wbr/> (1.<wbr/>0,<wbr/> 0) ]
</code></pre>
<p><img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/></p>
<p>Gamma 1/<wbr/>2.<wbr/>2 mapping,<wbr/> with 16 control points:</p>
<pre><code>curveRed = [
  (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/>
  (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/>
  (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/>
  (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) ]
</code></pre>
<p><img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/></p>
<p>Standard sRGB gamma mapping,<wbr/> per IEC 61966-2-1:1999,<wbr/> with 16 control points:</p>
<pre><code>curveRed = [
  (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/>
  (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/>
  (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/>
  (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) ]
</code></pre>
<p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This entry is created by the framework from the curveRed,<wbr/> curveGreen and
curveBlue entries.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="controls_android.tonemap.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>tonemap.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">CONTRAST_CURVE</span>
                    <span class="entry_type_enum_notes"><p>Use the tone mapping curve specified in
the <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>* entries.<wbr/></p>
<p>All color enhancement and tonemapping must be disabled,<wbr/> except
for applying the tonemapping curve specified by
<a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/></p>
<p>Must not slow down frame rate relative to raw
sensor output.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Advanced gamma mapping and color enhancement may be applied,<wbr/> without
reducing frame rate compared to raw sensor output.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>High-quality gamma mapping and color enhancement will be applied,<wbr/> at
the cost of reduced frame rate compared to raw sensor output.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>High-level global contrast/<wbr/>gamma/<wbr/>tonemapping control.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.tonemap.availableToneMapModes">android.<wbr/>tonemap.<wbr/>available<wbr/>Tone<wbr/>Map<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When switching to an application-defined contrast curve by setting
<a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> to CONTRAST_<wbr/>CURVE,<wbr/> the curve is defined
per-channel with a set of <code>(in,<wbr/> out)</code> points that specify the
mapping from input high-bit-depth pixel value to the output
low-bit-depth value.<wbr/>  Since the actual pixel ranges of both input
and output may change depending on the camera pipeline,<wbr/> the values
are specified by normalized floating-point numbers.<wbr/></p>
<p>More-complex color mapping operations such as 3D color look-up
tables,<wbr/> selective chroma enhancement,<wbr/> or other non-linear color
transforms will be disabled when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
CONTRAST_<wbr/>CURVE.<wbr/></p>
<p>When using either FAST or HIGH_<wbr/>QUALITY,<wbr/> the camera device will
emit its own tonemap curve in <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/>
These values are always available,<wbr/> and as close as possible to the
actually used nonlinear/<wbr/>nonglobal transforms.<wbr/></p>
<p>If a request is sent with CONTRAST_<wbr/>CURVE with the camera device's
provided curve in FAST or HIGH_<wbr/>QUALITY,<wbr/> the image's tonemap will be
roughly the same.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.tonemap.maxCurvePoints">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points
            </td>
            <td class="entry_type">
                <span class="entry_type_name">int32</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Maximum number of supported points in the
tonemap curve that can be used for <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <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
less than this maximum,<wbr/> the camera device will resample the curve to its internal
representation,<wbr/> using linear interpolation.<wbr/></p>
<p>The output curves in the result metadata may have a different number
of points than the input curves,<wbr/> and will represent the actual
hardware curves used as closely as possible when linearly interpolated.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This value must be at least 64.<wbr/> This should be at least 128.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="static_android.tonemap.availableToneMapModes">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>tonemap.<wbr/>available<wbr/>Tone<wbr/>Map<wbr/>Modes
            </td>
            <td class="entry_type">
                <span class="entry_type_name">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [public as enumList]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <div class="entry_type_notes">list of enums</div>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>List of tonemapping modes for <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> that are supported by this camera
device.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Any value listed in <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Camera devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability will always list
CONTRAST_<wbr/>CURVE and FAST.<wbr/> This includes all FULL level devices.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.tonemap.curveBlue">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>tonemap.<wbr/>curve<wbr/>Blue
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 2
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <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>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the blue
channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
CONTRAST_<wbr/>CURVE.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>See <a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> for more details.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.tonemap.curveGreen">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>tonemap.<wbr/>curve<wbr/>Green
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 2
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <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>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the green
channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
CONTRAST_<wbr/>CURVE.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>See <a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> for more details.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.tonemap.curveRed">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>tonemap.<wbr/>curve<wbr/>Red
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n x 2
                </span>
              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[full] </span>


                <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>


            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the red
channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
CONTRAST_<wbr/>CURVE.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>0-1 on both input and output coordinates,<wbr/> normalized
as a floating-point value such that 0 == black and 1 == white.<wbr/></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Each channel's curve is defined by an array of control points:</p>
<pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> =
  [ P0in,<wbr/> P0out,<wbr/> P1in,<wbr/> P1out,<wbr/> P2in,<wbr/> P2out,<wbr/> P3in,<wbr/> P3out,<wbr/> ...,<wbr/> PNin,<wbr/> PNout ]
2 &lt;= N &lt;= <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></code></pre>
<p>These are sorted in order of increasing <code>Pin</code>; it is
required that input values 0.<wbr/>0 and 1.<wbr/>0 are included in the list to
define a complete mapping.<wbr/> For input values between control points,<wbr/>
the camera device must linearly interpolate between the control
points.<wbr/></p>
<p>Each curve can have an independent number of points,<wbr/> and the number
of points can be less than max (that is,<wbr/> the request doesn't have to
always provide a curve with number of points equivalent to
<a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a>).<wbr/></p>
<p>A few examples,<wbr/> and their corresponding graphical mappings; these
only specify the red channel and the precision is limited to 4
digits,<wbr/> for conciseness.<wbr/></p>
<p>Linear mapping:</p>
<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 ]
</code></pre>
<p><img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/></p>
<p>Invert mapping:</p>
<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 ]
</code></pre>
<p><img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/></p>
<p>Gamma 1/<wbr/>2.<wbr/>2 mapping,<wbr/> with 16 control points:</p>
<pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [
  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/>
  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/>
  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/>
  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 ]
</code></pre>
<p><img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/></p>
<p>Standard sRGB gamma mapping,<wbr/> per IEC 61966-2-1:1999,<wbr/> with 16 control points:</p>
<pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [
  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/>
  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/>
  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/>
  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 ]
</code></pre>
<p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>For good quality of mapping,<wbr/> at least 128 control points are
preferred.<wbr/></p>
<p>A typical use case of this would be a gamma-1/<wbr/>2.<wbr/>2 curve,<wbr/> with as many
control points used as are available.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.tonemap.curve">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>tonemap.<wbr/>curve
            </td>
            <td class="entry_type">
                <span class="entry_type_name">float</span>

              <span class="entry_type_visibility"> [public as tonemapCurve]</span>

              <span class="entry_type_synthetic">[synthetic] </span>

              <span class="entry_type_hwlevel">[full] </span>




            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a>
is CONTRAST_<wbr/>CURVE.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The tonemapCurve consist of three curves for each of red,<wbr/> green,<wbr/> and blue
channels respectively.<wbr/> The following example uses the red channel as an
example.<wbr/> The same logic applies to green and blue channel.<wbr/>
Each channel's curve is defined by an array of control points:</p>
<pre><code>curveRed =
  [ 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) ]
2 &lt;= N &lt;= <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></code></pre>
<p>These are sorted in order of increasing <code>Pin</code>; it is always
guaranteed that input values 0.<wbr/>0 and 1.<wbr/>0 are included in the list to
define a complete mapping.<wbr/> For input values between control points,<wbr/>
the camera device must linearly interpolate between the control
points.<wbr/></p>
<p>Each curve can have an independent number of points,<wbr/> and the number
of points can be less than max (that is,<wbr/> the request doesn't have to
always provide a curve with number of points equivalent to
<a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a>).<wbr/></p>
<p>A few examples,<wbr/> and their corresponding graphical mappings; these
only specify the red channel and the precision is limited to 4
digits,<wbr/> for conciseness.<wbr/></p>
<p>Linear mapping:</p>
<pre><code>curveRed = [ (0,<wbr/> 0),<wbr/> (1.<wbr/>0,<wbr/> 1.<wbr/>0) ]
</code></pre>
<p><img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/></p>
<p>Invert mapping:</p>
<pre><code>curveRed = [ (0,<wbr/> 1.<wbr/>0),<wbr/> (1.<wbr/>0,<wbr/> 0) ]
</code></pre>
<p><img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/></p>
<p>Gamma 1/<wbr/>2.<wbr/>2 mapping,<wbr/> with 16 control points:</p>
<pre><code>curveRed = [
  (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/>
  (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/>
  (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/>
  (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) ]
</code></pre>
<p><img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/></p>
<p>Standard sRGB gamma mapping,<wbr/> per IEC 61966-2-1:1999,<wbr/> with 16 control points:</p>
<pre><code>curveRed = [
  (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/>
  (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/>
  (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/>
  (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) ]
</code></pre>
<p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This entry is created by the framework from the curveRed,<wbr/> curveGreen and
curveBlue entries.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
                
          <tr class="entry" id="dynamic_android.tonemap.mode">
            <td class="entry_name
             " rowspan="3">
              android.<wbr/>tonemap.<wbr/>mode
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">CONTRAST_CURVE</span>
                    <span class="entry_type_enum_notes"><p>Use the tone mapping curve specified in
the <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>* entries.<wbr/></p>
<p>All color enhancement and tonemapping must be disabled,<wbr/> except
for applying the tonemapping curve specified by
<a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/></p>
<p>Must not slow down frame rate relative to raw
sensor output.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FAST</span>
                    <span class="entry_type_enum_notes"><p>Advanced gamma mapping and color enhancement may be applied,<wbr/> without
reducing frame rate compared to raw sensor output.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">HIGH_QUALITY</span>
                    <span class="entry_type_enum_notes"><p>High-quality gamma mapping and color enhancement will be applied,<wbr/> at
the cost of reduced frame rate compared to raw sensor output.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>High-level global contrast/<wbr/>gamma/<wbr/>tonemapping control.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p><a href="#static_android.tonemap.availableToneMapModes">android.<wbr/>tonemap.<wbr/>available<wbr/>Tone<wbr/>Map<wbr/>Modes</a></p>
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When switching to an application-defined contrast curve by setting
<a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> to CONTRAST_<wbr/>CURVE,<wbr/> the curve is defined
per-channel with a set of <code>(in,<wbr/> out)</code> points that specify the
mapping from input high-bit-depth pixel value to the output
low-bit-depth value.<wbr/>  Since the actual pixel ranges of both input
and output may change depending on the camera pipeline,<wbr/> the values
are specified by normalized floating-point numbers.<wbr/></p>
<p>More-complex color mapping operations such as 3D color look-up
tables,<wbr/> selective chroma enhancement,<wbr/> or other non-linear color
transforms will be disabled when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
CONTRAST_<wbr/>CURVE.<wbr/></p>
<p>When using either FAST or HIGH_<wbr/>QUALITY,<wbr/> the camera device will
emit its own tonemap curve in <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/>
These values are always available,<wbr/> and as close as possible to the
actually used nonlinear/<wbr/>nonglobal transforms.<wbr/></p>
<p>If a request is sent with CONTRAST_<wbr/>CURVE with the camera device's
provided curve in FAST or HIGH_<wbr/>QUALITY,<wbr/> the image's tonemap will be
roughly the same.<wbr/></p>
            </td>
          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_led" class="section">led</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.led.transmit">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>led.<wbr/>transmit
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [hidden as boolean]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>This LED is nominally used to indicate to the user
that the camera is powered on and may be streaming images back to the
Application Processor.<wbr/> In certain rare circumstances,<wbr/> the OS may
disable this when video is processed locally and not transmitted to
any untrusted applications.<wbr/></p>
<p>In particular,<wbr/> the LED <em>must</em> always be on when the data could be
transmitted off the device.<wbr/> The LED <em>should</em> always be on whenever
data is stored locally on the device.<wbr/></p>
<p>The LED <em>may</em> be off if a trusted application is using the data that
doesn't violate the above rules.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.led.transmit">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>led.<wbr/>transmit
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [hidden as boolean]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>This LED is nominally used to indicate to the user
that the camera is powered on and may be streaming images back to the
Application Processor.<wbr/> In certain rare circumstances,<wbr/> the OS may
disable this when video is processed locally and not transmitted to
any untrusted applications.<wbr/></p>
<p>In particular,<wbr/> the LED <em>must</em> always be on when the data could be
transmitted off the device.<wbr/> The LED <em>should</em> always be on whenever
data is stored locally on the device.<wbr/></p>
<p>The LED <em>may</em> be off if a trusted application is using the data that
doesn't violate the above rules.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.led.availableLeds">
            <td class="entry_name
             " rowspan="1">
              android.<wbr/>led.<wbr/>available<wbr/>Leds
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>
                <span class="entry_type_container">x</span>

                <span class="entry_type_array">
                  n
                </span>
              <span class="entry_type_visibility"> [hidden]</span>





                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">TRANSMIT</span>
                    <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>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>A list of camera LEDs that are available on this system.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>


          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_info" class="section">info</td></tr>


      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.info.supportedHardwareLevel">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">LIMITED</span>
                    <span class="entry_type_enum_notes"><p>This camera device has only limited capabilities.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">FULL</span>
                    <span class="entry_type_enum_notes"><p>This camera device is capable of supporting advanced imaging applications.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">LEGACY</span>
                    <span class="entry_type_enum_notes"><p>This camera device is running in backward compatibility mode.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Generally classifies the overall set of the camera device functionality.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Camera devices will come in three flavors: LEGACY,<wbr/> LIMITED and FULL.<wbr/></p>
<p>A FULL device will support below capabilities:</p>
<ul>
<li>30fps operation at maximum resolution (== sensor resolution) is preferred,<wbr/> more than
  20fps is required,<wbr/> for at least uncompressed YUV
  output.<wbr/> (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains BURST_<wbr/>CAPTURE)</li>
<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>
<li>Manual sensor control (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains MANUAL_<wbr/>SENSOR)</li>
<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>
<li>Arbitrary cropping region (<a href="#static_android.scaler.croppingType">android.<wbr/>scaler.<wbr/>cropping<wbr/>Type</a> <code>==</code> FREEFORM)</li>
<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>
<li>The required stream configuration defined in <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a></li>
<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>
<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>
</ul>
<p>A LIMITED device may have some or none of the above characteristics.<wbr/>
To find out more refer to <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>.<wbr/></p>
<p>Some features are not part of any particular hardware level or capability and must be
queried separately.<wbr/> These include:</p>
<ul>
<li>Calibrated timestamps (<a href="#static_android.sensor.info.timestampSource">android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source</a> <code>==</code> REALTIME)</li>
<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>
<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>
<li>Optical or electrical image stabilization
  (<a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a>,<wbr/>
   <a href="#static_android.control.availableVideoStabilizationModes">android.<wbr/>control.<wbr/>available<wbr/>Video<wbr/>Stabilization<wbr/>Modes</a>)</li>
</ul>
<p>A LEGACY device does not support per-frame control,<wbr/> manual sensor control,<wbr/> manual
post-processing,<wbr/> arbitrary cropping regions,<wbr/> and has relaxed performance constraints.<wbr/></p>
<p>Each higher level supports everything the lower level supports
in this order: FULL <code>&gt;</code> LIMITED <code>&gt;</code> LEGACY.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>The camera 3 HAL device can implement one of two possible
operational modes; limited and full.<wbr/> Full support is
expected from new higher-end devices.<wbr/> Limited mode has
hardware requirements roughly in line with those for a
camera HAL device v1 implementation,<wbr/> and is expected from
older or inexpensive devices.<wbr/> Full is a strict superset of
limited,<wbr/> and they share the same essential operational flow.<wbr/></p>
<p>For full details refer to "S3.<wbr/> Operational Modes" in camera3.<wbr/>h</p>
<p>Camera HAL3+ must not implement LEGACY mode.<wbr/> It is there
for backwards compatibility in the <code>android.<wbr/>hardware.<wbr/>camera2</code>
user-facing API only.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_blackLevel" class="section">blackLevel</td></tr>


      <tr><td colspan="6" class="kind">controls</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="controls_android.blackLevel.lock">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>black<wbr/>Level.<wbr/>lock
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public as boolean]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether black-level compensation is locked
to its current values,<wbr/> or is free to vary.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_HAL2">HAL2</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When set to <code>true</code> (ON),<wbr/> the values used for black-level
compensation will not change until the lock is set to
<code>false</code> (OFF).<wbr/></p>
<p>Since changes to certain capture parameters (such as
exposure time) may require resetting of black level
compensation,<wbr/> the camera device must report whether setting
the black level lock was successful in the output result
metadata.<wbr/></p>
<p>For example,<wbr/> if a sequence of requests is as follows:</p>
<ul>
<li>Request 1: Exposure = 10ms,<wbr/> Black level lock = OFF</li>
<li>Request 2: Exposure = 10ms,<wbr/> Black level lock = ON</li>
<li>Request 3: Exposure = 10ms,<wbr/> Black level lock = ON</li>
<li>Request 4: Exposure = 20ms,<wbr/> Black level lock = ON</li>
<li>Request 5: Exposure = 20ms,<wbr/> Black level lock = ON</li>
<li>Request 6: Exposure = 20ms,<wbr/> Black level lock = ON</li>
</ul>
<p>And the exposure change in Request 4 requires the camera
device to reset the black level offsets,<wbr/> then the output
result metadata is expected to be:</p>
<ul>
<li>Result 1: Exposure = 10ms,<wbr/> Black level lock = OFF</li>
<li>Result 2: Exposure = 10ms,<wbr/> Black level lock = ON</li>
<li>Result 3: Exposure = 10ms,<wbr/> Black level lock = ON</li>
<li>Result 4: Exposure = 20ms,<wbr/> Black level lock = OFF</li>
<li>Result 5: Exposure = 20ms,<wbr/> Black level lock = ON</li>
<li>Result 6: Exposure = 20ms,<wbr/> Black level lock = ON</li>
</ul>
<p>This indicates to the application that on frame 4,<wbr/> black
levels were reset due to exposure value changes,<wbr/> and pixel
values may not be consistent across captures.<wbr/></p>
<p>The camera device will maintain the lock to the extent
possible,<wbr/> only overriding the lock to OFF when changes to
other request parameters require a black level recalculation
or reset.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If for some reason black level locking is no longer possible
(for example,<wbr/> the analog gain has changed,<wbr/> which forces
black level offsets to be recalculated),<wbr/> then the HAL must
override this request (and it must report 'OFF' when this
does happen) until the next capture for which locking is
possible again.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.blackLevel.lock">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>black<wbr/>Level.<wbr/>lock
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">byte</span>

              <span class="entry_type_visibility"> [public as boolean]</span>


              <span class="entry_type_hwlevel">[full] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">OFF</span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">ON</span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>Whether black-level compensation is locked
to its current values,<wbr/> or is free to vary.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_HAL2">HAL2</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Whether the black level offset was locked for this frame.<wbr/>  Should be
ON if <a href="#controls_android.blackLevel.lock">android.<wbr/>black<wbr/>Level.<wbr/>lock</a> was ON in the capture request,<wbr/> unless
a change in other capture settings forced the camera device to
perform a black level reset.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>If for some reason black level locking is no longer possible
(for example,<wbr/> the analog gain has changed,<wbr/> which forces
black level offsets to be recalculated),<wbr/> then the HAL must
override this request (and it must report 'OFF' when this
does happen) until the next capture for which locking is
possible again.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
  <tr><td colspan="6" id="section_sync" class="section">sync</td></tr>


      <tr><td colspan="6" class="kind">dynamic</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="dynamic_android.sync.frameNumber">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sync.<wbr/>frame<wbr/>Number
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">int64</span>

              <span class="entry_type_visibility"> [hidden]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">CONVERGING</span>
                    <span class="entry_type_enum_value">-1</span>
                    <span class="entry_type_enum_notes"><p>The current result is not yet fully synchronized to any request.<wbr/></p>
<p>Synchronization is in progress,<wbr/> and reading metadata from this
result may include a mix of data that have taken effect since the
last synchronization time.<wbr/></p>
<p>In some future result,<wbr/> within <a href="#static_android.sync.maxLatency">android.<wbr/>sync.<wbr/>max<wbr/>Latency</a> frames,<wbr/>
this value will update to the actual frame number frame number
the result is guaranteed to be synchronized to (as long as the
request settings remain constant).<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">UNKNOWN</span>
                    <span class="entry_type_enum_value">-2</span>
                    <span class="entry_type_enum_notes"><p>The current result's synchronization status is unknown.<wbr/></p>
<p>The result may have already converged,<wbr/> or it may be in
progress.<wbr/>  Reading from this result may include some mix
of settings from past requests.<wbr/></p>
<p>After a settings change,<wbr/> the new settings will eventually all
take effect for the output buffers and results.<wbr/> However,<wbr/> this
value will not change when that happens.<wbr/> Altering settings
rapidly may provide outcomes using mixes of settings from recent
requests.<wbr/></p>
<p>This value is intended primarily for backwards compatibility with
the older camera implementations (for android.<wbr/>hardware.<wbr/>Camera).<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The frame number corresponding to the last request
with which the output result (metadata + buffers) has been fully
synchronized.<wbr/></p>
            </td>

            <td class="entry_units">
            </td>

            <td class="entry_range">
              <p>Either a non-negative value corresponding to a
<code>frame_<wbr/>number</code>,<wbr/> or one of the two enums (CONVERGING /<wbr/> UNKNOWN).<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>When a request is submitted to the camera device,<wbr/> there is usually a
delay of several frames before the controls get applied.<wbr/> A camera
device may either choose to account for this delay by implementing a
pipeline and carefully submit well-timed atomic control updates,<wbr/> or
it may start streaming control changes that span over several frame
boundaries.<wbr/></p>
<p>In the latter case,<wbr/> whenever a request's settings change relative to
the previous submitted request,<wbr/> the full set of changes may take
multiple frame durations to fully take effect.<wbr/> Some settings may
take effect sooner (in less frame durations) than others.<wbr/></p>
<p>While a set of control changes are being propagated,<wbr/> this value
will be CONVERGING.<wbr/></p>
<p>Once it is fully known that a set of control changes have been
finished propagating,<wbr/> and the resulting updated control settings
have been read back by the camera device,<wbr/> this value will be set
to a non-negative frame number (corresponding to the request to
which the results have synchronized to).<wbr/></p>
<p>Older camera device implementations may not have a way to detect
when all camera controls have been applied,<wbr/> and will always set this
value to UNKNOWN.<wbr/></p>
<p>FULL capability devices will always have this value set to the
frame number of the request corresponding to this result.<wbr/></p>
<p><em>Further details</em>:</p>
<ul>
<li>Whenever a request differs from the last request,<wbr/> any future
results not yet returned may have this value set to CONVERGING (this
could include any in-progress captures not yet returned by the camera
device,<wbr/> for more details see pipeline considerations below).<wbr/></li>
<li>Submitting a series of multiple requests that differ from the
previous request (e.<wbr/>g.<wbr/> r1,<wbr/> r2,<wbr/> r3 s.<wbr/>t.<wbr/> r1 != r2 != r3)
moves the new synchronization frame to the last non-repeating
request (using the smallest frame number from the contiguous list of
repeating requests).<wbr/></li>
<li>Submitting the same request repeatedly will not change this value
to CONVERGING,<wbr/> if it was already a non-negative value.<wbr/></li>
<li>When this value changes to non-negative,<wbr/> that means that all of the
metadata controls from the request have been applied,<wbr/> all of the
metadata controls from the camera device have been read to the
updated values (into the result),<wbr/> and all of the graphics buffers
corresponding to this result are also synchronized to the request.<wbr/></li>
</ul>
<p><em>Pipeline considerations</em>:</p>
<p>Submitting a request with updated controls relative to the previously
submitted requests may also invalidate the synchronization state
of all the results corresponding to currently in-flight requests.<wbr/></p>
<p>In other words,<wbr/> results for this current request and up to
<a href="#static_android.request.pipelineMaxDepth">android.<wbr/>request.<wbr/>pipeline<wbr/>Max<wbr/>Depth</a> prior requests may have their
<a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> change to CONVERGING.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Using UNKNOWN here is illegal unless <a href="#static_android.sync.maxLatency">android.<wbr/>sync.<wbr/>max<wbr/>Latency</a>
is also UNKNOWN.<wbr/></p>
<p>FULL capability devices should simply set this value to the
<code>frame_<wbr/>number</code> of the request this result corresponds to.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>
      <tr><td colspan="6" class="kind">static</td></tr>

      <thead class="entries_header">
        <tr>
          <th class="th_name">Property Name</th>
          <th class="th_type">Type</th>
          <th class="th_description">Description</th>
          <th class="th_units">Units</th>
          <th class="th_range">Range</th>
          <th class="th_tags">Tags</th>
        </tr>
      </thead>

      <tbody>

        

        

        

        

                
          <tr class="entry" id="static_android.sync.maxLatency">
            <td class="entry_name
             " rowspan="5">
              android.<wbr/>sync.<wbr/>max<wbr/>Latency
            </td>
            <td class="entry_type">
                <span class="entry_type_name entry_type_name_enum">int32</span>

              <span class="entry_type_visibility"> [public]</span>


              <span class="entry_type_hwlevel">[legacy] </span>



                <ul class="entry_type_enum">
                  <li>
                    <span class="entry_type_enum_name">PER_FRAME_CONTROL</span>
                    <span class="entry_type_enum_value">0</span>
                    <span class="entry_type_enum_notes"><p>Every frame has the requests immediately applied.<wbr/></p>
<p>Furthermore for all results,<wbr/>
<code><a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == CaptureResult#getFrameNumber()</code></p>
<p>Changing controls over multiple requests one after another will
produce results that have those controls applied atomically
each frame.<wbr/></p>
<p>All FULL capability devices will have this as their maxLatency.<wbr/></p></span>
                  </li>
                  <li>
                    <span class="entry_type_enum_name">UNKNOWN</span>
                    <span class="entry_type_enum_value">-1</span>
                    <span class="entry_type_enum_notes"><p>Each new frame has some subset (potentially the entire set)
of the past requests applied to the camera settings.<wbr/></p>
<p>By submitting a series of identical requests,<wbr/> the camera device
will eventually have the camera settings applied,<wbr/> but it is
unknown when that exact point will be.<wbr/></p>
<p>All LEGACY capability devices will have this as their maxLatency.<wbr/></p></span>
                  </li>
                </ul>

            </td> <!-- entry_type -->

            <td class="entry_description">
              <p>The maximum number of frames that can occur after a request
(different than the previous) has been submitted,<wbr/> and before the
result's state becomes synchronized (by setting
<a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> to a non-negative value).<wbr/></p>
            </td>

            <td class="entry_units">
              Frame counts
            </td>

            <td class="entry_range">
              <p>A positive value,<wbr/> PER_<wbr/>FRAME_<wbr/>CONTROL,<wbr/> or UNKNOWN.<wbr/></p>
            </td>

            <td class="entry_tags">
              <ul class="entry_tags">
                  <li><a href="#tag_V1">V1</a></li>
              </ul>
            </td>

          </tr>
          <tr class="entries_header">
            <th class="th_details" colspan="5">Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>This defines the maximum distance (in number of metadata results),<wbr/>
between <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> and the equivalent
frame number for that result.<wbr/></p>
<p>In other words this acts as an upper boundary for how many frames
must occur before the camera device knows for a fact that the new
submitted camera settings have been applied in outgoing frames.<wbr/></p>
<p>For example if the distance was 2,<wbr/></p>
<pre><code>initial request = X (repeating)
request1 = X
request2 = Y
request3 = Y
request4 = Y

where requestN has frameNumber N,<wbr/> and the first of the repeating
initial request's has frameNumber F (and F &lt; 1).<wbr/>

initial result = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == F }
result1 = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == F }
result2 = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == CONVERGING }
result3 = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == CONVERGING }
result4 = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == 2 }

where resultN has frameNumber N.<wbr/>
</code></pre>
<p>Since <code>result4</code> has a <code>frameNumber == 4</code> and
<code><a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == 2</code>,<wbr/> the distance is clearly
<code>4 - 2 = 2</code>.<wbr/></p>
            </td>
          </tr>

          <tr class="entries_header">
            <th class="th_details" colspan="5">HAL Implementation Details</th>
          </tr>
          <tr class="entry_cont">
            <td class="entry_details" colspan="5">
              <p>Use <code>frame_<wbr/>count</code> from camera3_<wbr/>request_<wbr/>t instead of
<a href="#controls_android.request.frameCount">android.<wbr/>request.<wbr/>frame<wbr/>Count</a> or <code>CaptureResult#getFrameNumber()</code>.<wbr/></p>
<p>LIMITED devices are strongly encouraged to use a non-negative
value.<wbr/> If UNKNOWN is used here then app developers do not have a way
to know when sensor settings have been applied.<wbr/></p>
            </td>
          </tr>

          <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
           <!-- end of entry -->
        
        

      <!-- end of kind -->
      </tbody>

  <!-- end of section -->
<!-- </namespace> -->
  </table>

  <div class="tags" id="tag_index">
    <h2>Tags</h2>
    <ul>
      <li id="tag_BC">BC - 
        Needed for backwards compatibility with old Java API
    
        <ul class="tags_entries">
          <li><a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> (controls)</li>
          <li><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> (controls)</li>
          <li><a href="#controls_android.control.aeLock">android.control.aeLock</a> (controls)</li>
          <li><a href="#controls_android.control.aeMode">android.control.aeMode</a> (controls)</li>
          <li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a> (controls)</li>
          <li><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> (controls)</li>
          <li><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> (controls)</li>
          <li><a href="#controls_android.control.afMode">android.control.afMode</a> (controls)</li>
          <li><a href="#controls_android.control.afRegions">android.control.afRegions</a> (controls)</li>
          <li><a href="#controls_android.control.afTrigger">android.control.afTrigger</a> (controls)</li>
          <li><a href="#controls_android.control.awbLock">android.control.awbLock</a> (controls)</li>
          <li><a href="#controls_android.control.awbMode">android.control.awbMode</a> (controls)</li>
          <li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a> (controls)</li>
          <li><a href="#controls_android.control.captureIntent">android.control.captureIntent</a> (controls)</li>
          <li><a href="#controls_android.control.effectMode">android.control.effectMode</a> (controls)</li>
          <li><a href="#controls_android.control.mode">android.control.mode</a> (controls)</li>
          <li><a href="#controls_android.control.sceneMode">android.control.sceneMode</a> (controls)</li>
          <li><a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a> (controls)</li>
          <li><a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a> (static)</li>
          <li><a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a> (static)</li>
          <li><a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a> (static)</li>
          <li><a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a> (static)</li>
          <li><a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a> (static)</li>
          <li><a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a> (static)</li>
          <li><a href="#static_android.control.availableEffects">android.control.availableEffects</a> (static)</li>
          <li><a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a> (static)</li>
          <li><a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a> (static)</li>
          <li><a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a> (static)</li>
          <li><a href="#static_android.control.maxRegions">android.control.maxRegions</a> (static)</li>
          <li><a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a> (static)</li>
          <li><a href="#controls_android.flash.mode">android.flash.mode</a> (controls)</li>
          <li><a href="#static_android.flash.info.available">android.flash.info.available</a> (static)</li>
          <li><a href="#controls_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a> (controls)</li>
          <li><a href="#controls_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a> (controls)</li>
          <li><a href="#controls_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a> (controls)</li>
          <li><a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a> (controls)</li>
          <li><a href="#controls_android.jpeg.quality">android.jpeg.quality</a> (controls)</li>
          <li><a href="#controls_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a> (controls)</li>
          <li><a href="#controls_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a> (controls)</li>
          <li><a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a> (static)</li>
          <li><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> (controls)</li>
          <li><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a> (static)</li>
          <li><a href="#dynamic_android.lens.focusRange">android.lens.focusRange</a> (dynamic)</li>
          <li><a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a> (static)</li>
          <li><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> (controls)</li>
          <li><a href="#static_android.scaler.availableFormats">android.scaler.availableFormats</a> (static)</li>
          <li><a href="#static_android.scaler.availableJpegMinDurations">android.scaler.availableJpegMinDurations</a> (static)</li>
          <li><a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a> (static)</li>
          <li><a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> (static)</li>
          <li><a href="#static_android.scaler.availableProcessedMinDurations">android.scaler.availableProcessedMinDurations</a> (static)</li>
          <li><a href="#static_android.scaler.availableProcessedSizes">android.scaler.availableProcessedSizes</a> (static)</li>
          <li><a href="#static_android.scaler.availableRawMinDurations">android.scaler.availableRawMinDurations</a> (static)</li>
          <li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> (static)</li>
          <li><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> (static)</li>
          <li><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> (static)</li>
          <li><a href="#static_android.sensor.orientation">android.sensor.orientation</a> (static)</li>
          <li><a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a> (dynamic)</li>
          <li><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> (controls)</li>
          <li><a href="#static_android.statistics.info.maxFaceCount">android.statistics.info.maxFaceCount</a> (static)</li>
          <li><a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a> (dynamic)</li>
          <li><a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a> (dynamic)</li>
          <li><a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a> (dynamic)</li>
          <li><a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a> (dynamic)</li>
          <li><a href="#dynamic_android.lens.focalLength">android.lens.focalLength</a> (dynamic)</li>
          <li><a href="#dynamic_android.lens.focusDistance">android.lens.focusDistance</a> (dynamic)</li>
        </ul>
      </li> <!-- tag_BC -->
      <li id="tag_V1">V1 - 
        New features for first camera 2 release (API1)
    
        <ul class="tags_entries">
          <li><a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a> (static)</li>
          <li><a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a> (static)</li>
          <li><a href="#controls_android.edge.mode">android.edge.mode</a> (controls)</li>
          <li><a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a> (static)</li>
          <li><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a> (controls)</li>
          <li><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a> (static)</li>
          <li><a href="#controls_android.lens.aperture">android.lens.aperture</a> (controls)</li>
          <li><a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> (controls)</li>
          <li><a href="#controls_android.lens.focalLength">android.lens.focalLength</a> (controls)</li>
          <li><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> (controls)</li>
          <li><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (controls)</li>
          <li><a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a> (static)</li>
          <li><a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a> (static)</li>
          <li><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a> (static)</li>
          <li><a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a> (static)</li>
          <li><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> (static)</li>
          <li><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a> (static)</li>
          <li><a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a> (static)</li>
          <li><a href="#dynamic_android.lens.state">android.lens.state</a> (dynamic)</li>
          <li><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a> (controls)</li>
          <li><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a> (static)</li>
          <li><a href="#controls_android.request.id">android.request.id</a> (controls)</li>
          <li><a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a> (static)</li>
          <li><a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a> (static)</li>
          <li><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a> (controls)</li>
          <li><a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> (controls)</li>
          <li><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> (controls)</li>
          <li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> (static)</li>
          <li><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a> (static)</li>
          <li><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a> (static)</li>
          <li><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> (static)</li>
          <li><a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> (static)</li>
          <li><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a> (static)</li>
          <li><a href="#dynamic_android.sensor.rollingShutterSkew">android.sensor.rollingShutterSkew</a> (dynamic)</li>
          <li><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a> (controls)</li>
          <li><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a> (static)</li>
          <li><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a> (dynamic)</li>
          <li><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> (dynamic)</li>
          <li><a href="#static_android.sync.maxLatency">android.sync.maxLatency</a> (static)</li>
          <li><a href="#dynamic_android.edge.mode">android.edge.mode</a> (dynamic)</li>
          <li><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a> (dynamic)</li>
          <li><a href="#dynamic_android.lens.aperture">android.lens.aperture</a> (dynamic)</li>
          <li><a href="#dynamic_android.lens.filterDensity">android.lens.filterDensity</a> (dynamic)</li>
          <li><a href="#dynamic_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (dynamic)</li>
          <li><a href="#dynamic_android.noiseReduction.mode">android.noiseReduction.mode</a> (dynamic)</li>
        </ul>
      </li> <!-- tag_V1 -->
      <li id="tag_RAW">RAW - 
        Needed for useful RAW image processing and DNG file support
    
        <ul class="tags_entries">
          <li><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a> (controls)</li>
          <li><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a> (static)</li>
          <li><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> (static)</li>
          <li><a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a> (static)</li>
          <li><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> (static)</li>
          <li><a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a> (static)</li>
          <li><a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a> (static)</li>
          <li><a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a> (static)</li>
          <li><a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a> (static)</li>
          <li><a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a> (static)</li>
          <li><a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a> (static)</li>
          <li><a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a> (static)</li>
          <li><a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a> (static)</li>
          <li><a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a> (static)</li>
          <li><a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a> (static)</li>
          <li><a href="#static_android.sensor.profileHueSatMapDimensions">android.sensor.profileHueSatMapDimensions</a> (static)</li>
          <li><a href="#dynamic_android.sensor.neutralColorPoint">android.sensor.neutralColorPoint</a> (dynamic)</li>
          <li><a href="#dynamic_android.sensor.noiseProfile">android.sensor.noiseProfile</a> (dynamic)</li>
          <li><a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a> (dynamic)</li>
          <li><a href="#dynamic_android.sensor.profileToneCurve">android.sensor.profileToneCurve</a> (dynamic)</li>
          <li><a href="#dynamic_android.sensor.greenSplit">android.sensor.greenSplit</a> (dynamic)</li>
          <li><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a> (controls)</li>
          <li><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a> (static)</li>
          <li><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a> (dynamic)</li>
          <li><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> (controls)</li>
          <li><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a> (dynamic)</li>
        </ul>
      </li> <!-- tag_RAW -->
      <li id="tag_HAL2">HAL2 - 
        Entry is only used by camera device HAL 2.x
    
        <ul class="tags_entries">
          <li><a href="#controls_android.request.inputStreams">android.request.inputStreams</a> (controls)</li>
          <li><a href="#controls_android.request.outputStreams">android.request.outputStreams</a> (controls)</li>
          <li><a href="#controls_android.request.type">android.request.type</a> (controls)</li>
          <li><a href="#static_android.request.maxNumReprocessStreams">android.request.maxNumReprocessStreams</a> (static)</li>
          <li><a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a> (controls)</li>
        </ul>
      </li> <!-- tag_HAL2 -->
      <li id="tag_FULL">FULL - 
        Entry is required for full hardware level devices, and optional for other hardware levels
    
        <ul class="tags_entries">
          <li><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a> (static)</li>
        </ul>
      </li> <!-- tag_FULL -->
      <li id="tag_FUTURE">FUTURE - 
        Entry is  under-specified and is not required for now. This is for book-keeping purpose,
        do not implement or use it, it may be revised for future.
    
        <ul class="tags_entries">
          <li><a href="#controls_android.demosaic.mode">android.demosaic.mode</a> (controls)</li>
          <li><a href="#controls_android.edge.strength">android.edge.strength</a> (controls)</li>
          <li><a href="#controls_android.flash.firingPower">android.flash.firingPower</a> (controls)</li>
          <li><a href="#controls_android.flash.firingTime">android.flash.firingTime</a> (controls)</li>
          <li><a href="#static_android.flash.info.chargeDuration">android.flash.info.chargeDuration</a> (static)</li>
          <li><a href="#static_android.flash.colorTemperature">android.flash.colorTemperature</a> (static)</li>
          <li><a href="#static_android.flash.maxEnergy">android.flash.maxEnergy</a> (static)</li>
          <li><a href="#dynamic_android.jpeg.size">android.jpeg.size</a> (dynamic)</li>
          <li><a href="#static_android.lens.opticalAxisAngle">android.lens.opticalAxisAngle</a> (static)</li>
          <li><a href="#static_android.lens.position">android.lens.position</a> (static)</li>
          <li><a href="#controls_android.noiseReduction.strength">android.noiseReduction.strength</a> (controls)</li>
          <li><a href="#controls_android.request.metadataMode">android.request.metadataMode</a> (controls)</li>
          <li><a href="#static_android.sensor.baseGainFactor">android.sensor.baseGainFactor</a> (static)</li>
          <li><a href="#dynamic_android.sensor.temperature">android.sensor.temperature</a> (dynamic)</li>
          <li><a href="#controls_android.shading.strength">android.shading.strength</a> (controls)</li>
          <li><a href="#controls_android.statistics.histogramMode">android.statistics.histogramMode</a> (controls)</li>
          <li><a href="#controls_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a> (controls)</li>
          <li><a href="#static_android.statistics.info.histogramBucketCount">android.statistics.info.histogramBucketCount</a> (static)</li>
          <li><a href="#static_android.statistics.info.maxHistogramCount">android.statistics.info.maxHistogramCount</a> (static)</li>
          <li><a href="#static_android.statistics.info.maxSharpnessMapValue">android.statistics.info.maxSharpnessMapValue</a> (static)</li>
          <li><a href="#static_android.statistics.info.sharpnessMapSize">android.statistics.info.sharpnessMapSize</a> (static)</li>
          <li><a href="#dynamic_android.statistics.histogram">android.statistics.histogram</a> (dynamic)</li>
          <li><a href="#dynamic_android.statistics.sharpnessMap">android.statistics.sharpnessMap</a> (dynamic)</li>
        </ul>
      </li> <!-- tag_FUTURE -->
    </ul>
  </div>

  [ <a href="#">top</a> ]

</body>
</html>

登录后可以享受更多权益