Camera2: Docs cleanup, especially units and range
- Add entries for units and range into javadoc
- Fix up existing units entries and add new ones
- Fix up range entries to be consistent for enums
- Add range entries where it makes sense
- Minor fix to javadoc gen to allow for code indentation
- Lots of edits for consistency, especially to
available* entries.
Bug: 16525650
Change-Id: Id09663d897ec98122073e6e13719731ec0de4dad
diff --git a/core/java/android/hardware/camera2/CaptureResult.java b/core/java/android/hardware/camera2/CaptureResult.java
index fc1baf2..d208649 100644
--- a/core/java/android/hardware/camera2/CaptureResult.java
+++ b/core/java/android/hardware/camera2/CaptureResult.java
@@ -327,7 +327,6 @@
* modify the comment blocks at the start or end.
*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/
-
/**
* <p>The mode control selects how the image data is converted from the
* sensor's native color into linear sRGB color.</p>
@@ -369,6 +368,12 @@
* </code></pre>
* <p>Both the input and output value ranges must match. Overflow/underflow
* values are clipped to fit within the range.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX TRANSFORM_MATRIX}</li>
+ * <li>{@link #COLOR_CORRECTION_MODE_FAST FAST}</li>
+ * <li>{@link #COLOR_CORRECTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
+ * </ul></p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -398,6 +403,7 @@
* 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.</p>
+ * <p><b>Units</b>: Unitless scale factors</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -420,6 +426,7 @@
* TRANSFORM_MATRIX.</p>
* <p>The gains in the result metadata are the gains actually
* applied by the camera device to the current frame.</p>
+ * <p><b>Units</b>: Unitless gain factors</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -434,8 +441,6 @@
/**
* <p>Mode of operation for the chromatic aberration correction algorithm.</p>
- * <p>This must be set to a valid mode from
- * {@link CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES android.colorCorrection.availableAberrationModes}.</p>
* <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. This metadata defines
* the high level control of chromatic aberration correction algorithm, which aims to
@@ -447,6 +452,14 @@
* capture rate. FAST means the camera device will not slow down capture rate when
* applying aberration correction.</p>
* <p>LEGACY devices will always be in FAST mode.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_OFF OFF}</li>
+ * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_FAST FAST}</li>
+ * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES android.colorCorrection.availableAberrationModes}</p>
* <p>This key is available on all devices.</p>
*
* @see CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES
@@ -480,7 +493,7 @@
* options for the antibanding mode. The
* {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes} key contains
* the available modes for a given camera device.</p>
- * <p>The default mode is AUTO, which must be supported by all
+ * <p>The default mode is AUTO, which is supported by all
* camera devices.</p>
* <p>If manual exposure control is enabled (by setting
* {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} to OFF),
@@ -488,6 +501,15 @@
* ensure it selects exposure times that do not cause banding
* issues. The {@link CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist
* the application in this.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_OFF OFF}</li>
+ * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_50HZ 50HZ}</li>
+ * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_60HZ 60HZ}</li>
+ * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_AUTO AUTO}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br></p>
+ * <p>{@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes}</p>
* <p>This key is available on all devices.</p>
*
* @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES
@@ -521,6 +543,9 @@
* state. Once the new exposure target is reached, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} 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).</p>
+ * <p><b>Units</b>: Compensation steps</p>
+ * <p><b>Range of valid values:</b><br>
+ * {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}</p>
* <p>This key is available on all devices.</p>
*
* @see CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE
@@ -536,9 +561,11 @@
/**
* <p>Whether auto-exposure (AE) is currently locked to its latest
* calculated values.</p>
- * <p>Note that even when AE is locked, the flash may be
- * fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH / ON_ALWAYS_FLASH /
- * ON_AUTO_FLASH_REDEYE.</p>
+ * <p>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).</p>
+ * <p>Note that even when AE is locked, the flash may be fired if
+ * the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH /
+ * ON_ALWAYS_FLASH / ON_AUTO_FLASH_REDEYE.</p>
* <p>When {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} is changed, even if the AE lock
* is ON, the camera device will still adjust its exposure value.</p>
* <p>If AE precapture is triggered (see {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger})
@@ -547,6 +574,19 @@
* parameters. The flash may be fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}
* is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the
* {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_ALWAYS_FLASH, the scene may become overexposed.</p>
+ * <p>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:</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, set the request to manual AE</li>
+ * <li>Submit the capture request, proceed to run manual AE as desired.</li>
+ * </ol>
* <p>See {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE lock related state transition details.</p>
* <p>This key is available on all devices.</p>
*
@@ -582,8 +622,19 @@
* camera device auto-exposure routine for the overridden
* fields for a given capture will be available in its
* CaptureResult.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_AE_MODE_OFF OFF}</li>
+ * <li>{@link #CONTROL_AE_MODE_ON ON}</li>
+ * <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH ON_AUTO_FLASH}</li>
+ * <li>{@link #CONTROL_AE_MODE_ON_ALWAYS_FLASH ON_ALWAYS_FLASH}</li>
+ * <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE ON_AUTO_FLASH_REDEYE}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES android.control.aeAvailableModes}</p>
* <p>This key is available on all devices.</p>
*
+ * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES
* @see CaptureRequest#CONTROL_MODE
* @see CameraCharacteristics#FLASH_INFO_AVAILABLE
* @see CaptureRequest#FLASH_MODE
@@ -601,25 +652,35 @@
new Key<Integer>("android.control.aeMode", int.class);
/**
- * <p>List of areas to use for
- * metering.</p>
- * <p>Optional. Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe} is 0.
+ * <p>List of metering areas to use for auto-exposure adjustment.</p>
+ * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe} is 0.
* Otherwise will always be present.</p>
+ * <p>The maximum number of regions supported by the device is determined by the value
+ * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe}.</p>
* <p>The coordinate system is based on the active pixel array,
* with (0,0) being the top-left pixel in the active pixel array, and
* ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1,
* {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the
* bottom-right pixel in the active pixel array.</p>
- * <p>The weight must range from 0 to 1000, and represents a weight
+ * <p>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.</p>
- * <p>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 {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata,
- * the camera device will ignore the sections outside the region and output the
- * used sections in the result metadata.</p>
+ * <p>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.</p>
+ * <p>If all regions have 0 weight, then no specific metering area needs to be used by the
+ * camera device.</p>
+ * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} 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.</p>
+ * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
+ * <p><b>Range of valid values:</b><br>
+ * Coordinates must be between <code>[(0,0), (width, height))</code> of
+ * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
*
* @see CameraCharacteristics#CONTROL_MAX_REGIONS_AE
@@ -631,13 +692,20 @@
new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.aeRegions", android.hardware.camera2.params.MeteringRectangle[].class);
/**
- * <p>Range over which fps can be adjusted to
- * maintain exposure.</p>
+ * <p>Range over which the auto-exposure routine can
+ * adjust the capture frame rate to maintain good
+ * exposure.</p>
* <p>Only constrains auto-exposure (AE) algorithm, not
- * manual control of {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}
- * This key is available on all devices.</p>
+ * manual control of {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime} and
+ * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}.</p>
+ * <p><b>Units</b>: Frames per second (FPS)</p>
+ * <p><b>Range of valid values:</b><br>
+ * Any of the entries in {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES android.control.aeAvailableTargetFpsRanges}</p>
+ * <p>This key is available on all devices.</p>
*
+ * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES
* @see CaptureRequest#SENSOR_EXPOSURE_TIME
+ * @see CaptureRequest#SENSOR_FRAME_DURATION
*/
@PublicKey
public static final Key<android.util.Range<Integer>> CONTROL_AE_TARGET_FPS_RANGE =
@@ -662,6 +730,15 @@
* depends on the current AE mode and state; see
* {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE precapture state transition
* details.</p>
+ * <p>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.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE IDLE}</li>
+ * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_START START}</li>
+ * </ul></p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Limited capability</b> -
* Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
@@ -858,6 +935,15 @@
* </tr>
* </tbody>
* </table>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_AE_STATE_INACTIVE INACTIVE}</li>
+ * <li>{@link #CONTROL_AE_STATE_SEARCHING SEARCHING}</li>
+ * <li>{@link #CONTROL_AE_STATE_CONVERGED CONVERGED}</li>
+ * <li>{@link #CONTROL_AE_STATE_LOCKED LOCKED}</li>
+ * <li>{@link #CONTROL_AE_STATE_FLASH_REQUIRED FLASH_REQUIRED}</li>
+ * <li>{@link #CONTROL_AE_STATE_PRECAPTURE PRECAPTURE}</li>
+ * </ul></p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Limited capability</b> -
* Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
@@ -887,9 +973,21 @@
* (i.e. <code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0</code>).</p>
* <p>If the lens is controlled by the camera device auto-focus algorithm,
* the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState}
- * in result metadata.
- * This key is available on all devices.</p>
+ * in result metadata.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_AF_MODE_OFF OFF}</li>
+ * <li>{@link #CONTROL_AF_MODE_AUTO AUTO}</li>
+ * <li>{@link #CONTROL_AF_MODE_MACRO MACRO}</li>
+ * <li>{@link #CONTROL_AF_MODE_CONTINUOUS_VIDEO CONTINUOUS_VIDEO}</li>
+ * <li>{@link #CONTROL_AF_MODE_CONTINUOUS_PICTURE CONTINUOUS_PICTURE}</li>
+ * <li>{@link #CONTROL_AF_MODE_EDOF EDOF}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES android.control.afAvailableModes}</p>
+ * <p>This key is available on all devices.</p>
*
+ * @see CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES
* @see CaptureResult#CONTROL_AF_STATE
* @see CaptureRequest#CONTROL_MODE
* @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
@@ -905,25 +1003,35 @@
new Key<Integer>("android.control.afMode", int.class);
/**
- * <p>List of areas to use for focus
- * estimation.</p>
- * <p>Optional. Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf} is 0.
+ * <p>List of metering areas to use for auto-focus.</p>
+ * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf} is 0.
* Otherwise will always be present.</p>
+ * <p>The maximum number of focus areas supported by the device is determined by the value
+ * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf}.</p>
* <p>The coordinate system is based on the active pixel array,
* with (0,0) being the top-left pixel in the active pixel array, and
* ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1,
* {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the
* bottom-right pixel in the active pixel array.</p>
- * <p>The weight must range from 0 to 1000, and represents a weight
+ * <p>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.</p>
- * <p>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 {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata,
- * the camera device will ignore the sections outside the region and output the
- * used sections in the result metadata.</p>
+ * <p>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.</p>
+ * <p>If all regions have 0 weight, then no specific metering area needs to be used by the
+ * camera device.</p>
+ * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} 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.</p>
+ * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
+ * <p><b>Range of valid values:</b><br>
+ * Coordinates must be between <code>[(0,0), (width, height))</code> of
+ * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
*
* @see CameraCharacteristics#CONTROL_MAX_REGIONS_AF
@@ -947,6 +1055,12 @@
* START for multiple captures in a row means restarting the AF operation over
* and over again.</p>
* <p>See {@link CaptureResult#CONTROL_AF_STATE android.control.afState} for what the trigger means for each AF mode.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_AF_TRIGGER_IDLE IDLE}</li>
+ * <li>{@link #CONTROL_AF_TRIGGER_START START}</li>
+ * <li>{@link #CONTROL_AF_TRIGGER_CANCEL CANCEL}</li>
+ * </ul></p>
* <p>This key is available on all devices.</p>
*
* @see CaptureResult#CONTROL_AF_STATE
@@ -1340,6 +1454,16 @@
* </tr>
* </tbody>
* </table>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_AF_STATE_INACTIVE INACTIVE}</li>
+ * <li>{@link #CONTROL_AF_STATE_PASSIVE_SCAN PASSIVE_SCAN}</li>
+ * <li>{@link #CONTROL_AF_STATE_PASSIVE_FOCUSED PASSIVE_FOCUSED}</li>
+ * <li>{@link #CONTROL_AF_STATE_ACTIVE_SCAN ACTIVE_SCAN}</li>
+ * <li>{@link #CONTROL_AF_STATE_FOCUSED_LOCKED FOCUSED_LOCKED}</li>
+ * <li>{@link #CONTROL_AF_STATE_NOT_FOCUSED_LOCKED NOT_FOCUSED_LOCKED}</li>
+ * <li>{@link #CONTROL_AF_STATE_PASSIVE_UNFOCUSED PASSIVE_UNFOCUSED}</li>
+ * </ul></p>
* <p>This key is available on all devices.</p>
*
* @see CaptureRequest#CONTROL_AF_MODE
@@ -1360,6 +1484,21 @@
/**
* <p>Whether auto-white balance (AWB) is currently locked to its
* latest calculated values.</p>
+ * <p>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).</p>
+ * <p>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:</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, set the request to manual AWB</li>
+ * <li>Submit the capture request, proceed to run manual AWB as desired.</li>
+ * </ol>
* <p>Note that AWB lock is only meaningful when
* {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is in the AUTO mode; in other modes,
* AWB is already fixed to a specific setting.</p>
@@ -1392,11 +1531,26 @@
* {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform},
* {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and
* {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} are ignored.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_AWB_MODE_OFF OFF}</li>
+ * <li>{@link #CONTROL_AWB_MODE_AUTO AUTO}</li>
+ * <li>{@link #CONTROL_AWB_MODE_INCANDESCENT INCANDESCENT}</li>
+ * <li>{@link #CONTROL_AWB_MODE_FLUORESCENT FLUORESCENT}</li>
+ * <li>{@link #CONTROL_AWB_MODE_WARM_FLUORESCENT WARM_FLUORESCENT}</li>
+ * <li>{@link #CONTROL_AWB_MODE_DAYLIGHT DAYLIGHT}</li>
+ * <li>{@link #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT CLOUDY_DAYLIGHT}</li>
+ * <li>{@link #CONTROL_AWB_MODE_TWILIGHT TWILIGHT}</li>
+ * <li>{@link #CONTROL_AWB_MODE_SHADE SHADE}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES android.control.awbAvailableModes}</p>
* <p>This key is available on all devices.</p>
*
* @see CaptureRequest#COLOR_CORRECTION_GAINS
* @see CaptureRequest#COLOR_CORRECTION_MODE
* @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
+ * @see CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES
* @see CaptureRequest#CONTROL_MODE
* @see #CONTROL_AWB_MODE_OFF
* @see #CONTROL_AWB_MODE_AUTO
@@ -1413,10 +1567,12 @@
new Key<Integer>("android.control.awbMode", int.class);
/**
- * <p>List of areas to use for illuminant
+ * <p>List of metering areas to use for auto-white-balance illuminant
* estimation.</p>
- * <p>Optional. Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb} is 0.
+ * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb} is 0.
* Otherwise will always be present.</p>
+ * <p>The maximum number of regions supported by the device is determined by the value
+ * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb}.</p>
* <p>The coordinate system is based on the active pixel array,
* with (0,0) being the top-left pixel in the active pixel array, and
* ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1,
@@ -1427,11 +1583,20 @@
* 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.</p>
- * <p>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 {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata,
- * the camera device will ignore the sections outside the region and output the
- * used sections in the result metadata.</p>
+ * <p>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.</p>
+ * <p>If all regions have 0 weight, then no specific metering area needs to be used by the
+ * camera device.</p>
+ * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} 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.</p>
+ * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
+ * <p><b>Range of valid values:</b><br>
+ * Coordinates must be between <code>[(0,0), (width, height))</code> of
+ * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
*
* @see CameraCharacteristics#CONTROL_MAX_REGIONS_AWB
@@ -1451,8 +1616,18 @@
* <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF</code> and any 3A routine is active.</p>
* <p>ZERO_SHUTTER_LAG will be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities}
* contains ZSL. MANUAL will be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities}
- * contains MANUAL_SENSOR.
- * This key is available on all devices.</p>
+ * contains MANUAL_SENSOR. Other intent values are always supported.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_CAPTURE_INTENT_CUSTOM CUSTOM}</li>
+ * <li>{@link #CONTROL_CAPTURE_INTENT_PREVIEW PREVIEW}</li>
+ * <li>{@link #CONTROL_CAPTURE_INTENT_STILL_CAPTURE STILL_CAPTURE}</li>
+ * <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_RECORD VIDEO_RECORD}</li>
+ * <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT VIDEO_SNAPSHOT}</li>
+ * <li>{@link #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG ZERO_SHUTTER_LAG}</li>
+ * <li>{@link #CONTROL_CAPTURE_INTENT_MANUAL MANUAL}</li>
+ * </ul></p>
+ * <p>This key is available on all devices.</p>
*
* @see CaptureRequest#CONTROL_MODE
* @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
@@ -1585,6 +1760,13 @@
* </tr>
* </tbody>
* </table>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_AWB_STATE_INACTIVE INACTIVE}</li>
+ * <li>{@link #CONTROL_AWB_STATE_SEARCHING SEARCHING}</li>
+ * <li>{@link #CONTROL_AWB_STATE_CONVERGED CONVERGED}</li>
+ * <li>{@link #CONTROL_AWB_STATE_LOCKED LOCKED}</li>
+ * </ul></p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Limited capability</b> -
* Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
@@ -1612,11 +1794,23 @@
* implementor of the camera device, and should not be
* depended on to be consistent (or present) across all
* devices.</p>
- * <p>A color effect will only be applied if
- * {@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_EFFECT_MODE_OFF OFF}</li>
+ * <li>{@link #CONTROL_EFFECT_MODE_MONO MONO}</li>
+ * <li>{@link #CONTROL_EFFECT_MODE_NEGATIVE NEGATIVE}</li>
+ * <li>{@link #CONTROL_EFFECT_MODE_SOLARIZE SOLARIZE}</li>
+ * <li>{@link #CONTROL_EFFECT_MODE_SEPIA SEPIA}</li>
+ * <li>{@link #CONTROL_EFFECT_MODE_POSTERIZE POSTERIZE}</li>
+ * <li>{@link #CONTROL_EFFECT_MODE_WHITEBOARD WHITEBOARD}</li>
+ * <li>{@link #CONTROL_EFFECT_MODE_BLACKBOARD BLACKBOARD}</li>
+ * <li>{@link #CONTROL_EFFECT_MODE_AQUA AQUA}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS android.control.availableEffects}</p>
* <p>This key is available on all devices.</p>
*
- * @see CaptureRequest#CONTROL_MODE
+ * @see CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS
* @see #CONTROL_EFFECT_MODE_OFF
* @see #CONTROL_EFFECT_MODE_MONO
* @see #CONTROL_EFFECT_MODE_NEGATIVE
@@ -1632,9 +1826,9 @@
new Key<Integer>("android.control.effectMode", int.class);
/**
- * <p>Overall mode of 3A control
+ * <p>Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control
* routines.</p>
- * <p>High-level 3A control. When set to OFF, all 3A control
+ * <p>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.</p>
* <p>When set to AUTO, the individual algorithm controls in
@@ -1651,7 +1845,15 @@
* the subsequent auto 3A capture results.</p>
* <p>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 capability.</p>
+ * support the MANUAL_SENSOR and MANUAL_POST_PROCSESING capabilities.
+ * FULL mode devices will always support OFF and OFF_KEEP_STATE.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_MODE_OFF OFF}</li>
+ * <li>{@link #CONTROL_MODE_AUTO AUTO}</li>
+ * <li>{@link #CONTROL_MODE_USE_SCENE_MODE USE_SCENE_MODE}</li>
+ * <li>{@link #CONTROL_MODE_OFF_KEEP_STATE OFF_KEEP_STATE}</li>
+ * </ul></p>
* <p>This key is available on all devices.</p>
*
* @see CaptureRequest#CONTROL_AF_MODE
@@ -1665,18 +1867,40 @@
new Key<Integer>("android.control.mode", int.class);
/**
- * <p>A camera mode optimized for conditions typical in a particular
- * capture setting.</p>
+ * <p>Control for which scene mode is currently active.</p>
+ * <p>Scene modes are custom camera modes optimized for a certain set of conditions and
+ * capture settings.</p>
* <p>This is the mode that that is active when
* <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY,
* these modes will disable {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode},
- * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} while in use.
- * The scene modes available for a given camera device are listed in
- * {@link CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES android.control.availableSceneModes}.</p>
+ * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} while in use.</p>
* <p>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.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_SCENE_MODE_DISABLED DISABLED}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_FACE_PRIORITY FACE_PRIORITY}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_ACTION ACTION}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_PORTRAIT PORTRAIT}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_LANDSCAPE LANDSCAPE}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_NIGHT NIGHT}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_NIGHT_PORTRAIT NIGHT_PORTRAIT}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_THEATRE THEATRE}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_BEACH BEACH}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_SNOW SNOW}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_SUNSET SUNSET}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_STEADYPHOTO STEADYPHOTO}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_FIREWORKS FIREWORKS}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_SPORTS SPORTS}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_PARTY PARTY}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_CANDLELIGHT CANDLELIGHT}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_BARCODE BARCODE}</li>
+ * <li>{@link #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO HIGH_SPEED_VIDEO}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES android.control.availableSceneModes}</p>
* <p>This key is available on all devices.</p>
*
* @see CaptureRequest#CONTROL_AE_MODE
@@ -1710,20 +1934,25 @@
/**
* <p>Whether video stabilization is
* active.</p>
- * <p>Video stabilization automatically translates and scales images from the camera
- * in order to stabilize motion between consecutive frames.</p>
+ * <p>Video stabilization automatically translates and scales images from
+ * the camera in order to stabilize motion between consecutive frames.</p>
* <p>If enabled, video stabilization can modify the
* {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to keep the video stream stabilized.</p>
- * <p>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.</p>
- * <p>If a camera device supports both this mode and OIS ({@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode}),
- * turning both modes on may produce undesirable interaction, so it is recommended not to
- * enable both at the same time.</p>
- * <p>Some LEGACY camera devices will not support changing video stabilization
- * mode; in this case the value will always override to OFF.</p>
+ * <p>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.</p>
+ * <p>If a camera device supports both this mode and OIS
+ * ({@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode}), turning both modes on may
+ * produce undesirable interaction, so it is recommended not to enable
+ * both at the same time.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_OFF OFF}</li>
+ * <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_ON ON}</li>
+ * </ul></p>
* <p>This key is available on all devices.</p>
*
* @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE
@@ -1738,14 +1967,21 @@
/**
* <p>Operation mode for edge
* enhancement.</p>
- * <p>Edge/sharpness/detail enhancement. OFF means no
- * enhancement will be applied by the camera device.</p>
- * <p>This must be set to one of the modes listed in {@link CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}.</p>
+ * <p>Edge enhancement improves sharpness and details in the captured image. OFF means
+ * no enhancement will be applied by the camera device.</p>
* <p>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.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #EDGE_MODE_OFF OFF}</li>
+ * <li>{@link #EDGE_MODE_FAST FAST}</li>
+ * <li>{@link #EDGE_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -1776,6 +2012,12 @@
* <p>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.</p>
* <p>The flash status will be reported by {@link CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #FLASH_MODE_OFF OFF}</li>
+ * <li>{@link #FLASH_MODE_SINGLE SINGLE}</li>
+ * <li>{@link #FLASH_MODE_TORCH TORCH}</li>
+ * </ul></p>
* <p>This key is available on all devices.</p>
*
* @see CaptureRequest#CONTROL_AE_MODE
@@ -1800,12 +2042,20 @@
* <ul>
* <li>Flash-less cameras always return UNAVAILABLE.</li>
* <li>Using {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>==</code> ON_ALWAYS_FLASH
- * will always return FIRED.</li>
+ * will always return FIRED.</li>
* <li>Using {@link CaptureRequest#FLASH_MODE android.flash.mode} <code>==</code> TORCH
- * will always return FIRED.</li>
+ * will always return FIRED.</li>
* </ul>
* <p>In all other conditions the state will not be available on
* LEGACY devices (i.e. it will be <code>null</code>).</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #FLASH_STATE_UNAVAILABLE UNAVAILABLE}</li>
+ * <li>{@link #FLASH_STATE_CHARGING CHARGING}</li>
+ * <li>{@link #FLASH_STATE_READY READY}</li>
+ * <li>{@link #FLASH_STATE_FIRED FIRED}</li>
+ * <li>{@link #FLASH_STATE_PARTIAL PARTIAL}</li>
+ * </ul></p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Limited capability</b> -
* Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
@@ -1826,12 +2076,18 @@
new Key<Integer>("android.flash.state", int.class);
/**
- * <p>Set operational mode for hot pixel correction.</p>
- * <p>Valid modes for this camera device are listed in
- * {@link CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}.</p>
+ * <p>Operational mode for hot pixel correction.</p>
* <p>Hotpixel correction interpolates out, or otherwise removes, pixels
- * that do not accurately encode the incoming light (i.e. pixels that
- * are stuck at an arbitrary value).</p>
+ * that do not accurately measure the incoming light (i.e. pixels that
+ * are stuck at an arbitrary value or are oversensitive).</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #HOT_PIXEL_MODE_OFF OFF}</li>
+ * <li>{@link #HOT_PIXEL_MODE_FAST FAST}</li>
+ * <li>{@link #HOT_PIXEL_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
*
* @see CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES
@@ -1845,6 +2101,9 @@
/**
* <p>A location object to use when generating image GPS metadata.</p>
+ * <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. These coordinates can then be
+ * viewed by anyone who receives the JPEG image.</p>
* <p>This key is available on all devices.</p>
*/
@PublicKey
@@ -1854,7 +2113,9 @@
/**
* <p>GPS coordinates to include in output JPEG
- * EXIF</p>
+ * EXIF.</p>
+ * <p><b>Range of valid values:</b><br>
+ * (-180 - 180], [-90,90], [-inf, inf]</p>
* <p>This key is available on all devices.</p>
* @hide
*/
@@ -1863,7 +2124,8 @@
/**
* <p>32 characters describing GPS algorithm to
- * include in EXIF</p>
+ * include in EXIF.</p>
+ * <p><b>Units</b>: UTF-8 null-terminated string</p>
* <p>This key is available on all devices.</p>
* @hide
*/
@@ -1872,7 +2134,8 @@
/**
* <p>Time GPS fix was made to include in
- * EXIF</p>
+ * EXIF.</p>
+ * <p><b>Units</b>: UTC in seconds since January 1, 1970</p>
* <p>This key is available on all devices.</p>
* @hide
*/
@@ -1880,9 +2143,40 @@
new Key<Long>("android.jpeg.gpsTimestamp", long.class);
/**
- * <p>Orientation of JPEG image to
- * write</p>
+ * <p>The orientation for a JPEG image.</p>
+ * <p>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.</p>
+ * <p>Camera devices may either encode this value into the JPEG EXIF header, or
+ * rotate the image data to match this orientation.</p>
+ * <p>Note that this orientation is relative to the orientation of the camera sensor, given
+ * by {@link CameraCharacteristics#SENSOR_ORIENTATION android.sensor.orientation}.</p>
+ * <p>To translate from the device orientation given by the Android sensor APIs, the following
+ * sample code may be used:</p>
+ * <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>
+ * <p><b>Units</b>: Degrees in multiples of 90</p>
+ * <p><b>Range of valid values:</b><br>
+ * 0, 90, 180, 270</p>
* <p>This key is available on all devices.</p>
+ *
+ * @see CameraCharacteristics#SENSOR_ORIENTATION
*/
@PublicKey
public static final Key<Integer> JPEG_ORIENTATION =
@@ -1892,6 +2186,8 @@
* <p>Compression quality of the final JPEG
* image.</p>
* <p>85-95 is typical usage range.</p>
+ * <p><b>Range of valid values:</b><br>
+ * 1-100; larger is higher quality</p>
* <p>This key is available on all devices.</p>
*/
@PublicKey
@@ -1901,6 +2197,8 @@
/**
* <p>Compression quality of JPEG
* thumbnail.</p>
+ * <p><b>Range of valid values:</b><br>
+ * 1-100; larger is higher quality</p>
* <p>This key is available on all devices.</p>
*/
@PublicKey
@@ -1911,26 +2209,29 @@
* <p>Resolution of embedded JPEG thumbnail.</p>
* <p>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail,
* but the captured JPEG will still be a valid image.</p>
- * <p>When a jpeg image capture is issued, the thumbnail size selected should have
- * the same aspect ratio as the jpeg image.</p>
+ * <p>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.</p>
* <p>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.</p>
+ * <p><b>Range of valid values:</b><br>
+ * {@link CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES android.jpeg.availableThumbnailSizes}</p>
* <p>This key is available on all devices.</p>
+ *
+ * @see CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES
*/
@PublicKey
public static final Key<android.util.Size> JPEG_THUMBNAIL_SIZE =
new Key<android.util.Size>("android.jpeg.thumbnailSize", android.util.Size.class);
/**
- * <p>The ratio of lens focal length to the effective
- * aperture diameter.</p>
- * <p>This will only be supported on the camera devices that
- * have variable aperture lens. The aperture value can only be
- * one of the values listed in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}.</p>
+ * <p>The desired lens aperture size, as a ratio of lens focal length to the
+ * effective aperture diameter.</p>
+ * <p>Setting this value is only supported on the camera devices that have a variable
+ * aperture lens.</p>
* <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF,
* this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime},
* {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}
@@ -1943,6 +2244,9 @@
* 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.</p>
+ * <p><b>Units</b>: The f-number (f/N)</p>
+ * <p><b>Range of valid values:</b><br>
+ * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -1961,10 +2265,8 @@
new Key<Float>("android.lens.aperture", float.class);
/**
- * <p>State of lens neutral density filter(s).</p>
- * <p>This will not be supported on most camera devices. On devices
- * where this is supported, this may only be set to one of the
- * values included in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}.</p>
+ * <p>The desired setting for the lens neutral density filter(s).</p>
+ * <p>This control will not be supported on most camera devices.</p>
* <p>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
@@ -1976,6 +2278,9 @@
* <p>It may take several frames before the lens filter density changes
* to the requested value. While the filter density is still changing,
* {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p>
+ * <p><b>Units</b>: Exposure Value (EV)</p>
+ * <p><b>Range of valid values:</b><br>
+ * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -1990,7 +2295,7 @@
new Key<Float>("android.lens.filterDensity", float.class);
/**
- * <p>The current lens focal length; used for optical zoom.</p>
+ * <p>The desired lens focal length; used for optical zoom.</p>
* <p>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.</p>
@@ -1999,11 +2304,15 @@
* frames before the lens can change to the requested focal length.
* While the focal length is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will
* be set to MOVING.</p>
- * <p>This is expected not to be supported on most devices.</p>
+ * <p>Optical zoom will not be supported on most devices.</p>
+ * <p><b>Units</b>: Millimeters</p>
+ * <p><b>Range of valid values:</b><br>
+ * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS android.lens.info.availableFocalLengths}</p>
* <p>This key is available on all devices.</p>
*
* @see CaptureRequest#LENS_APERTURE
* @see CaptureRequest#LENS_FOCUS_DISTANCE
+ * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS
* @see CaptureResult#LENS_STATE
*/
@PublicKey
@@ -2011,15 +2320,19 @@
new Key<Float>("android.lens.focalLength", float.class);
/**
- * <p>Distance to plane of sharpest focus,
+ * <p>Desired distance to plane of sharpest focus,
* measured from frontmost surface of the lens.</p>
* <p>Should be zero for fixed-focus cameras</p>
+ * <p><b>Units</b>: See {@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} for details</p>
+ * <p><b>Range of valid values:</b><br>
+ * >= 0</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
* {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
*
* @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
+ * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION
*/
@PublicKey
public static final Key<Float> LENS_FOCUS_DISTANCE =
@@ -2030,12 +2343,17 @@
* sharp focus (depth of field).</p>
* <p>If variable focus not supported, can still report
* fixed depth of field range</p>
+ * <p><b>Units</b>: A pair of focus distances in diopters: (near,
+ * far); see {@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} for details.</p>
+ * <p><b>Range of valid values:</b><br>
+ * >=0</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Limited capability</b> -
* Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
* {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
*
* @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
+ * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION
*/
@PublicKey
public static final Key<android.util.Pair<Float,Float>> LENS_FOCUS_RANGE =
@@ -2055,12 +2373,19 @@
* 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.</p>
- * <p>If a camera device supports both OIS and EIS ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}),
- * turning both modes on may produce undesirable interaction, so it is recommended not
- * to enable both at the same time.</p>
+ * <p>If a camera device supports both OIS and digital image stabilization
+ * ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), turning both modes on may produce undesirable
+ * interaction, so it is recommended not to enable both at the same time.</p>
* <p>Not all devices will support OIS; see
* {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization} for
* available controls.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_OFF OFF}</li>
+ * <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_ON ON}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Limited capability</b> -
* Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
@@ -2097,6 +2422,11 @@
* <p>Then this state will always be STATIONARY.</p>
* <p>When the state is MOVING, it indicates that at least one of the lens parameters
* is changing.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #LENS_STATE_STATIONARY STATIONARY}</li>
+ * <li>{@link #LENS_STATE_MOVING MOVING}</li>
+ * </ul></p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Limited capability</b> -
* Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
@@ -2120,15 +2450,22 @@
/**
* <p>Mode of operation for the noise reduction algorithm.</p>
- * <p>Noise filtering control. OFF means no noise reduction
- * will be applied by the camera device.</p>
- * <p>This must be set to a valid mode from
- * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}.</p>
+ * <p>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.</p>
* <p>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.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #NOISE_REDUCTION_MODE_OFF OFF}</li>
+ * <li>{@link #NOISE_REDUCTION_MODE_FAST FAST}</li>
+ * <li>{@link #NOISE_REDUCTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -2158,6 +2495,8 @@
* 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.</p>
+ * <p><b>Range of valid values:</b><br>
+ * Optional. Default value is FINAL.</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* @deprecated
* @hide
@@ -2171,6 +2510,9 @@
* increases with every new result (that is, each new result has a unique
* frameCount value).</p>
* <p>Reset on release()</p>
+ * <p><b>Units</b>: count of frames</p>
+ * <p><b>Range of valid values:</b><br>
+ * > 0</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* @deprecated
* @hide
@@ -2183,6 +2525,9 @@
* <p>An application-specified ID for the current
* request. Must be maintained unchanged in output
* frame</p>
+ * <p><b>Units</b>: arbitrary integer assigned by application</p>
+ * <p><b>Range of valid values:</b><br>
+ * Any int</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* @hide
*/
@@ -2197,6 +2542,8 @@
* what streams are configured, the data may undergo less processing,
* and some pipeline stages skipped.</p>
* <p>See {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth} for more details.</p>
+ * <p><b>Range of valid values:</b><br>
+ * <= {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth}</p>
* <p>This key is available on all devices.</p>
*
* @see CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH
@@ -2206,7 +2553,8 @@
new Key<Byte>("android.request.pipelineDepth", byte.class);
/**
- * <p>The region of the sensor to read out for this capture.</p>
+ * <p>The desired region of the sensor to read out for this capture.</p>
+ * <p>This control can be used to implement digital zoom.</p>
* <p>The crop region coordinate system is based off
* {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with <code>(0, 0)</code> being the
* top-left corner of the sensor active array.</p>
@@ -2236,6 +2584,8 @@
* for rounding and other hardware requirements; the final
* crop region used will be included in the output capture
* result.</p>
+ * <p><b>Units</b>: Pixel coordinates relative to
+ * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
* <p>This key is available on all devices.</p>
*
* @see CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM
@@ -2248,14 +2598,23 @@
/**
* <p>Duration each pixel is exposed to
* light.</p>
- * <p>If the sensor can't expose this exact duration, it should shorten the
- * duration exposed to the nearest possible value (rather than expose longer).</p>
+ * <p>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.</p>
+ * <p>This control is only effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} is set to
+ * OFF; otherwise the auto-exposure algorithm will override this value.</p>
+ * <p><b>Units</b>: Nanoseconds</p>
+ * <p><b>Range of valid values:</b><br>
+ * {@link CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE android.sensor.info.exposureTimeRange}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
* {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
*
+ * @see CaptureRequest#CONTROL_AE_MODE
+ * @see CaptureRequest#CONTROL_MODE
* @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
+ * @see CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE
*/
@PublicKey
public static final Key<Long> SENSOR_EXPOSURE_TIME =
@@ -2333,13 +2692,23 @@
* delivered.</p>
* <p>For more details about stalling, see
* StreamConfigurationMap#getOutputStallDuration(int,Size).</p>
+ * <p>This control is only effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} is set to
+ * OFF; otherwise the auto-exposure algorithm will override this value.</p>
+ * <p><b>Units</b>: Nanoseconds</p>
+ * <p><b>Range of valid values:</b><br>
+ * See {@link CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION android.sensor.info.maxFrameDuration},
+ * {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}. The duration
+ * is capped to <code>max(duration, exposureTime + overhead)</code>.</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
* {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
*
+ * @see CaptureRequest#CONTROL_AE_MODE
+ * @see CaptureRequest#CONTROL_MODE
* @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
* @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
+ * @see CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION
*/
@PublicKey
public static final Key<Long> SENSOR_FRAME_DURATION =
@@ -2357,6 +2726,9 @@
* requested, it will reduce the gain to the nearest supported
* value. The final sensitivity used will be available in the
* output capture result.</p>
+ * <p><b>Units</b>: ISO arithmetic units</p>
+ * <p><b>Range of valid values:</b><br>
+ * {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -2386,6 +2758,9 @@
* android.os.SystemClock#elapsedRealtimeNanos(), and they can be
* compared to other timestamps from other subsystems that are using
* that base.</p>
+ * <p><b>Units</b>: Nanoseconds</p>
+ * <p><b>Range of valid values:</b><br>
+ * > 0</p>
* <p>This key is available on all devices.</p>
*
* @see CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE
@@ -2411,10 +2786,10 @@
/**
* <p>Noise model coefficients for each CFA mosaic channel.</p>
- * <p>This tag contains two noise model coefficients for each CFA channel
+ * <p>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 tag
+ * in the same order as channels listed for the CFA layout key
* (see {@link CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT android.sensor.info.colorFilterArrangement}). 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
@@ -2468,6 +2843,8 @@
* <li>R > 1.20 will require strong software correction to produce
* a usuable image (>20% divergence).</li>
* </ul>
+ * <p><b>Range of valid values:</b><br></p>
+ * <p>>= 0</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
*/
@PublicKey
@@ -2500,7 +2877,21 @@
* <p>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).</p>
+ * <p>Defaults to OFF.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #SENSOR_TEST_PATTERN_MODE_OFF OFF}</li>
+ * <li>{@link #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR SOLID_COLOR}</li>
+ * <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS COLOR_BARS}</li>
+ * <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY COLOR_BARS_FADE_TO_GRAY}</li>
+ * <li>{@link #SENSOR_TEST_PATTERN_MODE_PN9 PN9}</li>
+ * <li>{@link #SENSOR_TEST_PATTERN_MODE_CUSTOM1 CUSTOM1}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES android.sensor.availableTestPatternModes}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
+ *
+ * @see CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES
* @see #SENSOR_TEST_PATTERN_MODE_OFF
* @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR
* @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS
@@ -2515,11 +2906,16 @@
/**
* <p>Duration between the start of first row exposure
* and the start of last row exposure.</p>
- * <p>This is the exposure time skew (in the unit of nanosecond) 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 {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.</p>
+ * <p>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
+ * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.</p>
* <p>For typical camera sensors that use rolling shutters, this is also equivalent
* to the frame readout time.</p>
+ * <p><b>Units</b>: Nanoseconds</p>
+ * <p><b>Range of valid values:</b><br>
+ * >= 0 and <
+ * StreamConfigurationMap#getOutputMinFrameDuration(int, Size).</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Limited capability</b> -
* Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
@@ -2538,27 +2934,32 @@
* <p>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>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON</code>. For example, for lens
- * shading map with size specified as <code>android.lens.info.shadingMapSize = [ 4, 3 ]</code>,
- * the output android.statistics.lensShadingMap for this case will be an identity map
- * shown below:</p>
+ * shading map with size of <code>[ 4, 3 ]</code>,
+ * the output {@link CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap} for this case will be an identity
+ * map shown below:</p>
* <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 ]
+ * 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>
- * <p>When set to other modes, lens shading correction will be applied by the
- * camera device. Applications can request lens shading map data by setting
- * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide
- * lens shading map data in android.statistics.lensShadingMap, with size specified
- * by android.lens.info.shadingMapSize; the returned shading map data will be the one
- * applied by the camera device for this capture request.</p>
- * <p>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({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF and {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} <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.</p>
+ * <p>When set to other modes, lens shading correction will be applied by the camera
+ * device. Applications can request lens shading map data by setting
+ * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide lens
+ * shading map data in {@link CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap}; the returned shading map
+ * data will be the one applied by the camera device for this capture request.</p>
+ * <p>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({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF and {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} <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.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #SHADING_MODE_OFF OFF}</li>
+ * <li>{@link #SHADING_MODE_FAST FAST}</li>
+ * <li>{@link #SHADING_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
+ * </ul></p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -2567,6 +2968,7 @@
* @see CaptureRequest#CONTROL_AE_MODE
* @see CaptureRequest#CONTROL_AWB_MODE
* @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
+ * @see CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP
* @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
* @see #SHADING_MODE_OFF
* @see #SHADING_MODE_FAST
@@ -2577,13 +2979,20 @@
new Key<Integer>("android.shading.mode", int.class);
/**
- * <p>Control for the face detector
+ * <p>Operating mode for the face detector
* unit.</p>
* <p>Whether face detection is enabled, and whether it
* should output just the basic fields or the full set of
- * fields. Value must be one of the
- * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}.
- * This key is available on all devices.</p>
+ * fields.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #STATISTICS_FACE_DETECT_MODE_OFF OFF}</li>
+ * <li>{@link #STATISTICS_FACE_DETECT_MODE_SIMPLE SIMPLE}</li>
+ * <li>{@link #STATISTICS_FACE_DETECT_MODE_FULL FULL}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}</p>
+ * <p>This key is available on all devices.</p>
*
* @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES
* @see #STATISTICS_FACE_DETECT_MODE_OFF
@@ -2642,6 +3051,8 @@
* <p>List of the face confidence scores for
* detected faces</p>
* <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} != OFF.</p>
+ * <p><b>Range of valid values:</b><br>
+ * 1-100</p>
* <p>This key is available on all devices.</p>
*
* @see CaptureRequest#STATISTICS_FACE_DETECT_MODE
@@ -2652,7 +3063,7 @@
/**
* <p>List of the faces detected through camera face detection
- * in this result.</p>
+ * in this capture.</p>
* <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} <code>!=</code> OFF.</p>
* <p>This key is available on all devices.</p>
*
@@ -2688,11 +3099,11 @@
* <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 ]
+ * 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>
* <p>The low-resolution scaling map images for each channel are
* (displayed using nearest-neighbor interpolation):</p>
@@ -2703,6 +3114,8 @@
* <p>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:</p>
* <p><img alt="Image of a uniform white wall (inverse shading map)" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png" /></p>
+ * <p><b>Range of valid values:</b><br>
+ * Each gain factor is >= 1</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -2741,11 +3154,11 @@
* <pre><code>android.lens.info.shadingMapSize = [ 4, 3 ]
* android.statistics.lensShadingMap =
* [ 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 ]
+ * 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>
* <p>The low-resolution scaling map images for each channel are
* (displayed using nearest-neighbor interpolation):</p>
@@ -2756,6 +3169,8 @@
* <p>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:</p>
* <p><img alt="Image of a uniform white wall (inverse shading map)" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png" /></p>
+ * <p><b>Range of valid values:</b><br>
+ * Each gain factor is >= 1</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -2829,6 +3244,12 @@
* into this metadata field. See
* {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode} for more details.</p>
* <p>Reports NONE if there doesn't appear to be flickering illumination.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #STATISTICS_SCENE_FLICKER_NONE NONE}</li>
+ * <li>{@link #STATISTICS_SCENE_FLICKER_50HZ 50HZ}</li>
+ * <li>{@link #STATISTICS_SCENE_FLICKER_60HZ 60HZ}</li>
+ * </ul></p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -2847,10 +3268,11 @@
new Key<Integer>("android.statistics.sceneFlicker", int.class);
/**
- * <p>Operating mode for hotpixel map generation.</p>
- * <p>If set to ON, a hotpixel map is returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.
- * If set to OFF, no hotpixel map will be returned.</p>
- * <p>This must be set to a valid mode from {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}.</p>
+ * <p>Operating mode for hot pixel map generation.</p>
+ * <p>If set to <code>true</code>, a hot pixel map is returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.
+ * If set to <code>false</code>, no hot pixel map will be returned.</p>
+ * <p><b>Range of valid values:</b><br>
+ * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
*
* @see CaptureResult#STATISTICS_HOT_PIXEL_MAP
@@ -2868,6 +3290,10 @@
* height dimensions are given in {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize}.
* This may include hot pixels that lie outside of the active array
* bounds given by {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.</p>
+ * <p><b>Range of valid values:</b><br></p>
+ * <p>n <= number of pixels on the sensor.
+ * The <code>(x, y)</code> coordinates must be bounded by
+ * {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize}.</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
*
* @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
@@ -2883,7 +3309,12 @@
* <p>When set to ON,
* android.statistics.lensShadingMap will be provided in
* the output result metadata.</p>
- * <p>Required for devices with the RAW capability.</p>
+ * <p>ON is always supported on devices with the RAW capability.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_OFF OFF}</li>
+ * <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_ON ON}</li>
+ * </ul></p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -2937,10 +3368,10 @@
* CONTRAST_CURVE.</p>
* <p>Each channel's curve is defined by an array of control points:</p>
* <pre><code>android.tonemap.curveRed =
- * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ]
+ * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ]
* 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre>
- * <p>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
+ * <p>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.</p>
@@ -2961,20 +3392,23 @@
* <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p>
* <p>Gamma 1/2.2 mapping, with 16 control points:</p>
* <pre><code>android.tonemap.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 ]
+ * 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>
* <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, per IEC 61966-2-1:1999, with 16 control points:</p>
* <pre><code>android.tonemap.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 ]
+ * 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>
* <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p>
+ * <p><b>Range of valid values:</b><br>
+ * 0-1 on both input and output coordinates, normalized
+ * as a floating-point value such that 0 == black and 1 == white.</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -2996,7 +3430,7 @@
* example. The same logic applies to green and blue channel.
* Each channel's curve is defined by an array of control points:</p>
* <pre><code>curveRed =
- * [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ]
+ * [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ]
* 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre>
* <p>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
@@ -3020,18 +3454,18 @@
* <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p>
* <p>Gamma 1/2.2 mapping, with 16 control points:</p>
* <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) ]
+ * (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>
* <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, per IEC 61966-2-1:1999, with 16 control points:</p>
* <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) ]
+ * (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>
* <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
@@ -3061,8 +3495,6 @@
* tables, selective chroma enhancement, or other non-linear color
* transforms will be disabled when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is
* CONTRAST_CURVE.</p>
- * <p>This must be set to a valid mode in
- * {@link CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}.</p>
* <p>When using either FAST or HIGH_QUALITY, the camera device will
* emit its own tonemap curve in {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}.
* These values are always available, and as close as possible to the
@@ -3070,6 +3502,14 @@
* <p>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.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #TONEMAP_MODE_CONTRAST_CURVE CONTRAST_CURVE}</li>
+ * <li>{@link #TONEMAP_MODE_FAST FAST}</li>
+ * <li>{@link #TONEMAP_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * {@link CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
@@ -3175,6 +3615,14 @@
* <p>In other words, results for this current request and up to
* {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth} prior requests may have their
* android.sync.frameNumber change to CONVERGING.</p>
+ * <p><b>Possible values:</b>
+ * <ul>
+ * <li>{@link #SYNC_FRAME_NUMBER_CONVERGING CONVERGING}</li>
+ * <li>{@link #SYNC_FRAME_NUMBER_UNKNOWN UNKNOWN}</li>
+ * </ul></p>
+ * <p><b>Available values for this device:</b><br>
+ * Either a non-negative value corresponding to a
+ * <code>frame_number</code>, or one of the two enums (CONVERGING / UNKNOWN).</p>
* <p>This key is available on all devices.</p>
*
* @see CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH