Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#nestedclasses) \| [Inherited Constants](https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#inhconstants) \| [Fields](https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#lfields) \| [Methods](https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#pubmethods) \| [Protected Methods](https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#promethods) \| [Inherited Methods](https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#inhmethods)

# CaptureRequest

*** ** * ** ***


`
public

final

class
CaptureRequest
`


`


`

`

extends https://developer.android.com/reference/android/hardware/camera2/CameraMetadata<https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<?>>


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [android.hardware.camera2.CameraMetadata](https://developer.android.com/reference/android/hardware/camera2/CameraMetadata)\<[android.hardware.camera2.CaptureRequest.Key](https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key)\<?\>\> ||
|   | ↳ | android.hardware.camera2.CaptureRequest |

<br />

*** ** * ** ***

<br />

An immutable package of settings and outputs needed to capture a single
image from the camera device.

Contains the configuration for the capture hardware (sensor, lens, flash),
the processing pipeline, the control algorithms, and the output buffers. Also
contains the list of target Surfaces to send image data to for this
capture.

CaptureRequests can be created by using a `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Builder` instance,
obtained by calling `https://developer.android.com/reference/android/hardware/camera2/CameraDevice#createCaptureRequest(int)` or `https://developer.android.com/reference/android/hardware/camera2/CameraDevice.CameraDeviceSetup#createCaptureRequest(int)`

CaptureRequests are given to `https://developer.android.com/reference/android/hardware/camera2/CameraCaptureSession#capture(android.hardware.camera2.CaptureRequest,%20android.hardware.camera2.CameraCaptureSession.CaptureCallback,%20android.os.Handler)` or
`https://developer.android.com/reference/android/hardware/camera2/CameraCaptureSession#setRepeatingRequest(android.hardware.camera2.CaptureRequest,%20android.hardware.camera2.CameraCaptureSession.CaptureCallback,%20android.os.Handler)` to capture images from a camera.

Each request can specify a different subset of target Surfaces for the
camera to send the captured data to. All the surfaces used in a request must
be part of the surface list given to the last call to
`https://developer.android.com/reference/android/hardware/camera2/CameraDevice#createCaptureSession(android.hardware.camera2.params.SessionConfiguration)`, when the request is submitted to the
session.

For example, a request meant for repeating preview might only include the
Surface for the preview SurfaceView or SurfaceTexture, while a
high-resolution still capture would also include a Surface from a ImageReader
configured for high-resolution JPEG images.

A reprocess capture request allows a previously-captured image from the camera device to be
sent back to the device for further processing. It can be created with
`https://developer.android.com/reference/android/hardware/camera2/CameraDevice#createReprocessCaptureRequest(android.hardware.camera2.TotalCaptureResult)`, and used with a reprocessable capture session
created with `https://developer.android.com/reference/android/hardware/camera2/CameraDevice#createReprocessableCaptureSession(android.hardware.camera2.params.InputConfiguration,%20java.util.List<android.view.Surface>,%20android.hardware.camera2.CameraCaptureSession.StateCallback,%20android.os.Handler)`.

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCaptureSession#capture(android.hardware.camera2.CaptureRequest,%20android.hardware.camera2.CameraCaptureSession.CaptureCallback,%20android.os.Handler)`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCaptureSession#setRepeatingRequest(android.hardware.camera2.CaptureRequest,%20android.hardware.camera2.CameraCaptureSession.CaptureCallback,%20android.os.Handler)`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCaptureSession#captureBurst(java.util.List<android.hardware.camera2.CaptureRequest>,%20android.hardware.camera2.CameraCaptureSession.CaptureCallback,%20android.os.Handler)`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCaptureSession#setRepeatingBurst(java.util.List<android.hardware.camera2.CaptureRequest>,%20android.hardware.camera2.CameraCaptureSession.CaptureCallback,%20android.os.Handler)`
- `https://developer.android.com/reference/android/hardware/camera2/CameraDevice#createCaptureRequest(int)`
- `https://developer.android.com/reference/android/hardware/camera2/CameraDevice#createReprocessCaptureRequest(android.hardware.camera2.TotalCaptureResult)`
- `https://developer.android.com/reference/android/hardware/camera2/CameraDevice.CameraDeviceSetup#createCaptureRequest(int)`

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Builder` A builder for capture requests. |
| ` class` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<T>` A `Key` is used to do capture request field lookups with `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#get(android.hardware.camera2.CaptureRequest.Key<T>)` or to set fields with `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Builder#set(android.hardware.camera2.CaptureRequest.Key<T>,%20T)`. |

| ### Inherited constants |
|---|
| From class `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata` |---|---| | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_EXTERIOR_FRONT` <br /> The camera device faces the front of the vehicle body frame. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_EXTERIOR_LEFT` <br /> The camera device faces the left side of the vehicle body frame. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_EXTERIOR_OTHER` <br /> The camera device faces the outside of the vehicle body frame but not exactly one of the exterior sides defined by this enum. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_EXTERIOR_REAR` <br /> The camera device faces the rear of the vehicle body frame. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_EXTERIOR_RIGHT` <br /> The camera device faces the right side of the vehicle body frame. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_INTERIOR_OTHER` <br /> The camera device faces the inside of the vehicle body frame but not exactly one of seats described by this enum. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_CENTER` <br /> The camera device faces the center seat of the first row. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_LEFT` <br /> The camera device faces the left side seat of the first row. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_RIGHT` <br /> The camera device faces the right seat of the first row. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_CENTER` <br /> The camera device faces the center seat of the second row. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_LEFT` <br /> The camera device faces the left side seat of the second row. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_RIGHT` <br /> The camera device faces the right side seat of the second row. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_CENTER` <br /> The camera device faces the center seat of the third row. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_LEFT` <br /> The camera device faces the left side seat of the third row. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_RIGHT` <br /> The camera device faces the right seat of the third row. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LOCATION_EXTERIOR_FRONT` <br /> The camera device exists outside of the vehicle body frame and on its front side. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LOCATION_EXTERIOR_LEFT` <br /> The camera device exists outside and on left side of the vehicle body frame. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LOCATION_EXTERIOR_OTHER` <br /> The camera exists outside of the vehicle body frame but not exactly on one of the exterior locations this enum defines. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LOCATION_EXTERIOR_REAR` <br /> The camera device exists outside of the vehicle body frame and on its rear side. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LOCATION_EXTERIOR_RIGHT` <br /> The camera device exists outside and on right side of the vehicle body frame. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LOCATION_EXTRA_FRONT` <br /> The camera device exists outside of the extra vehicle's body frame and on its front side. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LOCATION_EXTRA_LEFT` <br /> The camera device exists outside and on left side of the extra vehicle body. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LOCATION_EXTRA_OTHER` <br /> The camera device exists on an extra vehicle, such as the trailer, but not exactly on one of front, rear, left, or right side. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LOCATION_EXTRA_REAR` <br /> The camera device exists outside of the extra vehicle's body frame and on its rear side. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LOCATION_EXTRA_RIGHT` <br /> The camera device exists outside and on right side of the extra vehicle body. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#AUTOMOTIVE_LOCATION_INTERIOR` <br /> The camera device exists inside of the vehicle cabin. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_ABERRATION_MODE_FAST` <br /> Aberration correction will not slow down capture rate relative to sensor raw output. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY` <br /> Aberration correction operates at improved quality but the capture rate might be reduced (relative to sensor raw output rate) <br /> | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_ABERRATION_MODE_OFF` <br /> No aberration correction is applied. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_MODE_CCT` <br /> Use `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_COLOR_TEMPERATURE` and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_COLOR_TINT` to adjust the white balance based on correlated color temperature. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_MODE_FAST` <br /> Color correction processing must not slow down capture rate relative to sensor raw output. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_MODE_HIGH_QUALITY` <br /> Color correction processing operates at improved quality but the capture rate might be reduced (relative to sensor raw output rate) Advanced white balance adjustments above and beyond the specified white balance pipeline may be applied. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_MODE_TRANSFORM_MATRIX` <br /> Use the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_TRANSFORM` matrix and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_GAINS` to do color conversion. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_ANTIBANDING_MODE_50HZ` <br /> The camera device will adjust exposure duration to avoid banding problems with 50Hz illumination sources. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_ANTIBANDING_MODE_60HZ` <br /> The camera device will adjust exposure duration to avoid banding problems with 60Hz illumination sources. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_ANTIBANDING_MODE_AUTO` <br /> The camera device will automatically adapt its antibanding routine to the current illumination condition. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_ANTIBANDING_MODE_OFF` <br /> The camera device will not adjust exposure duration to avoid banding problems. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_OFF` <br /> The camera device's autoexposure routine is disabled. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON` <br /> The camera device's autoexposure routine is active, with no flash control. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_ALWAYS_FLASH` <br /> Like ON, except that the camera device also controls the camera's flash unit, always firing it for still captures. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_AUTO_FLASH` <br /> Like ON, except that the camera device also controls the camera's flash unit, firing it in low-light conditions. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE` <br /> Like ON_AUTO_FLASH, but with automatic red eye reduction. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_EXTERNAL_FLASH` <br /> An external flash has been turned on. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY` <br /> Like 'ON' but applies additional brightness boost in low light scenes. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL` <br /> The camera device will cancel any currently active or completed precapture metering sequence, the auto-exposure routine will return to its initial state. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRECAPTURE_TRIGGER_IDLE` <br /> The trigger is idle. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRECAPTURE_TRIGGER_START` <br /> The precapture metering sequence will be started by the camera device. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRIORITY_MODE_OFF` <br /> Disable AE priority mode. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRIORITY_MODE_SENSOR_EXPOSURE_TIME_PRIORITY` <br /> The camera device's auto-exposure routine is active and prioritizes the application-selected exposure time (`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME`). | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRIORITY_MODE_SENSOR_SENSITIVITY_PRIORITY` <br /> The camera device's auto-exposure routine is active and prioritizes the application-selected ISO (`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`). | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_STATE_CONVERGED` <br /> AE has a good set of control values for the current scene. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_STATE_FLASH_REQUIRED` <br /> AE has a good set of control values, but flash needs to be fired for good quality still capture. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_STATE_INACTIVE` <br /> AE is off or recently reset. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_STATE_LOCKED` <br /> AE has been locked. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_STATE_PRECAPTURE` <br /> AE has been asked to do a precapture sequence and is currently executing it. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_STATE_SEARCHING` <br /> AE doesn't yet have a good set of control values for the current scene. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_AUTO` <br /> Basic automatic focus mode. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_CONTINUOUS_PICTURE` <br /> In this mode, the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_CONTINUOUS_VIDEO` <br /> In this mode, the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_EDOF` <br /> Extended depth of field (digital focus) mode. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_MACRO` <br /> Close-up focusing mode. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_OFF` <br /> The auto-focus routine does not control the lens; `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FOCUS_DISTANCE` is controlled by the application. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_SCENE_CHANGE_DETECTED` <br /> Scene change is detected within the AF region(s). | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_SCENE_CHANGE_NOT_DETECTED` <br /> Scene change is not detected within the AF region(s). | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_STATE_ACTIVE_SCAN` <br /> AF is performing an AF scan because it was triggered by AF trigger. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_STATE_FOCUSED_LOCKED` <br /> AF believes it is focused correctly and has locked focus. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_STATE_INACTIVE` <br /> AF is off or has not yet tried to scan/been asked to scan. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_STATE_NOT_FOCUSED_LOCKED` <br /> AF has failed to focus successfully and has locked focus. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_STATE_PASSIVE_FOCUSED` <br /> AF currently believes it is in focus, but may restart scanning at any time. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_STATE_PASSIVE_SCAN` <br /> AF is currently performing an AF scan initiated the camera device in a continuous autofocus mode. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_STATE_PASSIVE_UNFOCUSED` <br /> AF finished a passive scan without finding focus, and may restart scanning at any time. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_TRIGGER_CANCEL` <br /> Autofocus will return to its initial state, and cancel any currently active trigger. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_TRIGGER_IDLE` <br /> The trigger is idle. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_TRIGGER_START` <br /> Autofocus will trigger now. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AUTOFRAMING_OFF` <br /> Disable autoframing. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AUTOFRAMING_ON` <br /> Enable autoframing to keep people in the frame's field of view. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AUTOFRAMING_STATE_CONVERGED` <br /> Auto-framing has reached a stable state (frame/fov is not being adjusted). | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AUTOFRAMING_STATE_FRAMING` <br /> Auto-framing is in process - either zooming in, zooming out or pan is taking place. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AUTOFRAMING_STATE_INACTIVE` <br /> Auto-framing is inactive. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_AUTO` <br /> The camera device's auto-white balance routine is active. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_CLOUDY_DAYLIGHT` <br /> 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. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_DAYLIGHT` <br /> The camera device's auto-white balance routine is disabled; the camera device uses daylight light as the assumed scene illumination for white balance. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_FLUORESCENT` <br /> The camera device's auto-white balance routine is disabled; the camera device uses fluorescent light as the assumed scene illumination for white balance. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_INCANDESCENT` <br /> The camera device's auto-white balance routine is disabled; the camera device uses incandescent light as the assumed scene illumination for white balance. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_OFF` <br /> The camera device's auto-white balance routine is disabled. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_SHADE` <br /> The camera device's auto-white balance routine is disabled; the camera device uses shade light as the assumed scene illumination for white balance. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_TWILIGHT` <br /> The camera device's auto-white balance routine is disabled; the camera device uses twilight light as the assumed scene illumination for white balance. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_WARM_FLUORESCENT` <br /> 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. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_STATE_CONVERGED` <br /> AWB has a good set of control values for the current scene. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_STATE_INACTIVE` <br /> AWB is not in auto mode, or has not yet started metering. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_STATE_LOCKED` <br /> AWB has been locked. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_STATE_SEARCHING` <br /> AWB doesn't yet have a good set of control values for the current scene. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_CUSTOM` <br /> The goal of this request doesn't fall into the other categories. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_MANUAL` <br /> This request is for manual capture use case where the applications want to directly control the capture parameters. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_MOTION_TRACKING` <br /> This request is for a motion tracking use case, where the application will use camera and inertial sensor data to locate and track objects in the world. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_PREVIEW` <br /> This request is for a preview-like use case. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_STILL_CAPTURE` <br /> This request is for a still capture-type use case. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_VIDEO_RECORD` <br /> This request is for a video recording use case. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT` <br /> This request is for a video snapshot (still image while recording video) use case. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG` <br /> This request is for a ZSL usecase; the application will stream full-resolution images and reprocess one or several later for a final capture. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_AQUA` <br /> An "aqua" effect where a blue hue is added to the image. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_BLACKBOARD` <br /> A "blackboard" effect where the image is typically displayed as regions of black, with white or grey details. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_MONO` <br /> A "monocolor" effect where the image is mapped into a single color. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_NEGATIVE` <br /> A "photo-negative" effect where the image's colors are inverted. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_OFF` <br /> No color effect will be applied. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_POSTERIZE` <br /> A "posterization" effect where the image uses discrete regions of tone rather than a continuous gradient of tones. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_SEPIA` <br /> A "sepia" effect where the image is mapped into warm gray, red, and brown tones. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_SOLARIZE` <br /> A "solarisation" effect (Sabattier effect) where the image is wholly or partially reversed in tone. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_WHITEBOARD` <br /> A "whiteboard" effect where the image is typically displayed as regions of white, with black or grey details. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EXTENDED_SCENE_MODE_BOKEH_CONTINUOUS` <br /> Bokeh effect must not slow down capture rate relative to sensor raw output, and the effect is applied to all processed streams no larger than the maximum streaming dimension. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EXTENDED_SCENE_MODE_BOKEH_STILL_CAPTURE` <br /> High quality bokeh mode is enabled for all non-raw streams (including YUV, JPEG, and IMPLEMENTATION_DEFINED) when capture intent is STILL_CAPTURE. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EXTENDED_SCENE_MODE_DISABLED` <br /> Extended scene mode is disabled. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_LOW_LIGHT_BOOST_STATE_ACTIVE` <br /> The AE mode 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY' is enabled and applied. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_LOW_LIGHT_BOOST_STATE_INACTIVE` <br /> The AE mode 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY' is enabled but not applied. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_AUTO` <br /> Use settings for each individual 3A routine. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_OFF` <br /> Full application control of pipeline. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_OFF_KEEP_STATE` <br /> 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. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_USE_EXTENDED_SCENE_MODE` <br /> Use a specific extended scene mode. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_USE_SCENE_MODE` <br /> Use a specific scene mode. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_ACTION` <br /> Optimized for photos of quickly moving objects. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_BARCODE` <br /> Optimized for accurately capturing a photo of barcode for use by camera applications that wish to read the barcode value. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_BEACH` <br /> Optimized for bright, outdoor beach settings. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_CANDLELIGHT` <br /> Optimized for dim settings where the main light source is a candle. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_DISABLED` <br /> Indicates that no scene modes are set for a given capture request. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_FACE_PRIORITY` <br /> If face detection support exists, use face detection data for auto-focus, auto-white balance, and auto-exposure routines. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_FIREWORKS` <br /> Optimized for nighttime photos of fireworks. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_HDR` <br /> Turn on a device-specific high dynamic range (HDR) mode. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO` *This constant was deprecated in API level 23. Please refer to this API documentation to find the alternatives* | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_LANDSCAPE` <br /> Optimized for photos of distant macroscopic objects. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_NIGHT` <br /> Optimized for low-light settings. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_NIGHT_PORTRAIT` <br /> Optimized for still photos of people in low-light settings. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_PARTY` <br /> Optimized for dim, indoor settings with multiple moving people. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_PORTRAIT` <br /> Optimized for still photos of people. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_SNOW` <br /> Optimized for bright, outdoor settings containing snow. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_SPORTS` <br /> Optimized for photos of quickly moving people. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_STEADYPHOTO` <br /> Optimized to avoid blurry photos due to small amounts of device motion (for example: due to hand shake). | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_SUNSET` <br /> Optimized for scenes of the setting sun. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_THEATRE` <br /> Optimized for dim, indoor settings where flash must remain off. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SETTINGS_OVERRIDE_OFF` <br /> No keys are applied sooner than the other keys when applying CaptureRequest settings to the camera device. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SETTINGS_OVERRIDE_ZOOM` <br /> Zoom related keys are applied sooner than the other keys in the CaptureRequest. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_VIDEO_STABILIZATION_MODE_OFF` <br /> Video stabilization is disabled. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_VIDEO_STABILIZATION_MODE_ON` <br /> Video stabilization is enabled. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_VIDEO_STABILIZATION_MODE_PREVIEW_STABILIZATION` <br /> Preview stabilization, where the preview in addition to all other non-RAW streams are stabilized with the same quality of stabilization, is enabled. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_ZOOM_METHOD_AUTO` <br /> The camera device automatically detects whether the application does zoom with `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` or `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`, and in turn decides which metadata tag reflects the effective zoom level. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_ZOOM_METHOD_ZOOM_RATIO` <br /> The application intends to control zoom via `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`, and the effective zoom level is reflected by `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` in capture results. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#DISTORTION_CORRECTION_MODE_FAST` <br /> Lens distortion correction is applied without reducing frame rate relative to sensor output. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#DISTORTION_CORRECTION_MODE_HIGH_QUALITY` <br /> High-quality distortion correction is applied, at the cost of possibly reduced frame rate relative to sensor output. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#DISTORTION_CORRECTION_MODE_OFF` <br /> No distortion correction is applied. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EDGE_MODE_FAST` <br /> Apply edge enhancement at a quality level that does not slow down frame rate relative to sensor output. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EDGE_MODE_HIGH_QUALITY` <br /> Apply high-quality edge enhancement, at a cost of possibly reduced output frame rate. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EDGE_MODE_OFF` <br /> No edge enhancement is applied. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EDGE_MODE_ZERO_SHUTTER_LAG` <br /> Edge enhancement is applied at different levels for different output streams, based on resolution. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EXTENSION_NIGHT_MODE_INDICATOR_OFF` <br /> The camera has detected lighting conditions that are sufficiently bright. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EXTENSION_NIGHT_MODE_INDICATOR_ON` <br /> The camera has detected low-light conditions. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EXTENSION_NIGHT_MODE_INDICATOR_UNKNOWN` <br /> The camera can't accurately assess the scene's lighting to determine if a Night Mode Camera Extension capture would improve the photo. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_MODE_OFF` <br /> Do not fire the flash for this capture. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_MODE_SINGLE` <br /> If the flash is available and charged, fire flash for this capture. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_MODE_TORCH` <br /> Transition flash to continuously on. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_STATE_CHARGING` <br /> Flash is charging and cannot be fired. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_STATE_FIRED` <br /> Flash fired for this capture. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_STATE_PARTIAL` <br /> Flash partially illuminated this frame. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_STATE_READY` <br /> Flash is ready to fire. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_STATE_UNAVAILABLE` <br /> No flash on camera. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#HOT_PIXEL_MODE_FAST` <br /> Hot pixel correction is applied, without reducing frame rate relative to sensor raw output. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#HOT_PIXEL_MODE_HIGH_QUALITY` <br /> High-quality hot pixel correction is applied, at a cost of possibly reduced frame rate relative to sensor raw output. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#HOT_PIXEL_MODE_OFF` <br /> No hot pixel correction is applied. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_DEVICE_TYPE_BUILT_IN` <br /> This camera device is physically a part of this Android device, and the data produced is always within the device's control before it reaches the application requesting it. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_DEVICE_TYPE_EXTERNAL` <br /> This camera device is not permanently connected to this Android device. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_DEVICE_TYPE_UNKNOWN` <br /> This camera device has an unknown classification. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_DEVICE_TYPE_VIRTUAL` <br /> This camera device produces purely virtual images, though they may be based on the output of a real hardware camera in some cases. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_3` <br /> This camera device is capable of YUV reprocessing and RAW data capture, in addition to FULL-level capabilities. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_EXTERNAL` <br /> This camera device is backed by an external camera connected to this Android device. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` <br /> This camera device is capable of supporting advanced imaging applications. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY` <br /> This camera device is running in backward compatibility mode. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED` <br /> This camera device does not have enough capabilities to qualify as a `FULL` device or better. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_FACING_BACK` <br /> The camera device faces the opposite direction as the device's screen. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_FACING_EXTERNAL` <br /> The camera device is an external camera, and has no fixed facing relative to the device's screen. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_FACING_FRONT` <br /> The camera device faces the same direction as the device's screen. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_INFO_FOCUS_DISTANCE_CALIBRATION_APPROXIMATE` <br /> The lens focus distance is measured in diopters. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_INFO_FOCUS_DISTANCE_CALIBRATION_CALIBRATED` <br /> The lens focus distance is measured in diopters, and is calibrated. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_INFO_FOCUS_DISTANCE_CALIBRATION_UNCALIBRATED` <br /> The lens focus distance is not accurate, and the units used for `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FOCUS_DISTANCE` do not correspond to any physical units. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_OPTICAL_STABILIZATION_MODE_OFF` <br /> Optical stabilization is unavailable. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_OPTICAL_STABILIZATION_MODE_ON` <br /> Optical stabilization is enabled. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_POSE_REFERENCE_AUTOMOTIVE` <br /> The value of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_POSE_TRANSLATION` is relative to the origin of the automotive sensor coordinate system, which is at the center of the rear axle. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_POSE_REFERENCE_GYROSCOPE` <br /> The value of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_POSE_TRANSLATION` is relative to the position of the primary gyroscope of this Android device. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_POSE_REFERENCE_PRIMARY_CAMERA` <br /> The value of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_POSE_TRANSLATION` is relative to the optical center of the largest camera device facing the same direction as this camera. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_POSE_REFERENCE_UNDEFINED` <br /> The camera device cannot represent the values of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_POSE_TRANSLATION` and `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_POSE_ROTATION` accurately enough. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_STATE_MOVING` <br /> One or several of the lens parameters (`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FOCAL_LENGTH`, `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FOCUS_DISTANCE`, `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FILTER_DENSITY` or `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_APERTURE`) is currently changing. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_STATE_STATIONARY` <br /> The lens parameters (`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FOCAL_LENGTH`, `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FOCUS_DISTANCE`, `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FILTER_DENSITY` and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_APERTURE`) are not changing. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LOGICAL_MULTI_CAMERA_SENSOR_SYNC_TYPE_APPROXIMATE` <br /> A software mechanism is used to synchronize between the physical cameras. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LOGICAL_MULTI_CAMERA_SENSOR_SYNC_TYPE_CALIBRATED` <br /> The camera device supports frame timestamp synchronization at the hardware level, and the timestamp of a physical stream image accurately reflects its start-of-exposure time. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_FAST` <br /> Noise reduction is applied without reducing frame rate relative to sensor output. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_HIGH_QUALITY` <br /> High-quality noise reduction is applied, at the cost of possibly reduced frame rate relative to sensor output. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_MINIMAL` <br /> MINIMAL noise reduction is applied without reducing frame rate relative to sensor output. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_OFF` <br /> No noise reduction is applied. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_ZERO_SHUTTER_LAG` <br /> Noise reduction is applied at different levels for different output streams, based on resolution. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE` <br /> The minimal set of capabilities that every camera device (regardless of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`) supports. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_BURST_CAPTURE` <br /> The camera device supports capturing high-resolution images at \>= 20 frames per second, in at least the uncompressed YUV format, when post-processing settings are set to FAST. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_COLOR_SPACE_PROFILES` <br /> The device supports querying the possible combinations of color spaces, image formats, and dynamic range profiles supported by the camera and requesting a particular color space for a session via `https://developer.android.com/reference/android/hardware/camera2/params/SessionConfiguration#setColorSpace(android.graphics.ColorSpace.Named)`. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO` <br /> The device supports constrained high speed video recording (frame rate \>=120fps) use case. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_DEPTH_OUTPUT` <br /> The camera device can produce depth measurements from its field of view. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT` <br /> The device supports one or more 10-bit camera outputs according to the dynamic range profiles specified in `https://developer.android.com/reference/android/hardware/camera2/params/DynamicRangeProfiles#getSupportedProfiles()`. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_LOGICAL_MULTI_CAMERA` <br /> The camera device is a logical camera backed by two or more physical cameras. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_MANUAL_POST_PROCESSING` <br /> The camera device post-processing stages can be manually controlled. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR` <br /> The camera device can be manually controlled (3A algorithms such as auto-exposure, and auto-focus can be bypassed). | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_MONOCHROME` <br /> The camera device is a monochrome camera that doesn't contain a color filter array, and for YUV_420_888 stream, the pixel values on U and V planes are all 128. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_MOTION_TRACKING` <br /> The camera device supports the MOTION_TRACKING value for `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_CAPTURE_INTENT`, which limits maximum exposure time to 20 ms. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_OFFLINE_PROCESSING` <br /> The camera device supports the OFFLINE_PROCESSING use case. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_PRIVATE_REPROCESSING` <br /> The camera device supports the Zero Shutter Lag reprocessing use case. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_RAW` <br /> The camera device supports outputting RAW buffers and metadata for interpreting them. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_READ_SENSOR_SETTINGS` <br /> The camera device supports accurately reporting the sensor settings for many of the sensor controls while the built-in 3A algorithm is running. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_REMOSAIC_REPROCESSING` <br /> The device supports reprocessing from the `RAW_SENSOR` format with a bayer pattern given by `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_BINNING_FACTOR` (m x n group of pixels with the same color filter) to a remosaiced regular bayer pattern. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_SECURE_IMAGE_DATA` <br /> The camera device is capable of writing image data into a region of memory inaccessible to Android userspace or the Android kernel, and only accessible to trusted execution environments (TEE). | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE` <br /> The camera device supports selecting a per-stream use case via `https://developer.android.com/reference/android/hardware/camera2/params/OutputConfiguration#setStreamUseCase(long)` so that the device can optimize camera pipeline parameters such as tuning, sensor mode, or ISP settings for a specific user scenario. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_SYSTEM_CAMERA` <br /> The camera device is only accessible by Android's system components and privileged applications. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR` <br /> This camera device is capable of producing ultra high resolution images in addition to the image sizes described in the `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP`. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_YUV_REPROCESSING` <br /> The camera device supports the YUV_420_888 reprocessing use case, similar as PRIVATE_REPROCESSING, This capability requires the camera device to support the following: - One input stream is supported, that is, `` `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#REQUEST_MAX_NUM_INPUT_STREAMS` == 1 ``. <br /> | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_AVAILABLE_STREAM_USE_CASES_CROPPED_RAW` <br /> Cropped RAW stream when the client chooses to crop the field of view. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_AVAILABLE_STREAM_USE_CASES_DEFAULT` <br /> Default stream use case. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_AVAILABLE_STREAM_USE_CASES_PREVIEW` <br /> Live stream shown to the user. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_AVAILABLE_STREAM_USE_CASES_PREVIEW_VIDEO_STILL` <br /> One single stream used for combined purposes of preview, video, and still capture. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_AVAILABLE_STREAM_USE_CASES_STILL_CAPTURE` <br /> Still photo capture. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_AVAILABLE_STREAM_USE_CASES_VIDEO_CALL` <br /> Long-running video call optimized for both power efficiency and video quality. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_AVAILABLE_STREAM_USE_CASES_VIDEO_RECORD` <br /> Recording video clips. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_CROPPING_TYPE_CENTER_ONLY` <br /> The camera device only supports centered crop regions. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_CROPPING_TYPE_FREEFORM` <br /> The camera device supports arbitrarily chosen crop regions. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_180` <br /> Processed images are rotated by 180 degrees. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_270` <br /> Processed images are rotated by 270 degrees clockwise, and then cropped to the original aspect ratio. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_90` <br /> Processed images are rotated by 90 degrees clockwise, and then cropped to the original aspect ratio. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_AUTO` <br /> The camera API automatically selects the best concrete value for rotate-and-crop based on the application's support for resizability and the current multi-window mode. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_NONE` <br /> No rotate and crop is applied. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_BGGR` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GBRG` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GRBG` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_MONO` <br /> Sensor doesn't have any Bayer color filter. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_NIR` <br /> Sensor has a near infrared filter capturing light with wavelength between roughly 750nm and 1400nm, and the same filter covers the whole sensor array. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGB` <br /> Sensor is not Bayer; output has 3 16-bit values for each pixel, instead of just 1 16-bit value per pixel. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGGB` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_INFO_TIMESTAMP_SOURCE_REALTIME` <br /> Timestamps from `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#SENSOR_TIMESTAMP` are in the same timebase as `https://developer.android.com/reference/android/os/SystemClock#elapsedRealtimeNanos()`, and they can be compared to other timestamps using that base. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_INFO_TIMESTAMP_SOURCE_UNKNOWN` <br /> Timestamps from `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#SENSOR_TIMESTAMP` 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 with accuracy. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_DEFAULT` <br /> This is the default sensor pixel mode. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION` <br /> In this mode, sensors typically do not bin pixels, as a result can offer larger image sizes. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_READOUT_TIMESTAMP_HARDWARE` <br /> This camera device supports the onReadoutStarted callback as well as outputting readout timestamps. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_READOUT_TIMESTAMP_NOT_SUPPORTED` <br /> This camera device doesn't support readout timestamp and onReadoutStarted callback. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_CLOUDY_WEATHER` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_COOL_WHITE_FLUORESCENT` <br /> W 3900 - 4500K <br /> | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_D50` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_D55` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_D65` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_D75` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT_FLUORESCENT` <br /> D 5700 - 7100K <br /> | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_DAY_WHITE_FLUORESCENT` <br /> N 4600 - 5400K <br /> | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_FINE_WEATHER` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_FLASH` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_FLUORESCENT` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_ISO_STUDIO_TUNGSTEN` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_SHADE` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_STANDARD_A` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_STANDARD_B` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_STANDARD_C` | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_TUNGSTEN` <br /> Incandescent light <br /> | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_REFERENCE_ILLUMINANT1_WHITE_FLUORESCENT` <br /> WW 3200 - 3700K <br /> | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_COLOR_BARS` <br /> All pixel data is replaced with an 8-bar color pattern. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY` <br /> 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. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_CUSTOM1` <br /> The first custom test pattern. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_OFF` <br /> No test pattern mode is used, and the camera device returns captures from the image sensor. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_PN9` <br /> 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). | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_SOLID_COLOR` <br /> Each pixel in `[R, G_even, G_odd, B]` is replaced by its respective color channel provided in `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_TEST_PATTERN_DATA`. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SHADING_MODE_FAST` <br /> Apply lens shading corrections, without slowing frame rate relative to sensor raw output <br /> | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SHADING_MODE_HIGH_QUALITY` <br /> Apply high-quality lens shading correction, at the cost of possibly reduced frame rate. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SHADING_MODE_OFF` <br /> No lens shading correction is applied. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_FACE_DETECT_MODE_FULL` <br /> Return all face metadata. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_FACE_DETECT_MODE_OFF` <br /> Do not include face detection statistics in capture results. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_FACE_DETECT_MODE_SIMPLE` <br /> Return face rectangle and confidence values only. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_LENS_SHADING_MAP_MODE_OFF` <br /> Do not include a lens shading map in the capture result. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_LENS_SHADING_MAP_MODE_ON` <br /> Include a lens shading map in the capture result. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_OIS_DATA_MODE_OFF` <br /> Do not include OIS data in the capture result. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_OIS_DATA_MODE_ON` <br /> Include OIS data in the capture result. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_SCENE_FLICKER_50HZ` <br /> The camera device detects illumination flickering at 50Hz in the current scene. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_SCENE_FLICKER_60HZ` <br /> The camera device detects illumination flickering at 60Hz in the current scene. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_SCENE_FLICKER_NONE` <br /> The camera device does not detect any flickering illumination in the current scene. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SYNC_MAX_LATENCY_PER_FRAME_CONTROL` <br /> Every frame has the requests immediately applied. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SYNC_MAX_LATENCY_UNKNOWN` <br /> Each new frame has some subset (potentially the entire set) of the past requests applied to the camera settings. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_CONTRAST_CURVE` <br /> Use the tone mapping curve specified in the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_CURVE`\* entries. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_FAST` <br /> Advanced gamma mapping and color enhancement may be applied, without reducing frame rate compared to raw sensor output. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_GAMMA_VALUE` <br /> Use the gamma value specified in `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_GAMMA` to perform tonemapping. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_HIGH_QUALITY` <br /> High-quality gamma mapping and color enhancement will be applied, at the cost of possibly reduced frame rate compared to raw sensor output. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_PRESET_CURVE` <br /> Use the preset tonemapping curve specified in `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_PRESET_CURVE` to perform tonemapping. | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_PRESET_CURVE_REC709` <br /> Tonemapping curve is defined by ITU-R BT.709 <br /> | | `int` | `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_PRESET_CURVE_SRGB` <br /> Tonemapping curve is defined by sRGB <br /> | |
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". | |

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Boolean>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#BLACK_LEVEL_LOCK` <br /> Whether black-level compensation is locked to its current values, or is free to vary. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE` <br /> Mode of operation for the chromatic aberration correction algorithm. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_COLOR_TEMPERATURE` <br /> Specifies the color temperature for CCT mode in Kelvin to adjust the white balance of the image. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_COLOR_TINT` <br /> Specifies the color tint for CCT mode to adjust the white balance of the image. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/android/hardware/camera2/params/RggbChannelVector>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_GAINS` <br /> Gains applying to Bayer raw color channels for white-balance. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE` <br /> The mode control selects how the image data is converted from the sensor's native color into linear sRGB color. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/android/hardware/camera2/params/ColorSpaceTransform>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_TRANSFORM` <br /> A color transform matrix to use to transform from sensor RGB color space to output linear sRGB color space. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_ANTIBANDING_MODE` <br /> The desired setting for the camera device's auto-exposure algorithm's antibanding compensation. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION` <br /> Adjustment to auto-exposure (AE) target image brightness. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Boolean>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_LOCK` <br /> Whether auto-exposure (AE) is currently locked to its latest calculated values. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` <br /> The desired mode for the camera device's auto-exposure routine. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER` <br /> Whether the camera device will trigger a precapture metering sequence when it processes this request. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRIORITY_MODE` <br /> Turn on AE priority mode. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/android/hardware/camera2/params/MeteringRectangle>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_REGIONS` <br /> List of metering areas to use for auto-exposure adjustment. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/android/util/Range<https://developer.android.com/reference/java/lang/Integer>>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE` <br /> Range over which the auto-exposure routine can adjust the capture frame rate to maintain good exposure. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_MODE` <br /> Whether auto-focus (AF) is currently enabled, and what mode it is set to. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/android/hardware/camera2/params/MeteringRectangle>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_REGIONS` <br /> List of metering areas to use for auto-focus. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_TRIGGER` <br /> Whether the camera device will trigger autofocus for this request. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AUTOFRAMING` <br /> Automatic crop, pan and zoom to keep objects in the center of the frame. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Boolean>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_LOCK` <br /> Whether auto-white balance (AWB) is currently locked to its latest calculated values. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_MODE` <br /> Whether auto-white balance (AWB) is currently setting the color transform fields, and what its illumination target is. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/android/hardware/camera2/params/MeteringRectangle>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_REGIONS` <br /> List of metering areas to use for auto-white-balance illuminant estimation. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_CAPTURE_INTENT` <br /> 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. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_EFFECT_MODE` <br /> A special color effect to apply. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Boolean>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ENABLE_ZSL` <br /> Allow camera device to enable zero-shutter-lag mode for requests with `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_CAPTURE_INTENT` == STILL_CAPTURE. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_EXTENDED_SCENE_MODE` <br /> Whether extended scene mode is enabled for a particular capture request. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE` <br /> Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control routines. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_POST_RAW_SENSITIVITY_BOOST` <br /> The amount of additional sensitivity boost applied to output images after RAW sensor data is captured. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_SCENE_MODE` <br /> Control for which scene mode is currently active. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_SETTINGS_OVERRIDE` <br /> The desired CaptureRequest settings override with which certain keys are applied earlier so that they can take effect sooner. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE` <br /> Whether video stabilization is active. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_METHOD` <br /> Whether the application uses `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` or `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` to control zoom levels. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Float>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` <br /> The desired zoom ratio Instead of using `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` for zoom, the application can now choose to use this tag to specify the desired zoom level. |
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/hardware/camera2/CaptureRequest>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CREATOR` |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE` <br /> Mode of operation for the lens distortion correction block. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#EDGE_MODE` <br /> Operation mode for edge enhancement. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#EXTENSION_STRENGTH` <br /> Strength of the extension post-processing effect This control allows Camera extension clients to configure the strength of the applied extension effect. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#FLASH_MODE` <br /> The desired mode for for the camera device's flash control. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#FLASH_STRENGTH_LEVEL` <br /> Flash strength level to be used when manual flash control is active. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#HOT_PIXEL_MODE` <br /> Operational mode for hot pixel correction. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/android/location/Location>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#JPEG_GPS_LOCATION` <br /> A location object to use when generating image GPS metadata. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#JPEG_ORIENTATION` <br /> The orientation for a JPEG image. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Byte>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#JPEG_QUALITY` <br /> Compression quality of the final JPEG image. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Byte>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#JPEG_THUMBNAIL_QUALITY` <br /> Compression quality of JPEG thumbnail. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/android/util/Size>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#JPEG_THUMBNAIL_SIZE` <br /> Resolution of embedded JPEG thumbnail. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Float>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_APERTURE` <br /> The desired lens aperture size, as a ratio of lens focal length to the effective aperture diameter. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Float>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FILTER_DENSITY` <br /> The desired setting for the lens neutral density filter(s). |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Float>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FOCAL_LENGTH` <br /> The desired lens focal length Focal length is the distance from the optical center of the lens to the focal point for a thin lens approximation of the camera optical system. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Float>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FOCUS_DISTANCE` <br /> Desired distance to plane of sharpest focus, measured from frontmost surface of the lens. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE` <br /> Sets whether the camera device uses optical image stabilization (OIS) when capturing images. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Boolean>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LOGICAL_MULTI_CAMERA_ADDITIONAL_RESULTS` <br /> Controls whether the camera device could also return additional physical cameras' metadata in the results. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#NOISE_REDUCTION_MODE` <br /> Mode of operation for the noise reduction algorithm. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Float>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR` <br /> The amount of exposure time increase factor applied to the original output frame by the application processing before sending for reprocessing. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/android/graphics/Rect>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` <br /> The desired region of the sensor to read out for this capture. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_ROTATE_AND_CROP` <br /> Whether a rotation-and-crop operation is applied to processed outputs from the camera. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Long>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME` <br /> Duration each pixel is exposed to light. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Long>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_FRAME_DURATION` <br /> Duration from start of frame readout to start of next frame readout. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE` <br /> Switches sensor pixel mode between maximum resolution mode and default mode. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY` <br /> The amount of gain applied to sensor data before processing. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<int[]>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_TEST_PATTERN_DATA` <br /> A pixel `[R, G_even, G_odd, B]` that supplies the test pattern when `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_TEST_PATTERN_MODE` is SOLID_COLOR. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_TEST_PATTERN_MODE` <br /> When enabled, the sensor sends a test pattern instead of doing a real exposure from the camera. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SHADING_MODE` <br /> Quality of lens shading correction applied to the image data. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#STATISTICS_FACE_DETECT_MODE` <br /> Operating mode for the face detector unit. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Boolean>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#STATISTICS_HOT_PIXEL_MAP_MODE` <br /> Operating mode for hot pixel map generation. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE` <br /> Whether the camera device will output the lens shading map in output result metadata. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#STATISTICS_OIS_DATA_MODE` <br /> A control for selecting whether optical stabilization (OIS) position information is included in output result metadata. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/android/hardware/camera2/params/TonemapCurve>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_CURVE` <br /> Tonemapping / contrast / gamma curve to use when `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE` is CONTRAST_CURVE. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Float>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_GAMMA` <br /> Tonemapping curve to use when `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE` is GAMMA_VALUE The tonemap curve will be defined the following formula: - OUT = pow(IN, 1.0 / gamma) where IN and OUT is the input pixel value scaled to range \[0.0, 1.0\], pow is the power function and gamma is the gamma value specified by this key. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE` <br /> High-level global contrast/gamma/tonemapping control. |
| ` public static final https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<https://developer.android.com/reference/java/lang/Integer>` | `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_PRESET_CURVE` <br /> Tonemapping curve to use when `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE` is PRESET_CURVE The tonemap curve will be defined by specified standard. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object other) ` Determine whether this CaptureRequest is equal to another CaptureRequest. |
| ` <T> T` | ` https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#get(android.hardware.camera2.CaptureRequest.Key<T>)(https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<T> key) ` Get a capture request field value. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<?>>` | ` https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#getKeys()() ` Returns a list of the keys contained in this map. |
| ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#getTag()() ` Retrieve the tag for this request, if any. |
| ` int` | ` https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#hashCode()() ` Returns a hash code value for the object. |
| ` boolean` | ` https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#isReprocess()() ` Determine if this is a reprocess capture request. |
| ` void` | ` https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

| ### Protected methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/android/hardware/camera2/CameraMetadata ` |---|---| | ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<?>>` | ` https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#getKeys()() ` Returns a list of the keys contained in this map. | ||
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/android/os/Parcelable ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. | ||

## Fields

### BLACK_LEVEL_LOCK

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Boolean> BLACK_LEVEL_LOCK
```

<br />

Whether black-level compensation is locked
to its current values, or is free to vary.

When set to `true` (ON), the values used for black-level
compensation will not change until the lock is set to
`false` (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:

- Request 1: Exposure = 10ms, Black level lock = OFF
- Request 2: Exposure = 10ms, Black level lock = ON
- Request 3: Exposure = 10ms, Black level lock = ON
- Request 4: Exposure = 20ms, Black level lock = ON
- Request 5: Exposure = 20ms, Black level lock = ON
- Request 6: Exposure = 20ms, Black level lock = ON

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:

- Result 1: Exposure = 10ms, Black level lock = OFF
- Result 2: Exposure = 10ms, Black level lock = ON
- Result 3: Exposure = 10ms, Black level lock = ON
- Result 4: Exposure = 20ms, Black level lock = OFF
- Result 5: Exposure = 20ms, Black level lock = ON
- Result 6: Exposure = 20ms, Black level lock = ON

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.

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`

### COLOR_CORRECTION_ABERRATION_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> COLOR_CORRECTION_ABERRATION_MODE
```

<br />

Mode of operation for the chromatic aberration correction algorithm.

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.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_ABERRATION_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_ABERRATION_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_ABERRATION_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_ABERRATION_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY`

### COLOR_CORRECTION_COLOR_TEMPERATURE

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> COLOR_CORRECTION_COLOR_TEMPERATURE
```

<br />

Specifies the color temperature for CCT mode in Kelvin
to adjust the white balance of the image.

Sets the color temperature in Kelvin units for when
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE` is CCT to adjust the
white balance of the image.

If CCT mode is enabled without a requested color temperature,
a default value will be set by the camera device. The default value can be
retrieved by checking the corresponding capture result. Color temperatures
requested outside the advertised `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#COLOR_CORRECTION_COLOR_TEMPERATURE_RANGE`
will be clamped.

**Units**: Kelvin

**Range of valid values:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#COLOR_CORRECTION_COLOR_TEMPERATURE_RANGE`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#COLOR_CORRECTION_COLOR_TEMPERATURE_RANGE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE`

### COLOR_CORRECTION_COLOR_TINT

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> COLOR_CORRECTION_COLOR_TINT
```

<br />

Specifies the color tint for CCT mode to adjust the white
balance of the image.

Sets the color tint for when `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE`
is CCT to adjust the white balance of the image.

If CCT mode is enabled without a requested color tint,
a default value will be set by the camera device. The default value can be
retrieved by checking the corresponding capture result. Color tints requested
outside the supported range will be clamped to the nearest limit (-50 or +50).

**Units**: D_uv defined as the distance from the Planckian locus on the CIE 1931 xy
chromaticity diagram, with the range ±50 mapping to ±0.01 D_uv

**Range of valid values:**   

The supported range, -50 to +50, corresponds to a D_uv distance
of ±0.01 below and above the Planckian locus. Some camera devices may have
limitations to achieving the full ±0.01 D_uv range at some color temperatures
(e.g., below 1500K). In these cases, the applied D_uv value may be clamped and
the actual color tint will be reported in the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_COLOR_TINT`
result.

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_COLOR_TINT`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE`

### COLOR_CORRECTION_GAINS

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<RggbChannelVector> COLOR_CORRECTION_GAINS
```

<br />

Gains applying to Bayer raw color channels for
white-balance.

These per-channel gains are either set by the camera device
when the request `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE` is not
TRANSFORM_MATRIX, or directly by the application in the
request when the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE` is
TRANSFORM_MATRIX.

The gains in the result metadata are the gains actually
applied by the camera device to the current frame.

The valid range of gains varies on different devices, but gains
between \[1.0, 3.0\] are guaranteed not to be clipped. Even if a given
device allows gains below 1.0, this is usually not recommended because
this can create color artifacts.

**Units**: Unitless gain factors

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`

### COLOR_CORRECTION_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> COLOR_CORRECTION_MODE
```

<br />

The mode control selects how the image data is converted from the
sensor's native color into linear sRGB color.

When auto-white balance (AWB) is enabled with `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_MODE`, 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 FAST or HIGH_QUALITY is used, the camera device may
do additional processing but `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_GAINS` and
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_TRANSFORM` 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:

![White balance processing pipeline](https://developer.android.com/static/reference/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:

    `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_GAINS` = [ R G_even G_odd B ]
     
where `G_even` is the gain for green pixels on even rows of the
output, and `G_odd` 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 `G_even` value, and write `G_odd` equal to
`G_even` in the output result metadata.

The matrices for color transforms are defined as a 9-entry vector:

    `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_TRANSFORM` = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ]
     
which define a transform from input sensor colors, `P_in = [ r g b ]`,
to output linear sRGB, `P_out = [ r' g' b' ]`,

with colors as follows:

    r' = I0r + I1g + I2b
     g' = I3r + I4g + I5b
     b' = I6r + I7g + I8b
     
Both the input and output value ranges must match. Overflow/underflow
values are clipped to fit within the range.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_MODE_TRANSFORM_MATRIX`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_MODE_HIGH_QUALITY`

**Available values for this device:**   

Starting from API level 36, `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_MODES`
can be used to check the list of supported values. Prior to API level 36,
TRANSFORM_MATRIX, HIGH_QUALITY, and FAST are guaranteed to be available
as valid modes on devices that support this key.

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_GAINS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_TRANSFORM`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_MODE_TRANSFORM_MATRIX`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#COLOR_CORRECTION_MODE_HIGH_QUALITY`

### COLOR_CORRECTION_TRANSFORM

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<ColorSpaceTransform> COLOR_CORRECTION_TRANSFORM
```

<br />

A color transform matrix to use to transform
from sensor RGB color space to output linear sRGB color space.

This matrix is either set by the camera device when the request
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE` is not TRANSFORM_MATRIX, or
directly by the application in the request when the
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE` 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 `[0, 1.0]` (assuming input color
values is within the normalized range `[0, 1.0]`), or clipping may occur.

The valid range of each matrix element varies on different devices, but
values within \[-1.5, 3.0\] are guaranteed not to be clipped.

**Units**: Unitless scale factors

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`

### CONTROL_AE_ANTIBANDING_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_AE_ANTIBANDING_MODE
```

<br />

The desired setting for the camera device's auto-exposure
algorithm's antibanding compensation.

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
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES` 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
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` or `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE` to OFF),
then this setting has no effect, and the application must
ensure it selects exposure times that do not cause banding
issues. The `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#STATISTICS_SCENE_FLICKER` key can assist
the application in this.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_ANTIBANDING_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_ANTIBANDING_MODE_50HZ`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_ANTIBANDING_MODE_60HZ`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_ANTIBANDING_MODE_AUTO`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#STATISTICS_SCENE_FLICKER`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_ANTIBANDING_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_ANTIBANDING_MODE_50HZ`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_ANTIBANDING_MODE_60HZ`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_ANTIBANDING_MODE_AUTO`

### CONTROL_AE_EXPOSURE_COMPENSATION

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_AE_EXPOSURE_COMPENSATION
```

<br />

Adjustment to auto-exposure (AE) target image
brightness.

The adjustment is measured as a count of steps, with the
step size defined by `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP` and the
allowed range by `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE`.

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 `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` `!=` OFF. This control
will take effect even when `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_LOCK` `== true`.

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, `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AE_STATE` field will be in the SEARCHING
state. Once the new exposure target is reached, `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AE_STATE` 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).

**Units**: Compensation steps

**Range of valid values:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_LOCK`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AE_STATE`

### CONTROL_AE_LOCK

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Boolean> CONTROL_AE_LOCK
```

<br />

Whether auto-exposure (AE) is currently locked to its latest
calculated values.

When set to `true` (ON), the AE algorithm is locked to its latest parameters,
and will not change exposure settings until the lock is set to `false` (OFF).

Note that even when AE is locked, the flash may be fired if
the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` is ON_AUTO_FLASH /
ON_ALWAYS_FLASH / ON_AUTO_FLASH_REDEYE.

When `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION` is changed, even if the AE lock
is ON, the camera device will still adjust its exposure value.

If AE precapture is triggered (see `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER`)
when AE is already locked, the camera device will not change the exposure time
(`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME`) and sensitivity (`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`)
parameters. The flash may be fired if the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` is ON_ALWAYS_FLASH, the scene may become overexposed.
Similarly, AE precapture trigger CANCEL has no effect when AE is already locked.

When an AE precapture sequence is triggered, AE unlock will not be able to unlock
the AE if AE is locked by the camera device internally during precapture metering
sequence In other words, submitting requests with AE unlock has no effect for an
ongoing precapture metering sequence. Otherwise, the precapture metering sequence
will never succeed in a sequence of preview requests where AE lock is always set
to `false`.

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:

1. Starting in auto-AE mode:
2. Lock AE
3. Wait for the first result to be output that has the AE locked
4. Copy exposure settings from that result into a request, set the request to manual AE
5. Submit the capture request, proceed to run manual AE as desired.

See `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AE_STATE` for AE lock related state transition details.

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AE_STATE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`

### CONTROL_AE_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_AE_MODE
```

<br />

The desired mode for the camera device's
auto-exposure routine.

This control is only effective if `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE` 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 (`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME`,
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`, and
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_FRAME_DURATION`). If `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRIORITY_MODE` is
enabled, the relevant priority CaptureRequest settings will not be overridden.
See `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRIORITY_MODE` for more details. 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 (`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_INFO_AVAILABLE` is `true`).

If flash TORCH mode is desired, this field must be set to
ON or OFF, and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#FLASH_MODE` 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.

When `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` is AE_MODE_ON and if the device
supports manual flash strength control, i.e.,
if `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL` and
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL` are greater than 1, then
the auto-exposure (AE) precapture metering sequence should be
triggered to avoid the image being incorrectly exposed at
different `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#FLASH_STRENGTH_LEVEL`.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_AUTO_FLASH`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_ALWAYS_FLASH`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_EXTERNAL_FLASH`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRIORITY_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_INFO_AVAILABLE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#FLASH_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#FLASH_STRENGTH_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_FRAME_DURATION`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_AUTO_FLASH`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_ALWAYS_FLASH`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_EXTERNAL_FLASH`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_MODE_ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY`

### CONTROL_AE_PRECAPTURE_TRIGGER

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_AE_PRECAPTURE_TRIGGER
```

<br />

Whether the camera device will trigger a precapture
metering sequence when it processes this request.

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.

When set to CANCEL, the camera device will cancel any active
precapture metering trigger, and return to its initial AE state.
If a precapture metering sequence is already completed, and the camera
device has implicitly locked the AE for subsequent still capture, the
CANCEL trigger will unlock the AE and return to its initial AE state.

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.

Flash is enabled during precapture sequence when:

- AE mode is ON_ALWAYS_FLASH
- AE mode is ON_AUTO_FLASH and the scene is deemed too dark without flash, or
- AE mode is ON and flash mode is TORCH or SINGLE

Normally, this entry should be set to START for only 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 (`` `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_CAPTURE_INTENT` == STILL_CAPTURE ``).
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 `` `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_LOCK` == true ``, followed by a request
with `` `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_LOCK` == false ``, if the application decides not to submit a
still capture request after the precapture sequence completes. Alternatively, for
API level 23 or newer devices, the CANCEL can be used to unlock the camera device
internally locked AE if the application doesn't submit a still capture request after
the AE precapture trigger. Note that, the CANCEL was added in API level 23, and must not
be used in devices that have earlier API levels.

The exact effect of auto-exposure (AE) precapture trigger
depends on the current AE mode and state; see
`https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AE_STATE` 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.

Using the precapture trigger and the auto-focus trigger `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_TRIGGER`
simultaneously is allowed. However, since these triggers often require cooperation between
the auto-focus and auto-exposure routines (for example, the may need to be enabled for a
focus sweep), the camera device may delay acting on a later trigger until the previous
trigger has been fully handled. This may lead to longer intervals between the trigger and
changes to `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AE_STATE` indicating the start of the precapture sequence, for
example.

If both the precapture and the auto-focus trigger are activated on the same request, then
the camera device will complete them in the optimal order for that device.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRECAPTURE_TRIGGER_IDLE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRECAPTURE_TRIGGER_START`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL`

**Optional** - The value for this key may be `null` on some devices.

**Limited capability** -
Present on all camera devices that report being at least `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_LOCK`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AE_STATE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_TRIGGER`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_CAPTURE_INTENT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRECAPTURE_TRIGGER_IDLE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRECAPTURE_TRIGGER_START`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL`

### CONTROL_AE_PRIORITY_MODE

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_AE_PRIORITY_MODE
```

<br />

Turn on AE priority mode.

This control is only effective if `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE` is
AUTO and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` is set to one of its
ON modes, with the exception of ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY.

When a priority mode is enabled, the camera device's
auto-exposure routine will maintain the application's
selected parameters relevant to the priority mode while overriding
the remaining exposure parameters
(`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME`, `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`, and
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_FRAME_DURATION`). For example, if
SENSOR_SENSITIVITY_PRIORITY mode is enabled, the camera device will
maintain the application-selected `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`
while adjusting `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME`
and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_FRAME_DURATION`. The overridden fields for a
given capture will be available in its CaptureResult.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRIORITY_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRIORITY_MODE_SENSOR_SENSITIVITY_PRIORITY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRIORITY_MODE_SENSOR_EXPOSURE_TIME_PRIORITY`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_FRAME_DURATION`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRIORITY_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRIORITY_MODE_SENSOR_SENSITIVITY_PRIORITY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AE_PRIORITY_MODE_SENSOR_EXPOSURE_TIME_PRIORITY`

### CONTROL_AE_REGIONS

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<MeteringRectangle[]> CONTROL_AE_REGIONS
```

<br />

List of metering areas to use for auto-exposure adjustment.

Not available if `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_MAX_REGIONS_AE` is 0.
Otherwise will always be present.

The maximum number of regions supported by the device is determined by the value
of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_MAX_REGIONS_AE`.

For devices not supporting `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE` control, the coordinate
system always follows that of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`, with (0,0) being
the top-left pixel in the active pixel array, and
(`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`.width - 1,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`.height - 1) being the bottom-right pixel in the
active pixel array.

For devices supporting `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE` control, the coordinate
system depends on the mode being set.
When the distortion correction mode is OFF, the coordinate system follows
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`, with
`(0, 0)` being the top-left pixel of the pre-correction active array, and
(`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`.width - 1,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`.height - 1) being the bottom-right
pixel in the pre-correction active pixel array.
When the distortion correction mode is not OFF, the coordinate system follows
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`, with
`(0, 0)` being the top-left pixel of the active array, and
(`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`.width - 1,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`.height - 1) being the bottom-right pixel in the
active pixel array.

The weight must be within `[0, 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 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, the camera device returns to the default
auto-exposure metering behavior.

If the metering region is outside the used `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` 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.

When setting the AE metering regions, the application must consider the additional
crop resulted from the aspect ratio differences between the preview stream and
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`. For example, if the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` is the full
active array size with 4:3 aspect ratio, and the preview stream is 16:9,
the boundary of AE regions will be \[0, y_crop\] and
\[active_width, active_height - 2 \* y_crop\] rather than \[0, 0\] and
\[active_width, active_height\], where y_crop is the additional crop due to aspect ratio
mismatch.

Starting from API level 30, the coordinate system of activeArraySize or
preCorrectionActiveArraySize is used to represent post-zoomRatio field of view, not
pre-zoom field of view. This means that the same aeRegions values at different
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` represent different parts of the scene. The aeRegions
coordinates are relative to the activeArray/preCorrectionActiveArray representing the
zoomed field of view. If `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` is set to 1.0 (default), the same
aeRegions at different `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` still represent the same parts of the
scene as they do before. See `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` for details. Whether to use
activeArraySize or preCorrectionActiveArraySize still depends on distortion correction
mode.

For camera devices with the
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR`
capability or devices where
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#getAvailableCaptureRequestKeys()`
lists `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE`,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION` /
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION` must be used as the
coordinate system for requests where `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE` is set to
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION`.

**Units** : Pixel coordinates within `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE` or
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE` depending on
distortion correction capability and mode

**Range of valid values:**   

Coordinates must be between `[(0,0), (width, height))` of
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE` or `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`
depending on distortion correction capability and mode

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_MAX_REGIONS_AE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE`

### CONTROL_AE_TARGET_FPS_RANGE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Range<Integer>> CONTROL_AE_TARGET_FPS_RANGE
```

<br />

Range over which the auto-exposure routine can
adjust the capture frame rate to maintain good
exposure.

Only constrains auto-exposure (AE) algorithm, not
manual control of `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME` and
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_FRAME_DURATION`.

Note that the actual achievable max framerate also depends on the minimum frame
duration of the output streams. The max frame rate will be
`min(aeTargetFpsRange.maxFps, 1 / max(individual stream min durations))`. For example,
if the application sets this key to `{60, 60}`, but the maximum minFrameDuration among
all configured streams is 33ms, the maximum framerate won't be 60fps, but will be
30fps.

To start a CaptureSession with a target FPS range different from the
capture request template's default value, the application
is strongly recommended to call
`https://developer.android.com/reference/android/hardware/camera2/params/SessionConfiguration#setSessionParameters(android.hardware.camera2.CaptureRequest)`
with the target fps range before creating the capture session. The aeTargetFpsRange is
typically a session parameter. Specifying it at session creation time helps avoid
session reconfiguration delays in cases like 60fps or high speed recording.

**Units**: Frames per second (FPS)

**Range of valid values:**   

Any of the entries in `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_FRAME_DURATION`

### CONTROL_AF_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_AF_MODE
```

<br />

Whether auto-focus (AF) is currently enabled, and what
mode it is set to.

Only effective if `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE` = AUTO and the lens is not fixed focus
(i.e. `` `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE` > 0 ``). Also note that
when `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` is OFF, the behavior of AF is device
dependent. It is recommended to lock AF by using `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_TRIGGER` before
setting `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` 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 `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AF_STATE`
in result metadata.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_AUTO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_MACRO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_CONTINUOUS_VIDEO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_CONTINUOUS_PICTURE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_EDOF`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AF_STATE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_TRIGGER`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_AUTO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_MACRO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_CONTINUOUS_VIDEO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_CONTINUOUS_PICTURE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_MODE_EDOF`

### CONTROL_AF_REGIONS

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<MeteringRectangle[]> CONTROL_AF_REGIONS
```

<br />

List of metering areas to use for auto-focus.

Not available if `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_MAX_REGIONS_AF` is 0.
Otherwise will always be present.

The maximum number of focus areas supported by the device is determined by the value
of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_MAX_REGIONS_AF`.

For devices not supporting `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE` control, the coordinate
system always follows that of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`, with (0,0) being
the top-left pixel in the active pixel array, and
(`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`.width - 1,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`.height - 1) being the bottom-right pixel in the
active pixel array.

For devices supporting `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE` control, the coordinate
system depends on the mode being set.
When the distortion correction mode is OFF, the coordinate system follows
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`, with
`(0, 0)` being the top-left pixel of the pre-correction active array, and
(`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`.width - 1,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`.height - 1) being the bottom-right
pixel in the pre-correction active pixel array.
When the distortion correction mode is not OFF, the coordinate system follows
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`, with
`(0, 0)` being the top-left pixel of the active array, and
(`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`.width - 1,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`.height - 1) being the bottom-right pixel in the
active pixel array.

The weight must be within `[0, 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 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, the camera device returns to the default focus metering
behavior. The capture result will either be a zero weight region as well, or
the region selected by the camera device as the focus area of interest.

If the metering region is outside the used `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` 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.

When setting the AF metering regions, the application must consider the additional
crop resulted from the aspect ratio differences between the preview stream and
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`. For example, if the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` is the full
active array size with 4:3 aspect ratio, and the preview stream is 16:9,
the boundary of AF regions will be \[0, y_crop\] and
\[active_width, active_height - 2 \* y_crop\] rather than \[0, 0\] and
\[active_width, active_height\], where y_crop is the additional crop due to aspect ratio
mismatch.

Starting from API level 30, the coordinate system of activeArraySize or
preCorrectionActiveArraySize is used to represent post-zoomRatio field of view, not
pre-zoom field of view. This means that the same afRegions values at different
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` represent different parts of the scene. The afRegions
coordinates are relative to the activeArray/preCorrectionActiveArray representing the
zoomed field of view. If `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` is set to 1.0 (default), the same
afRegions at different `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` still represent the same parts of the
scene as they do before. See `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` for details. Whether to use
activeArraySize or preCorrectionActiveArraySize still depends on distortion correction
mode.

For camera devices with the
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR`
capability or devices where
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#getAvailableCaptureRequestKeys()`
lists `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE`,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION` /
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION` must be used as the
coordinate system for requests where `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE` is set to
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION`.

**Units** : Pixel coordinates within `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE` or
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE` depending on
distortion correction capability and mode

**Range of valid values:**   

Coordinates must be between `[(0,0), (width, height))` of
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE` or `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`
depending on distortion correction capability and mode

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_MAX_REGIONS_AF`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE`

### CONTROL_AF_TRIGGER

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_AF_TRIGGER
```

<br />

Whether the camera device will trigger autofocus for this request.

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
autofocus algorithm. If autofocus is disabled, this trigger has no effect.

When set to CANCEL, the camera device will cancel any active trigger,
and return to its initial AF state.

Generally, applications should set this entry to START or CANCEL for only a
single capture, and then return it to IDLE (or not set at all). Specifying
START for multiple captures in a row means restarting the AF operation over
and over again.

See `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AF_STATE` for what the trigger means for each AF mode.

Using the autofocus trigger and the precapture trigger `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER`
simultaneously is allowed. However, since these triggers often require cooperation between
the auto-focus and auto-exposure routines (for example, the may need to be enabled for a
focus sweep), the camera device may delay acting on a later trigger until the previous
trigger has been fully handled. This may lead to longer intervals between the trigger and
changes to `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AF_STATE`, for example.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_TRIGGER_IDLE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_TRIGGER_START`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_TRIGGER_CANCEL`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#CONTROL_AF_STATE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_TRIGGER_IDLE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_TRIGGER_START`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AF_TRIGGER_CANCEL`

### CONTROL_AUTOFRAMING

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_AUTOFRAMING
```

<br />

Automatic crop, pan and zoom to keep objects in the center of the frame.

Auto-framing is a special mode provided by the camera device to dynamically crop, zoom
or pan the camera feed to try to ensure that the people in a scene occupy a reasonable
portion of the viewport. It is primarily designed to support video calling in
situations where the user isn't directly in front of the device, especially for
wide-angle cameras.
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` in CaptureResult will be used
to denote the coordinates of the auto-framed region.
Zoom and video stabilization controls are disabled when auto-framing is enabled. The 3A
regions must map the screen coordinates into the scaler crop returned from the capture
result instead of using the active array sensor.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AUTOFRAMING_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AUTOFRAMING_ON`

**Optional** - The value for this key may be `null` on some devices.

**Limited capability** -
Present on all camera devices that report being at least `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AUTOFRAMING_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AUTOFRAMING_ON`

### CONTROL_AWB_LOCK

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Boolean> CONTROL_AWB_LOCK
```

<br />

Whether auto-white balance (AWB) is currently locked to its
latest calculated values.

When set to `true` (ON), the AWB algorithm is locked to its latest parameters,
and will not change color balance settings until the lock is set to `false` (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:

1. Starting in auto-AWB mode:
2. Lock AWB
3. Wait for the first result to be output that has the AWB locked
4. Copy AWB settings from that result into a request, set the request to manual AWB
5. Submit the capture request, proceed to run manual AWB as desired.

Note that AWB lock is only meaningful when
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_MODE` 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.

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_MODE`

### CONTROL_AWB_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_AWB_MODE
```

<br />

Whether auto-white balance (AWB) is currently setting the color
transform fields, and what its illumination target
is.

This control is only effective if `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE` is AUTO.

When set to the AUTO mode, the camera device's auto-white balance
routine is enabled, overriding the application's selected
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_TRANSFORM`, `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_GAINS` and
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE`. Note that when `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
is OFF, the behavior of AWB is device dependent. It is recommended to
also set AWB mode to OFF or lock AWB by using `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_LOCK` 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 `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_TRANSFORM`, `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_GAINS`
and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE`.

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
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_TRANSFORM`,
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_GAINS` and
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE` are ignored.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_AUTO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_INCANDESCENT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_FLUORESCENT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_WARM_FLUORESCENT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_DAYLIGHT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_CLOUDY_DAYLIGHT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_TWILIGHT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_SHADE`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_GAINS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#COLOR_CORRECTION_TRANSFORM`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_LOCK`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_AUTO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_INCANDESCENT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_FLUORESCENT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_WARM_FLUORESCENT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_DAYLIGHT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_CLOUDY_DAYLIGHT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_TWILIGHT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_AWB_MODE_SHADE`

### CONTROL_AWB_REGIONS

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<MeteringRectangle[]> CONTROL_AWB_REGIONS
```

<br />

List of metering areas to use for auto-white-balance illuminant
estimation.

Not available if `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_MAX_REGIONS_AWB` is 0.
Otherwise will always be present.

The maximum number of regions supported by the device is determined by the value
of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_MAX_REGIONS_AWB`.

For devices not supporting `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE` control, the coordinate
system always follows that of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`, with (0,0) being
the top-left pixel in the active pixel array, and
(`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`.width - 1,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`.height - 1) being the bottom-right pixel in the
active pixel array.

For devices supporting `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE` control, the coordinate
system depends on the mode being set.
When the distortion correction mode is OFF, the coordinate system follows
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`, with
`(0, 0)` being the top-left pixel of the pre-correction active array, and
(`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`.width - 1,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`.height - 1) being the bottom-right
pixel in the pre-correction active pixel array.
When the distortion correction mode is not OFF, the coordinate system follows
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`, with
`(0, 0)` being the top-left pixel of the active array, and
(`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`.width - 1,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`.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, the camera device returns to the default white balance
metering behavior.

If the metering region is outside the used `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` 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.

When setting the AWB metering regions, the application must consider the additional
crop resulted from the aspect ratio differences between the preview stream and
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`. For example, if the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` is the full
active array size with 4:3 aspect ratio, and the preview stream is 16:9,
the boundary of AWB regions will be \[0, y_crop\] and
\[active_width, active_height - 2 \* y_crop\] rather than \[0, 0\] and
\[active_width, active_height\], where y_crop is the additional crop due to aspect ratio
mismatch.

Starting from API level 30, the coordinate system of activeArraySize or
preCorrectionActiveArraySize is used to represent post-zoomRatio field of view, not
pre-zoom field of view. This means that the same awbRegions values at different
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` represent different parts of the scene. The awbRegions
coordinates are relative to the activeArray/preCorrectionActiveArray representing the
zoomed field of view. If `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` is set to 1.0 (default), the same
awbRegions at different `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` still represent the same parts of
the scene as they do before. See `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` for details. Whether to use
activeArraySize or preCorrectionActiveArraySize still depends on distortion correction
mode.

For camera devices with the
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR`
capability or devices where
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#getAvailableCaptureRequestKeys()`
lists `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE`,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION` /
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION` must be used as the
coordinate system for requests where `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE` is set to
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION`.

**Units** : Pixel coordinates within `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE` or
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE` depending on
distortion correction capability and mode

**Range of valid values:**   

Coordinates must be between `[(0,0), (width, height))` of
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE` or `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`
depending on distortion correction capability and mode

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_MAX_REGIONS_AWB`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE`

### CONTROL_CAPTURE_INTENT

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_CAPTURE_INTENT
```

<br />

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.

This control (except for MANUAL) is only effective if
`` `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE` != OFF `` and any 3A routine is active.

All intents are supported by all devices, except that:

- ZERO_SHUTTER_LAG will be supported if `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES` contains PRIVATE_REPROCESSING or YUV_REPROCESSING.
- MANUAL will be supported if `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES` contains MANUAL_SENSOR.
- MOTION_TRACKING will be supported if `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES` contains MOTION_TRACKING.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_CUSTOM`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_PREVIEW`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_STILL_CAPTURE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_VIDEO_RECORD`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_MANUAL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_MOTION_TRACKING`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_CUSTOM`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_PREVIEW`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_STILL_CAPTURE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_VIDEO_RECORD`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_MANUAL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_CAPTURE_INTENT_MOTION_TRACKING`

### CONTROL_EFFECT_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_EFFECT_MODE
```

<br />

A special color effect to apply.

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.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_MONO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_NEGATIVE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_SOLARIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_SEPIA`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_POSTERIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_WHITEBOARD`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_BLACKBOARD`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_AQUA`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_MONO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_NEGATIVE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_SOLARIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_SEPIA`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_POSTERIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_WHITEBOARD`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_BLACKBOARD`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EFFECT_MODE_AQUA`

### CONTROL_ENABLE_ZSL

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Boolean> CONTROL_ENABLE_ZSL
```

<br />

Allow camera device to enable zero-shutter-lag mode for requests with
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_CAPTURE_INTENT` == STILL_CAPTURE.

If enableZsl is `true`, the camera device may enable zero-shutter-lag mode for requests with
STILL_CAPTURE capture intent. The camera device may use images captured in the past to
produce output images for a zero-shutter-lag request. The result metadata including the
`https://developer.android.com/reference/android/hardware/camera2/CaptureResult#SENSOR_TIMESTAMP` reflects the source frames used to produce output images.
Therefore, the contents of the output images and the result metadata may be out of order
compared to previous regular requests. enableZsl does not affect requests with other
capture intents.

For example, when requests are submitted in the following order:
Request A: enableZsl is ON, `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_CAPTURE_INTENT` is PREVIEW
Request B: enableZsl is ON, `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_CAPTURE_INTENT` is STILL_CAPTURE

The output images for request B may have contents captured before the output images for
request A, and the result metadata for request B may be older than the result metadata for
request A.

Note that when enableZsl is `true`, it is not guaranteed to get output images captured in
the past for requests with STILL_CAPTURE capture intent.

For applications targeting SDK versions O and newer, the value of enableZsl in
TEMPLATE_STILL_CAPTURE template may be `true`. The value in other templates is always
`false` if present.

For applications targeting SDK versions older than O, the value of enableZsl in all
capture templates is always `false` if present.

For application-operated ZSL, use CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_CAPTURE_INTENT`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#SENSOR_TIMESTAMP`

### CONTROL_EXTENDED_SCENE_MODE

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_EXTENDED_SCENE_MODE
```

<br />

Whether extended scene mode is enabled for a particular capture request.

With bokeh mode, the camera device may blur out the parts of scene that are not in
focus, creating a bokeh (or shallow depth of field) effect for people or objects.

When set to BOKEH_STILL_CAPTURE mode with STILL_CAPTURE capture intent, due to the extra
processing needed for high quality bokeh effect, the stall may be longer than when
capture intent is not STILL_CAPTURE.

When set to BOKEH_STILL_CAPTURE mode with PREVIEW capture intent,

- If the camera device has BURST_CAPTURE capability, the frame rate requirement of BURST_CAPTURE must still be met.
- All streams not larger than the maximum streaming dimension for BOKEH_STILL_CAPTURE mode (queried via `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AVAILABLE_EXTENDED_SCENE_MODE_CAPABILITIES`) will have preview bokeh effect applied.

When set to BOKEH_CONTINUOUS mode, configured streams dimension should not exceed this mode's
maximum streaming dimension in order to have bokeh effect applied. Bokeh effect may not
be available for streams larger than the maximum streaming dimension.

Switching between different extended scene modes may involve reconfiguration of the camera
pipeline, resulting in long latency. The application should check this key against the
available session keys queried via
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#getAvailableSessionKeys()`.

For a logical multi-camera, bokeh may be implemented by stereo vision from sub-cameras
with different field of view. As a result, when bokeh mode is enabled, the camera device
may override `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` or `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`, and the field of
view may be smaller than when bokeh mode is off.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EXTENDED_SCENE_MODE_DISABLED`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EXTENDED_SCENE_MODE_BOKEH_STILL_CAPTURE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EXTENDED_SCENE_MODE_BOKEH_CONTINUOUS`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EXTENDED_SCENE_MODE_DISABLED`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EXTENDED_SCENE_MODE_BOKEH_STILL_CAPTURE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_EXTENDED_SCENE_MODE_BOKEH_CONTINUOUS`

### CONTROL_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_MODE
```

<br />

Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control
routines.

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 `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_MODE`.

When set to USE_SCENE_MODE or USE_EXTENDED_SCENE_MODE, the individual controls in
android.control.\* are mostly disabled, and the camera device
implements one of the scene mode or extended scene mode settings (such as ACTION,
SUNSET, PARTY, or BOKEH) as it wishes. The camera device scene mode
3A settings are provided by `https://developer.android.com/reference/android/hardware/camera2/CaptureResult`.

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.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_AUTO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_USE_SCENE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_OFF_KEEP_STATE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_USE_EXTENDED_SCENE_MODE`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AVAILABLE_MODES`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AVAILABLE_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_AUTO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_USE_SCENE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_OFF_KEEP_STATE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_MODE_USE_EXTENDED_SCENE_MODE`

### CONTROL_POST_RAW_SENSITIVITY_BOOST

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_POST_RAW_SENSITIVITY_BOOST
```

<br />

The amount of additional sensitivity boost applied to output images
after RAW sensor data is captured.

Some camera devices support additional digital sensitivity boosting in the
camera processing pipeline after sensor RAW image is captured.
Such a boost will be applied to YUV/JPEG format output images but will not
have effect on RAW output formats like RAW_SENSOR, RAW10, RAW12, RAW14
or RAW_OPAQUE.

This key will be `null` for devices that do not support any RAW format
outputs. For devices that do support RAW format outputs, this key will always
present, and if a device does not support post RAW sensitivity boost, it will
list `100` in this key.

If the camera device cannot apply the exact boost requested, it will reduce the
boost to the nearest supported value.
The final boost value used will be available in the output capture result.

For devices that support post RAW sensitivity boost, the YUV/JPEG output images
of such device will have the total sensitivity of
`` `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY` * `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_POST_RAW_SENSITIVITY_BOOST` / 100 ``
The sensitivity of RAW format images will always be `` `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY` ``

This control is only effective if `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` or `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE` is set to
OFF; otherwise the auto-exposure algorithm will override this value.

**Units** : ISO arithmetic units, the same as `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`

**Range of valid values:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_POST_RAW_SENSITIVITY_BOOST_RANGE`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_POST_RAW_SENSITIVITY_BOOST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_POST_RAW_SENSITIVITY_BOOST_RANGE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`

### CONTROL_SCENE_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_SCENE_MODE
```

<br />

Control for which scene mode is currently active.

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
`` `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE` == USE_SCENE_MODE ``. Aside from FACE_PRIORITY, these modes will
disable `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`, `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_MODE`, and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_MODE`
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.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_DISABLED`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_FACE_PRIORITY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_ACTION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_PORTRAIT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_LANDSCAPE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_NIGHT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_NIGHT_PORTRAIT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_THEATRE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_BEACH`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_SNOW`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_SUNSET`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_STEADYPHOTO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_FIREWORKS`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_SPORTS`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_PARTY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_CANDLELIGHT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_BARCODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_HDR`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_DISABLED`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_FACE_PRIORITY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_ACTION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_PORTRAIT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_LANDSCAPE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_NIGHT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_NIGHT_PORTRAIT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_THEATRE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_BEACH`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_SNOW`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_SUNSET`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_STEADYPHOTO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_FIREWORKS`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_SPORTS`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_PARTY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_CANDLELIGHT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_BARCODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SCENE_MODE_HDR`

### CONTROL_SETTINGS_OVERRIDE

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_SETTINGS_OVERRIDE
```

<br />

The desired CaptureRequest settings override with which certain keys are
applied earlier so that they can take effect sooner.

There are some CaptureRequest keys which can be applied earlier than others
when controls within a CaptureRequest aren't required to take effect at the same time.
One such example is zoom. Zoom can be applied at a later stage of the camera pipeline.
As soon as the camera device receives the CaptureRequest, it can apply the requested
zoom value onto an earlier request that's already in the pipeline, thus improves zoom
latency.

This key's value in the capture result reflects whether the controls for this capture
are overridden "by" a newer request. This means that if a capture request turns on
settings override, the capture result of an earlier request will contain the key value
of ZOOM. On the other hand, if a capture request has settings override turned on,
but all newer requests have it turned off, the key's value in the capture result will
be OFF because this capture isn't overridden by a newer capture. In the two examples
below, the capture results columns illustrate the settingsOverride values in different
scenarios.

Assuming the zoom settings override can speed up by 1 frame, below example illustrates
the speed-up at the start of capture session:

    Camera session created
     Request 1 (zoom=1.0x, override=ZOOM) ->
     Request 2 (zoom=1.2x, override=ZOOM) ->
     Request 3 (zoom=1.4x, override=ZOOM) ->  Result 1 (zoom=1.2x, override=ZOOM)
     Request 4 (zoom=1.6x, override=ZOOM) ->  Result 2 (zoom=1.4x, override=ZOOM)
     Request 5 (zoom=1.8x, override=ZOOM) ->  Result 3 (zoom=1.6x, override=ZOOM)
                                          ->  Result 4 (zoom=1.8x, override=ZOOM)
                                          ->  Result 5 (zoom=1.8x, override=OFF)
     
The application can turn on settings override and use zoom as normal. The example
shows that the later zoom values (1.2x, 1.4x, 1.6x, and 1.8x) overwrite the zoom
values (1.0x, 1.2x, 1.4x, and 1.8x) of earlier requests (#1, #2, #3, and #4).

The application must make sure the settings override doesn't interfere with user
journeys requiring simultaneous application of all controls in CaptureRequest on the
requested output targets. For example, if the application takes a still capture using
CameraCaptureSession#capture, and the repeating request immediately sets a different
zoom value using override, the inflight still capture could have its zoom value
overwritten unexpectedly.

So the application is strongly recommended to turn off settingsOverride when taking
still/burst captures, and turn it back on when there is only repeating viewfinder
request and no inflight still/burst captures.

Below is the example demonstrating the transitions in and out of the
settings override:

    Request 1 (zoom=1.0x, override=OFF)
     Request 2 (zoom=1.2x, override=OFF)
     Request 3 (zoom=1.4x, override=ZOOM)  -> Result 1 (zoom=1.0x, override=OFF)
     Request 4 (zoom=1.6x, override=ZOOM)  -> Result 2 (zoom=1.4x, override=ZOOM)
     Request 5 (zoom=1.8x, override=OFF)   -> Result 3 (zoom=1.6x, override=ZOOM)
                                           -> Result 4 (zoom=1.6x, override=OFF)
                                           -> Result 5 (zoom=1.8x, override=OFF)
     
This example shows that:

- The application "ramps in" settings override by setting the control to ZOOM. In the example, request #3 enables zoom settings override. Because the camera device can speed up applying zoom by 1 frame, the outputs of request #2 has 1.4x zoom, the value specified in request #3.
- The application "ramps out" of settings override by setting the control to OFF. In the example, request #5 changes the override to OFF. Because request #4's zoom takes effect in result #3, result #4's zoom remains the same until new value takes effect in result #5.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SETTINGS_OVERRIDE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SETTINGS_OVERRIDE_ZOOM`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AVAILABLE_SETTINGS_OVERRIDES`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_AVAILABLE_SETTINGS_OVERRIDES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SETTINGS_OVERRIDE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_SETTINGS_OVERRIDE_ZOOM`

### CONTROL_VIDEO_STABILIZATION_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_VIDEO_STABILIZATION_MODE
```

<br />

Whether video stabilization is
active.

Video stabilization automatically warps images from
the camera in order to stabilize motion between consecutive frames.

If enabled, video stabilization can modify the
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` 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.

In addition, not all recording sizes or frame rates may be supported for
stabilization by a device that reports stabilization support. It is guaranteed
that an output targeting a MediaRecorder or MediaCodec will be stabilized if
the recording resolution is less than or equal to 1920 x 1080 (width less than
or equal to 1920, height less than or equal to 1080), and the recording
frame rate is less than or equal to 30fps. At other sizes, the CaptureResult
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE` field will return
OFF if the recording output is not stabilized, or if there are no output
Surface types that can be stabilized.

The application is strongly recommended to call
`https://developer.android.com/reference/android/hardware/camera2/params/SessionConfiguration#setSessionParameters(android.hardware.camera2.CaptureRequest)`
with the desired video stabilization mode before creating the capture session.
Video stabilization mode is a session parameter on many devices. Specifying
it at session creation time helps avoid reconfiguration delay caused by difference
between the default value and the first CaptureRequest.

If a camera device supports both this mode and OIS
(`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE`), turning both modes on may
produce undesirable interaction, so it is recommended not to enable
both at the same time.

If video stabilization is set to "PREVIEW_STABILIZATION",
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE` is overridden. The camera sub-system may choose
to turn on hardware based image stabilization in addition to software based stabilization
if it deems that appropriate.
This key may be a part of the available session keys, which camera clients may
query via
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#getAvailableSessionKeys()`.
If this is the case, changing this key over the life-time of a capture session may
cause delays / glitches.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_VIDEO_STABILIZATION_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_VIDEO_STABILIZATION_MODE_ON`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_VIDEO_STABILIZATION_MODE_PREVIEW_STABILIZATION`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_VIDEO_STABILIZATION_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_VIDEO_STABILIZATION_MODE_ON`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_VIDEO_STABILIZATION_MODE_PREVIEW_STABILIZATION`

### CONTROL_ZOOM_METHOD

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> CONTROL_ZOOM_METHOD
```

<br />

Whether the application uses `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` or `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`
to control zoom levels.

If set to AUTO, the camera device detects which capture request key the application uses
to do zoom, `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` or `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`. If
the application doesn't set `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` or sets it to 1.0 in the capture
request, the effective zoom level is reflected in `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` in capture
results. If `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` is set to values other than 1.0, the effective
zoom level is reflected in `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`. AUTO is the default value
for this control, and also the behavior of the OS before Android version
`https://developer.android.com/reference/android/os/Build.VERSION_CODES#BAKLAVA`.

If set to ZOOM_RATIO, the application explicitly specifies zoom level be controlled
by `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`, and the effective zoom level is reflected in
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` in capture results. This addresses an ambiguity with AUTO,
with which the camera device cannot know if the application is using cropRegion or
zoomRatio at 1.0x.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_ZOOM_METHOD_AUTO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_ZOOM_METHOD_ZOOM_RATIO`

**Optional** - The value for this key may be `null` on some devices.

**Limited capability** -
Present on all camera devices that report being at least `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_ZOOM_METHOD_AUTO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#CONTROL_ZOOM_METHOD_ZOOM_RATIO`

### CONTROL_ZOOM_RATIO

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Float> CONTROL_ZOOM_RATIO
```

<br />

The desired zoom ratio

Instead of using `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` for zoom, the application can now choose to
use this tag to specify the desired zoom level.

By using this control, the application gains a simpler way to control zoom, which can
be a combination of optical and digital zoom. For example, a multi-camera system may
contain more than one lens with different focal lengths, and the user can use optical
zoom by switching between lenses. Using zoomRatio has benefits in the scenarios below:

- Zooming in from a wide-angle lens to a telephoto lens: A floating-point ratio provides better precision compared to an integer value of `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`.
- Zooming out from a wide lens to an ultrawide lens: zoomRatio supports zoom-out whereas `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` doesn't.

To illustrate, here are several scenarios of different zoom ratios, crop regions,
and output streams, for a hypothetical camera device with an active array of size
`(2000,1500)`.

- Camera Configuration:
  - Active array size: `2000x1500` (3 MP, 4:3 aspect ratio)
  - Output stream #1: `640x480` (VGA, 4:3 aspect ratio)
  - Output stream #2: `1280x720` (720p, 16:9 aspect ratio)
- Case #1: 4:3 crop region with 2.0x zoom ratio
  - Zoomed field of view: 1/4 of original field of view
  - Crop region: `Rect(0, 0, 2000, 1500) // (left, top, right, bottom)` (post zoom)
- ![4:3 aspect ratio crop diagram](https://developer.android.com/static/reference/images/camera2/metadata/android.control.zoomRatio/zoom-ratio-2-crop-43.png)
  - `640x480` stream source area: `(0, 0, 2000, 1500)` (equal to crop region)
  - `1280x720` stream source area: `(0, 187, 2000, 1312)` (letterboxed)
- Case #2: 16:9 crop region with 2.0x zoom.
  - Zoomed field of view: 1/4 of original field of view
  - Crop region: `Rect(0, 187, 2000, 1312)`
  - ![16:9 aspect ratio crop diagram](https://developer.android.com/static/reference/images/camera2/metadata/android.control.zoomRatio/zoom-ratio-2-crop-169.png)
  - `640x480` stream source area: `(250, 187, 1750, 1312)` (pillarboxed)
  - `1280x720` stream source area: `(0, 187, 2000, 1312)` (equal to crop region)
- Case #3: 1:1 crop region with 0.5x zoom out to ultrawide lens.
  - Zoomed field of view: 4x of original field of view (switched from wide lens to ultrawide lens)
  - Crop region: `Rect(250, 0, 1750, 1500)`
  - ![1:1 aspect ratio crop diagram](https://developer.android.com/static/reference/images/camera2/metadata/android.control.zoomRatio/zoom-ratio-0.5-crop-11.png)
  - `640x480` stream source area: `(250, 187, 1750, 1312)` (letterboxed)
  - `1280x720` stream source area: `(250, 328, 1750, 1172)` (letterboxed)

As seen from the graphs above, the coordinate system of cropRegion now changes to the
effective after-zoom field-of-view, and is represented by the rectangle of (0, 0,
activeArrayWith, activeArrayHeight). The same applies to AE/AWB/AF regions, and faces.
This coordinate system change isn't applicable to RAW capture and its related
metadata such as intrinsicCalibration and lensShadingMap.

Using the same hypothetical example above, and assuming output stream #1 (640x480) is
the viewfinder stream, the application can achieve 2.0x zoom in one of two ways:

- zoomRatio = 2.0, scaler.cropRegion = (0, 0, 2000, 1500)
- zoomRatio = 1.0 (default), scaler.cropRegion = (500, 375, 1500, 1125)

If the application intends to set aeRegions to be top-left quarter of the viewfinder
field-of-view, the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_REGIONS` should be set to (0, 0, 1000, 750) with
zoomRatio set to 2.0. Alternatively, the application can set aeRegions to the equivalent
region of (500, 375, 1000, 750) for zoomRatio of 1.0. If the application doesn't
explicitly set `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`, its value defaults to 1.0.

One limitation of controlling zoom using zoomRatio is that the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`
must only be used for letterboxing or pillarboxing of the sensor active array, and no
FREEFORM cropping can be used with `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` other than 1.0. If
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` is not 1.0, and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` is set to be
windowboxing, the camera framework will override the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` to be
the active array.

In the capture request, if the application sets `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` to a
value != 1.0, the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` tag in the capture result reflects the
effective zoom ratio achieved by the camera device, and the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`
adjusts for additional crops that are not zoom related. Otherwise, if the application
sets `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` to 1.0, or does not set it at all, the
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` tag in the result metadata will also be 1.0.

When the application requests a physical stream for a logical multi-camera, the
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` in the physical camera result metadata will be 1.0, and
the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` tag reflects the amount of zoom and crop done by the
physical camera device.

**Range of valid values:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_ZOOM_RATIO_RANGE`

**Optional** - The value for this key may be `null` on some devices.

**Limited capability** -
Present on all camera devices that report being at least `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#CONTROL_ZOOM_RATIO_RANGE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`

### CREATOR

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<CaptureRequest> CREATOR
```

<br />

<br />

### DISTORTION_CORRECTION_MODE

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> DISTORTION_CORRECTION_MODE
```

<br />

Mode of operation for the lens distortion correction block.

The lens distortion correction block attempts to improve image quality by fixing
radial, tangential, or other geometric aberrations in the camera device's optics. If
available, the `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_DISTORTION` field documents the lens's distortion parameters.

OFF means no distortion correction is done.

FAST/HIGH_QUALITY both mean camera device determined distortion correction will be
applied. HIGH_QUALITY mode indicates that the camera device will use the highest-quality
correction algorithms, even if it slows down capture rate. FAST means the camera device
will not slow down capture rate when applying correction. FAST may be the same as OFF if
any correction at all would slow down capture rate. Every output stream will have a
similar amount of enhancement applied.

The correction only applies to processed outputs such as YUV, Y8, JPEG, or DEPTH16; it is
not applied to any RAW output.

This control will be on by default on devices that support this control. Applications
disabling distortion correction need to pay extra attention with the coordinate system of
metering regions, crop region, and face rectangles. When distortion correction is OFF,
metadata coordinates follow the coordinate system of
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`. When distortion is not OFF, metadata
coordinates follow the coordinate system of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`. The
camera device will map these metadata fields to match the corrected image produced by the
camera device, for both capture requests and results. However, this mapping is not very
precise, since rectangles do not generally map to rectangles when corrected. Only linear
scaling between the active array and precorrection active array coordinates is
performed. Applications that require precise correction of metadata need to undo that
linear scaling, and apply a more complete correction that takes into the account the app's
own requirements.

The full list of metadata that is affected in this way by distortion correction is:

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#STATISTICS_FACES`

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#DISTORTION_CORRECTION_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#DISTORTION_CORRECTION_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#DISTORTION_CORRECTION_MODE_HIGH_QUALITY`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#DISTORTION_CORRECTION_AVAILABLE_MODES`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#DISTORTION_CORRECTION_AVAILABLE_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_DISTORTION`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#STATISTICS_FACES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#DISTORTION_CORRECTION_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#DISTORTION_CORRECTION_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#DISTORTION_CORRECTION_MODE_HIGH_QUALITY`

### EDGE_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> EDGE_MODE
```

<br />

Operation mode for edge
enhancement.

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. FAST may be the same as OFF if
edge enhancement will slow down capture rate. Every output stream will have a similar
amount of enhancement applied.

ZERO_SHUTTER_LAG is meant to be used by applications that maintain a continuous circular
buffer of high-resolution images during preview and reprocess image(s) from that buffer
into a final capture when triggered by the user. In this mode, the camera device applies
edge enhancement to low-resolution streams (below maximum recording resolution) to
maximize preview quality, but does not apply edge enhancement to high-resolution streams,
since those will be reprocessed later if necessary.

For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera
device will apply FAST/HIGH_QUALITY YUV-domain edge enhancement, respectively.
The camera device may adjust its internal edge enhancement parameters for best
image quality based on the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR`, if it is set.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EDGE_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EDGE_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EDGE_MODE_HIGH_QUALITY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EDGE_MODE_ZERO_SHUTTER_LAG`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES`

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EDGE_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EDGE_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EDGE_MODE_HIGH_QUALITY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#EDGE_MODE_ZERO_SHUTTER_LAG`

### EXTENSION_STRENGTH

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> EXTENSION_STRENGTH
```

<br />

Strength of the extension post-processing effect

This control allows Camera extension clients to configure the strength of the applied
extension effect. Strength equal to 0 means that the extension must not apply any
post-processing and return a regular captured frame. Strength equal to 100 is the
maximum level of post-processing. Values between 0 and 100 will have different effect
depending on the extension type as described below:

- `https://developer.android.com/reference/android/hardware/camera2/CameraExtensionCharacteristics#EXTENSION_BOKEH` - the strength is expected to control the amount of blur.
- `https://developer.android.com/reference/android/hardware/camera2/CameraExtensionCharacteristics#EXTENSION_HDR` and `https://developer.android.com/reference/android/hardware/camera2/CameraExtensionCharacteristics#EXTENSION_NIGHT` - the strength can control the amount of images fused and the brightness of the final image.
- `https://developer.android.com/reference/android/hardware/camera2/CameraExtensionCharacteristics#EXTENSION_FACE_RETOUCH` - the strength value will control the amount of cosmetic enhancement and skin smoothing.

The control will be supported if the capture request key is part of the list generated by
`https://developer.android.com/reference/android/hardware/camera2/CameraExtensionCharacteristics#getAvailableCaptureRequestKeys(int)`.
The control is only defined and available to clients sending capture requests via
`https://developer.android.com/reference/android/hardware/camera2/CameraExtensionSession`.
If the client doesn't specify the extension strength value, then a default value will
be set by the extension. Clients can retrieve the default value by checking the
corresponding capture result.

**Range of valid values:**   

0 - 100

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

### FLASH_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> FLASH_MODE
```

<br />

The desired mode for for the camera device's flash control.

This control is only effective when flash unit is available
(`` `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_INFO_AVAILABLE` == true ``).

When this control is used, the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` 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
(`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER`), 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 `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#FLASH_STATE` in the capture result metadata.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_MODE_SINGLE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_MODE_TORCH`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_INFO_AVAILABLE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#FLASH_STATE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_MODE_SINGLE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#FLASH_MODE_TORCH`

### FLASH_STRENGTH_LEVEL

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> FLASH_STRENGTH_LEVEL
```

<br />

Flash strength level to be used when manual flash control is active.

Flash strength level to use in capture mode i.e. when the applications control
flash with either `SINGLE` or `TORCH` mode.

Use `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL` and
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL` to check whether the device supports
flash strength control or not.
If the values of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL` and
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL` are greater than 1,
then the device supports manual flash strength control.

If the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#FLASH_MODE` `==` `TORCH` the value must be \>= 1
and \<= `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL`.
If the application doesn't set the key and
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL` \> 1,
then the flash will be fired at the default level set by HAL in
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_TORCH_STRENGTH_DEFAULT_LEVEL`.
If the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#FLASH_MODE` `==` `SINGLE`, then the value must be \>= 1
and \<= `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL`.
If the application does not set this key and
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL` \> 1,
then the flash will be fired at the default level set by HAL
in `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_SINGLE_STRENGTH_DEFAULT_LEVEL`.
If `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` is set to any of `ON_AUTO_FLASH`, `ON_ALWAYS_FLASH`,
`ON_AUTO_FLASH_REDEYE`, `ON_EXTERNAL_FLASH` values, then the strengthLevel will be ignored.

When AE mode is ON and flash mode is TORCH or SINGLE, the application should make sure
the AE mode, flash mode, and flash strength level remain the same between precapture
trigger request and final capture request. The flash strength level being set during
precapture sequence is used by the camera device as a reference. The actual strength
may be less, and the auto-exposure routine makes sure proper conversions of sensor
exposure time and sensitivities between precapture and final capture for the specified
strength level.

**Range of valid values:**   

``[1-`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL`]`` when the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#FLASH_MODE` is
set to TORCH;
``[1-`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL`]`` when the `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#FLASH_MODE` is
set to SINGLE

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#FLASH_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_SINGLE_STRENGTH_DEFAULT_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_TORCH_STRENGTH_DEFAULT_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL`

### HOT_PIXEL_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> HOT_PIXEL_MODE
```

<br />

Operational mode for hot pixel correction.

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).

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#HOT_PIXEL_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#HOT_PIXEL_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#HOT_PIXEL_MODE_HIGH_QUALITY`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#HOT_PIXEL_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#HOT_PIXEL_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#HOT_PIXEL_MODE_HIGH_QUALITY`

### JPEG_GPS_LOCATION

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Location> JPEG_GPS_LOCATION
```

<br />

A location object to use when generating image GPS metadata.

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.

This tag is also used for HEIC image capture.

This key is available on all devices.

<br />

<br />

### JPEG_ORIENTATION

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> JPEG_ORIENTATION
```

<br />

The orientation for a JPEG image.

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. When the image data is rotated,
the thumbnail data will also be rotated. Additionally, in the case where the image data
is rotated, `https://developer.android.com/reference/android/media/Image#getWidth()` and `https://developer.android.com/reference/android/media/Image#getHeight()`
will not be updated to reflect the height and width of the rotated image.

Note that this orientation is relative to the orientation of the camera sensor, given
by `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_ORIENTATION`.

To translate from the device orientation given by the Android sensor APIs for camera
sensors which are not EXTERNAL, the following sample code may be used:

    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;
     }
     
For EXTERNAL cameras the sensor orientation will always be set to 0 and the facing will
also be set to EXTERNAL. The above code is not relevant in such case.

This tag is also used to describe the orientation of the HEIC image capture, in which
case the rotation is reflected by
`https://developer.android.com/reference/android/media/ExifInterface#TAG_ORIENTATION`, and not by
rotating the image data itself.

**Units**: Degrees in multiples of 90

**Range of valid values:**   

0, 90, 180, 270

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_ORIENTATION`

### JPEG_QUALITY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Byte> JPEG_QUALITY
```

<br />

Compression quality of the final JPEG
image.

85-95 is typical usage range. This tag is also used to describe the quality
of the HEIC image capture.

**Range of valid values:**   

1-100; larger is higher quality

This key is available on all devices.

<br />

<br />

### JPEG_THUMBNAIL_QUALITY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Byte> JPEG_THUMBNAIL_QUALITY
```

<br />

Compression quality of JPEG
thumbnail.

This tag is also used to describe the quality of the HEIC image capture.

**Range of valid values:**   

1-100; larger is higher quality

This key is available on all devices.

<br />

<br />

### JPEG_THUMBNAIL_SIZE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Size> JPEG_THUMBNAIL_SIZE
```

<br />

Resolution of embedded JPEG thumbnail.

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.

When an `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#JPEG_ORIENTATION` of non-zero degree is requested,
the camera device will handle thumbnail rotation in one of the following ways:

- Set the `https://developer.android.com/reference/android/media/ExifInterface#TAG_ORIENTATION` and keep jpeg and thumbnail image data unrotated.
- Rotate the jpeg and thumbnail image data and not set `https://developer.android.com/reference/android/media/ExifInterface#TAG_ORIENTATION`. In this case, LIMITED or FULL hardware level devices will report rotated thumbnail size in capture result, so the width and height will be interchanged if 90 or 270 degree orientation is requested. LEGACY device will always report unrotated thumbnail size.

The tag is also used as thumbnail size for HEIC image format capture, in which case the
the thumbnail rotation is reflected by
`https://developer.android.com/reference/android/media/ExifInterface#TAG_ORIENTATION`, and not by
rotating the thumbnail data itself.

**Range of valid values:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#JPEG_ORIENTATION`

### LENS_APERTURE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Float> LENS_APERTURE
```

<br />

The desired lens aperture size, as a ratio of lens focal length to the
effective aperture diameter.

Setting this value is only supported on the camera devices that have a variable
aperture lens.

When this is supported and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` is OFF,
this can be set along with `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME`,
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`, and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_FRAME_DURATION`
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, `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#LENS_STATE` will be set to MOVING.

When this is supported and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` 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.

**Units**: The f-number (f/N)

**Range of valid values:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES`

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#LENS_STATE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_EXPOSURE_TIME`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_FRAME_DURATION`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`

### LENS_FILTER_DENSITY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Float> LENS_FILTER_DENSITY
```

<br />

The desired setting for the lens neutral density filter(s).

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,
`https://developer.android.com/reference/android/hardware/camera2/CaptureResult#LENS_STATE` will be set to MOVING.

**Units**: Exposure Value (EV)

**Range of valid values:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES`

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#LENS_STATE`

### LENS_FOCAL_LENGTH

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Float> LENS_FOCAL_LENGTH
```

<br />

The desired lens focal length

Focal length is the distance from the optical center of the lens to the
focal point for a thin lens approximation of the camera optical system.
The definition assumes the lens is focused at infinity.

The horizontal field-of-view of the processed full frame camera outputs
can be derived as:

    fov = 2 * atan2(sw / 2, fl)
     
where:

- `sw` is the `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PHYSICAL_SIZE` width,
- `fl` is `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FOCAL_LENGTH`.

Using this control to switch between lenses is not supported on most
devices. Starting from API level 30, the application is strongly recommended
to use `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` for combined optical and digital zoom. To
exclusively use a particular focal length lens in a logical multi-camera,
applications can iterate over the physical cameras exposed by the logical
multi-camera device via
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#getPhysicalCameraIds()`
and select the one with the desired focal length.

**Units**: Millimeters

**Range of valid values:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FOCAL_LENGTH`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PHYSICAL_SIZE`

### LENS_FOCUS_DISTANCE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Float> LENS_FOCUS_DISTANCE
```

<br />

Desired distance to plane of sharpest focus,
measured from frontmost surface of the lens.

This control can be used for setting manual focus, on devices that support
the MANUAL_SENSOR capability and have a variable-focus lens (see
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE`).

A value of `0.0f` means infinity focus. The value set will be clamped to
``[0.0f, `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE`]``.

Like `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FOCAL_LENGTH`, 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,
`https://developer.android.com/reference/android/hardware/camera2/CaptureResult#LENS_STATE` will be set to MOVING.

LEGACY devices support at most setting this to `0.0f`
for infinity focus.

**Units** : See `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION` for details

**Range of valid values:**   

\>= 0

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_FOCAL_LENGTH`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#LENS_STATE`

### LENS_OPTICAL_STABILIZATION_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE
```

<br />

Sets whether the camera device uses optical image stabilization (OIS)
when capturing images.

OIS is used to compensate for motion blur due to small
movements of the camera during capture. Unlike digital image
stabilization (`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE`), 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
(`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE`), turning both modes on may produce undesirable
interaction, so it is recommended not to enable both at the same time.

If `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE` is set to "PREVIEW_STABILIZATION",
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE` is overridden. The camera sub-system may choose
to turn on hardware based image stabilization in addition to software based stabilization
if it deems that appropriate. This key's value in the capture result will reflect which
OIS mode was chosen.

Not all devices will support OIS; see
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION` for
available controls.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_OPTICAL_STABILIZATION_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_OPTICAL_STABILIZATION_MODE_ON`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION`

**Optional** - The value for this key may be `null` on some devices.

**Limited capability** -
Present on all camera devices that report being at least `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_OPTICAL_STABILIZATION_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#LENS_OPTICAL_STABILIZATION_MODE_ON`

### LOGICAL_MULTI_CAMERA_ADDITIONAL_RESULTS

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Boolean> LOGICAL_MULTI_CAMERA_ADDITIONAL_RESULTS
```

<br />

Controls whether the camera device could also return additional
physical cameras' metadata in the results.

This control must only be turned on when device is using logical camera,
which are devices that have
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_LOGICAL_MULTI_CAMERA`
capability and the key is supported in the device's
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#getAvailableCaptureRequestKeys()`.
Once this key is set to ON, if the camera device has
multiple physical cameras active, the TotalCaptureResult will contain
additional physical camera metadata in the result. One of such
scenario is at the time of lens switch during zoom, where in addition
to the active physical camera, a secondary physical camera runs as a
"follower" and produces an additional physical camera CaptureResult.
The application can call `https://developer.android.com/reference/android/hardware/camera2/TotalCaptureResult#getPhysicalCameraTotalResults()`
to get the additional results.

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

### NOISE_REDUCTION_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> NOISE_REDUCTION_MODE
```

<br />

Mode of operation for the noise reduction algorithm.

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, for both raw and
YUV domain.

MINIMAL means that only sensor raw domain basic noise reduction is enabled ,to remove
demosaicing or other processing artifacts. For YUV_REPROCESSING, MINIMAL is same as OFF.
This mode is optional, may not be support by all devices. The application should check
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES` before using it.

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. FAST may be the same as MINIMAL if
MINIMAL is listed, or the same as OFF if any noise filtering will slow down capture rate.
Every output stream will have a similar amount of enhancement applied.

ZERO_SHUTTER_LAG is meant to be used by applications that maintain a continuous circular
buffer of high-resolution images during preview and reprocess image(s) from that buffer
into a final capture when triggered by the user. In this mode, the camera device applies
noise reduction to low-resolution streams (below maximum recording resolution) to maximize
preview quality, but does not apply noise reduction to high-resolution streams, since
those will be reprocessed later if necessary.

For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera device
will apply FAST/HIGH_QUALITY YUV domain noise reduction, respectively. The camera device
may adjust the noise reduction parameters for best image quality based on the
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR` if it is set.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_HIGH_QUALITY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_MINIMAL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_ZERO_SHUTTER_LAG`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES`

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_HIGH_QUALITY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_MINIMAL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#NOISE_REDUCTION_MODE_ZERO_SHUTTER_LAG`

### REPROCESS_EFFECTIVE_EXPOSURE_FACTOR

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Float> REPROCESS_EFFECTIVE_EXPOSURE_FACTOR
```

<br />

The amount of exposure time increase factor applied to the original output
frame by the application processing before sending for reprocessing.

This is optional, and will be supported if the camera device supports YUV_REPROCESSING
capability (`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES` contains YUV_REPROCESSING).

For some YUV reprocessing use cases, the application may choose to filter the original
output frames to effectively reduce the noise to the same level as a frame that was
captured with longer exposure time. To be more specific, assuming the original captured
images were captured with a sensitivity of S and an exposure time of T, the model in
the camera device is that the amount of noise in the image would be approximately what
would be expected if the original capture parameters had been a sensitivity of
S/effectiveExposureFactor and an exposure time of T\*effectiveExposureFactor, rather
than S and T respectively. If the captured images were processed by the application
before being sent for reprocessing, then the application may have used image processing
algorithms and/or multi-frame image fusion to reduce the noise in the
application-processed images (input images). By using the effectiveExposureFactor
control, the application can communicate to the camera device the actual noise level
improvement in the application-processed image. With this information, the camera
device can select appropriate noise reduction and edge enhancement parameters to avoid
excessive noise reduction (`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#NOISE_REDUCTION_MODE`) and insufficient edge
enhancement (`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#EDGE_MODE`) being applied to the reprocessed frames.

For example, for multi-frame image fusion use case, the application may fuse
multiple output frames together to a final frame for reprocessing. When N image are
fused into 1 image for reprocessing, the exposure time increase factor could be up to
square root of N (based on a simple photon shot noise model). The camera device will
adjust the reprocessing noise reduction and edge enhancement parameters accordingly to
produce the best quality images.

This is relative factor, 1.0 indicates the application hasn't processed the input
buffer in a way that affects its effective exposure time.

This control is only effective for YUV reprocessing capture request. For noise
reduction reprocessing, it is only effective when `` `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#NOISE_REDUCTION_MODE` != OFF ``.
Similarly, for edge enhancement reprocessing, it is only effective when
`` `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#EDGE_MODE` != OFF ``.

**Units**: Relative exposure time increase factor.

**Range of valid values:**   

\>= 1.0

**Optional** - The value for this key may be `null` on some devices.

**Limited capability** -
Present on all camera devices that report being at least `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#EDGE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#NOISE_REDUCTION_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES`

### SCALER_CROP_REGION

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Rect> SCALER_CROP_REGION
```

<br />

The desired region of the sensor to read out for this capture.

This control can be used to implement digital zoom.

For devices not supporting `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE` control, the coordinate
system always follows that of `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`, with `(0, 0)` being
the top-left pixel of the active array.

For devices supporting `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE` control, the coordinate system
depends on the mode being set. When the distortion correction mode is OFF, the
coordinate system follows `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`, with `(0,
0)` being the top-left pixel of the pre-correction active array. When the distortion
correction mode is not OFF, the coordinate system follows
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`, with `(0, 0)` being the top-left pixel of the
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 usually applied after the RAW to other color space (e.g. YUV)
conversion. As a result RAW streams are not croppable unless supported by the
camera device. See `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_AVAILABLE_STREAM_USE_CASES`#CROPPED_RAW for details.

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.

To illustrate, here are several scenarios of different crop regions and output streams,
for a hypothetical camera device with an active array of size `(2000,1500)`. Note that
several of these examples use non-centered crop regions for ease of illustration; such
regions are only supported on devices with FREEFORM capability
(`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_CROPPING_TYPE` `== FREEFORM`), but this does not affect the way the crop
rules work otherwise.

- Camera Configuration:
  - Active array size: `2000x1500` (3 MP, 4:3 aspect ratio)
  - Output stream #1: `640x480` (VGA, 4:3 aspect ratio)
  - Output stream #2: `1280x720` (720p, 16:9 aspect ratio)
- Case #1: 4:3 crop region with 2x digital zoom
  - Crop region: `Rect(500, 375, 1500, 1125) // (left, top, right, bottom)`
  - ![4:3 aspect ratio crop diagram](https://developer.android.com/static/reference/images/camera2/metadata/android.scaler.cropRegion/crop-region-43-ratio.png)
  - `640x480` stream source area: `(500, 375, 1500, 1125)` (equal to crop region)
  - `1280x720` stream source area: `(500, 469, 1500, 1031)` (letterboxed)
- Case #2: 16:9 crop region with \~1.5x digital zoom.
  - Crop region: `Rect(500, 375, 1833, 1125)`
  - ![16:9 aspect ratio crop diagram](https://developer.android.com/static/reference/images/camera2/metadata/android.scaler.cropRegion/crop-region-169-ratio.png)
  - `640x480` stream source area: `(666, 375, 1666, 1125)` (pillarboxed)
  - `1280x720` stream source area: `(500, 375, 1833, 1125)` (equal to crop region)
- Case #3: 1:1 crop region with \~2.6x digital zoom.
  - Crop region: `Rect(500, 375, 1250, 1125)`
  - ![1:1 aspect ratio crop diagram](https://developer.android.com/static/reference/images/camera2/metadata/android.scaler.cropRegion/crop-region-11-ratio.png)
  - `640x480` stream source area: `(500, 469, 1250, 1031)` (letterboxed)
  - `1280x720` stream source area: `(500, 543, 1250, 957)` (letterboxed)
- Case #4: Replace `640x480` stream with `1024x1024` stream, with 4:3 crop region:
  - Crop region: `Rect(500, 375, 1500, 1125)`
  - ![Square output, 4:3 aspect ratio crop diagram](https://developer.android.com/static/reference/images/camera2/metadata/android.scaler.cropRegion/crop-region-43-square-ratio.png)
  - `1024x1024` stream source area: `(625, 375, 1375, 1125)` (pillarboxed)
  - `1280x720` stream source area: `(500, 469, 1500, 1031)` (letterboxed)
  - Note that in this case, neither of the two outputs is a subset of the other, with each containing image data the other doesn't have.

If the coordinate system is `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`, the width and height
of the crop region cannot be set to be smaller than
``floor( activeArraySize.width / `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM` )`` and
``floor( activeArraySize.height / `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM` )``, respectively.

If the coordinate system is `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`, the width
and height of the crop region cannot be set to be smaller than
``floor( preCorrectionActiveArraySize.width / `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM` )``
and
``floor( preCorrectionActiveArraySize.height / `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM` )``,
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.

The camera sensor output aspect ratio depends on factors such as output stream
combination and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE`, and shouldn't be adjusted by using
this control. And the camera device will treat different camera sensor output sizes
(potentially with in-sensor crop) as the same crop of
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`. As a result, the application shouldn't assume the
maximum crop region always maps to the same aspect ratio or field of view for the
sensor output.

Starting from API level 30, it's strongly recommended to use `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`
to take advantage of better support for zoom with logical multi-camera. The benefits
include better precision with optical-digital zoom combination, and ability to do
zoom-out from 1.0x. When using `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` for zoom, the crop region in
the capture request should be left as the default activeArray size. The
coordinate system is post-zoom, meaning that the activeArraySize or
preCorrectionActiveArraySize covers the camera device's field of view "after" zoom. See
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO` for details.

For camera devices with the
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR`
capability or devices where `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#getAvailableCaptureRequestKeys()`
lists `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE`,
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION` /
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION` must be used as the
coordinate system for requests where `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE` is set to
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION`.

**Units** : Pixel coordinates relative to
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE` or
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE` depending on distortion correction
capability and mode

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#DISTORTION_CORRECTION_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_AVAILABLE_STREAM_USE_CASES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_CROPPING_TYPE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_PIXEL_MODE`

### SCALER_ROTATE_AND_CROP

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> SCALER_ROTATE_AND_CROP
```

<br />

Whether a rotation-and-crop operation is applied to processed
outputs from the camera.

This control is primarily intended to help camera applications with no support for
multi-window modes to work correctly on devices where multi-window scenarios are
unavoidable, such as foldables or other devices with variable display geometry or more
free-form window placement (such as laptops, which often place portrait-orientation apps
in landscape with pillarboxing).

If supported, the default value is `ROTATE_AND_CROP_AUTO`, which allows the camera API
to enable backwards-compatibility support for applications that do not support resizing
/ multi-window modes, when the device is in fact in a multi-window mode (such as inset
portrait on laptops, or on a foldable device in some fold states). In addition,
`ROTATE_AND_CROP_NONE` and `ROTATE_AND_CROP_90` will always be available if this control
is supported by the device. If not supported, devices API level 30 or higher will always
list only `ROTATE_AND_CROP_NONE`.

When `CROP_AUTO` is in use, and the camera API activates backward-compatibility mode,
several metadata fields will also be parsed differently to ensure that coordinates are
correctly handled for features like drawing face detection boxes or passing in
tap-to-focus coordinates. The camera API will convert positions in the active array
coordinate system to/from the cropped-and-rotated coordinate system to make the
operation transparent for applications. The following controls are affected:

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#STATISTICS_FACES`

Capture results will contain the actual value selected by the API;
`ROTATE_AND_CROP_AUTO` will never be seen in a capture result.

Applications can also select their preferred cropping mode, either to opt out of the
backwards-compatibility treatment, or to use the cropping feature themselves as needed.
In this case, no coordinate translation will be done automatically, and all controls
will continue to use the normal active array coordinates.

Cropping and rotating is done after the application of digital zoom (via either
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION` or `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`), but before each individual
output is further cropped and scaled. It only affects processed outputs such as
YUV, PRIVATE, and JPEG. It has no effect on RAW outputs.

When `CROP_90` or `CROP_270` are selected, there is a significant loss to the field of
view. For example, with a 4:3 aspect ratio output of 1600x1200, `CROP_90` will still
produce 1600x1200 output, but these buffers are cropped from a vertical 3:4 slice at the
center of the 4:3 area, then rotated to be 4:3, and then upscaled to 1600x1200. Only
56.25% of the original FOV is still visible. In general, for an aspect ratio of `w:h`,
the crop and rotate operation leaves `(h/w)^2` of the field of view visible. For 16:9,
this is \~31.6%.

As a visual example, the figure below shows the effect of `ROTATE_AND_CROP_90` on the
outputs for the following parameters:

- Sensor active array: `2000x1500`
- Crop region: top-left: `(500, 375)`, size: `(1000, 750)` (4:3 aspect ratio)
- Output streams: YUV `640x480` and YUV `1280x720`
- `ROTATE_AND_CROP_90`

![Effect of ROTATE_AND_CROP_90](https://developer.android.com/static/reference/images/camera2/metadata/android.scaler.rotateAndCrop/crop-region-rotate-90-43-ratio.png)

With these settings, the regions of the active array covered by the output streams are:

- 640x480 stream crop: top-left: `(219, 375)`, size: `(562, 750)`
- 1280x720 stream crop: top-left: `(289, 375)`, size: `(422, 750)`

Since the buffers are rotated, the buffers as seen by the application are:

- 640x480 stream: top-left: `(781, 375)` on active array, size: `(640, 480)`, downscaled 1.17x from sensor pixels
- 1280x720 stream: top-left: `(711, 375)` on active array, size: `(1280, 720)`, upscaled 1.71x from sensor pixels

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_NONE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_90`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_180`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_270`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_AUTO`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_AVAILABLE_ROTATE_AND_CROP_MODES`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AF_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_REGIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_ZOOM_RATIO`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_AVAILABLE_ROTATE_AND_CROP_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SCALER_CROP_REGION`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#STATISTICS_FACES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_NONE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_90`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_180`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_270`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SCALER_ROTATE_AND_CROP_AUTO`

### SENSOR_EXPOSURE_TIME

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Long> SENSOR_EXPOSURE_TIME
```

<br />

Duration each pixel is exposed to
light.

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 `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` or `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE` is set to
OFF; otherwise the auto-exposure algorithm will override this value. However, in the
case that `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRIORITY_MODE` is set to SENSOR_EXPOSURE_TIME_PRIORITY, this
control will be effective and not controlled by the auto-exposure algorithm.

**Units**: Nanoseconds

**Range of valid values:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE`

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRIORITY_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE`

### SENSOR_FRAME_DURATION

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Long> SENSOR_FRAME_DURATION
```

<br />

Duration from start of frame readout to
start of next frame readout.

The maximum frame rate that can be supported by a camera subsystem is
a function of many factors:

- Requested resolutions of output image streams
- Availability of binning / skipping modes on the imager
- The bandwidth of the imager interface
- The bandwidth of the various ISP processing blocks

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:

- 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.
- 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.
- Using more than one output stream in a request does not affect the frame duration.
- 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.

The necessary information for the application, given the model above, is provided via
`https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap#getOutputMinFrameDuration(int,%20android.util.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:

1. Let the set of currently configured input/output streams be called `S`.
2. Find the minimum frame durations for each stream in `S`, by looking it up in `https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap#getOutputMinFrameDuration(int,%20android.util.Size)` (with its respective size/format). Let this set of frame durations be called `F`.
3. For any given request `R`, the minimum frame duration allowed for `R` is the maximum out of all values in `F`. Let the streams used in `R` be called `S_r`.

If none of the streams in `S_r` have a stall time (listed in `https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap#getOutputStallDuration(int,%20android.util.Size)`
using its respective size/format), then the frame duration in `F` determines the steady
state frame rate that the application will get if it uses `R` as a repeating request. Let
this special kind of request be called `Rsimple`.

A repeating request `Rsimple` can be *occasionally* interleaved by a single capture of a
new request `Rstall` (which has at least one in-use stream with a non-0 stall time) and if
`Rstall` has the same minimum frame duration this will not cause a frame rate loss if all
buffers from the previous `Rstall` have already been delivered.

For more details about stalling, see `https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap#getOutputStallDuration(int,%20android.util.Size)`.

This control is only effective if `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` or `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE` is set to
OFF; otherwise the auto-exposure algorithm will override this value.

*Note:* Prior to Android 13, this field was described as measuring the duration from
start of frame exposure to start of next frame exposure, which doesn't reflect the
definition from sensor manufacturer. A mobile sensor defines the frame duration as
intervals between sensor readouts.

**Units**: Nanoseconds

**Range of valid values:**   

See `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION`, `https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap`.
The duration is capped to `max(duration, exposureTime + overhead)`.

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION`

### SENSOR_PIXEL_MODE

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> SENSOR_PIXEL_MODE
```

<br />

Switches sensor pixel mode between maximum resolution mode and default mode.

This key controls whether the camera sensor operates in
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION`
mode or not. By default, all camera devices operate in
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_DEFAULT` mode.
When operating in
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_DEFAULT` mode, sensors
would typically perform pixel binning in order to improve low light
performance, noise reduction etc. However, in
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION`
mode, sensors typically operate in unbinned mode allowing for a larger image size.
The stream configurations supported in
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION`
mode are also different from those of
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_DEFAULT` mode.
They can be queried through
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#get(android.hardware.camera2.CameraCharacteristics.Key<T>)` with
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP_MAXIMUM_RESOLUTION`.
Unless reported by both
`https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap`s, the outputs from
`` `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP_MAXIMUM_RESOLUTION` `` and
`` `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP` ``
must not be mixed in the same CaptureRequest. In other words, these outputs are
exclusive to each other.
This key does not need to be set for reprocess requests.
This key will be be present on devices supporting the
`https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR`
capability. It may also be present on devices which do not support the aforementioned
capability. In that case:

- The mandatory stream combinations listed in
  `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_MANDATORY_MAXIMUM_RESOLUTION_STREAM_COMBINATIONS` would not apply.

- The bayer pattern of `RAW` streams when
  `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION`
  is selected will be the one listed in `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_BINNING_FACTOR`.

- The following keys will always be present:

  - `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP_MAXIMUM_RESOLUTION`
  - `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION`
  - `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE_MAXIMUM_RESOLUTION`
  - `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION`

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_DEFAULT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_MANDATORY_MAXIMUM_RESOLUTION_STREAM_COMBINATIONS`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP_MAXIMUM_RESOLUTION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_BINNING_FACTOR`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE_MAXIMUM_RESOLUTION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_DEFAULT`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION`

### SENSOR_SENSITIVITY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> SENSOR_SENSITIVITY
```

<br />

The amount of gain applied to sensor data
before processing.

The sensitivity is the standard ISO sensitivity value,
as defined in ISO 12232:2006.

The sensitivity must be within `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE`, and
if if it less than `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY`, 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.

This control is only effective if `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` or `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE` is set to
OFF; otherwise the auto-exposure algorithm will override this value. However, in the
case that `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRIORITY_MODE` is set to SENSOR_SENSITIVITY_PRIORITY, this
control will be effective and not controlled by the auto-exposure algorithm.

Note that for devices supporting postRawSensitivityBoost, the total sensitivity applied
to the final processed image is the combination of `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY` and
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_POST_RAW_SENSITIVITY_BOOST`. In case the application uses the sensor
sensitivity from last capture result of an auto request for a manual request, in order
to achieve the same brightness in the output image, the application should also
set postRawSensitivityBoost.

**Units**: ISO arithmetic units

**Range of valid values:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE`

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_PRIORITY_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_POST_RAW_SENSITIVITY_BOOST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_SENSITIVITY`

### SENSOR_TEST_PATTERN_DATA

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<int[]> SENSOR_TEST_PATTERN_DATA
```

<br />

A pixel `[R, G_even, G_odd, B]` that supplies the test pattern
when `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_TEST_PATTERN_MODE` is SOLID_COLOR.

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.

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#SENSOR_TEST_PATTERN_MODE`

### SENSOR_TEST_PATTERN_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> SENSOR_TEST_PATTERN_MODE
```

<br />

When enabled, the sensor sends a test pattern instead of
doing a real exposure from the camera.

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.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_SOLID_COLOR`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_COLOR_BARS`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_PN9`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_CUSTOM1`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_SOLID_COLOR`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_COLOR_BARS`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_PN9`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SENSOR_TEST_PATTERN_MODE_CUSTOM1`

### SHADING_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> SHADING_MODE
```

<br />

Quality of lens shading correction applied
to the image data.

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 `` `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE` == ON ``. For example, for lens
shading map with size of `[ 4, 3 ]`,
the output `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP` for this case will be an identity
map shown below:

    [ 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 ]
     
When set to other modes, lens shading correction will be applied by the camera
device. Applications can request lens shading map data by setting
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE` to ON, and then the camera device will provide lens
shading map data in `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP`; 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(`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE` `!=` OFF and `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_MODE` `!=`
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.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SHADING_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SHADING_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SHADING_MODE_HIGH_QUALITY`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SHADING_AVAILABLE_MODES`

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AE_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#CONTROL_AWB_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#SHADING_AVAILABLE_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SHADING_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SHADING_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#SHADING_MODE_HIGH_QUALITY`

### STATISTICS_FACE_DETECT_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> STATISTICS_FACE_DETECT_MODE
```

<br />

Operating mode for the face detector
unit.

Whether face detection is enabled, and whether it
should output just the basic fields or the full set of
fields.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_FACE_DETECT_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_FACE_DETECT_MODE_SIMPLE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_FACE_DETECT_MODE_FULL`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES`

This key is available on all devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_FACE_DETECT_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_FACE_DETECT_MODE_SIMPLE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_FACE_DETECT_MODE_FULL`

### STATISTICS_HOT_PIXEL_MAP_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Boolean> STATISTICS_HOT_PIXEL_MAP_MODE
```

<br />

Operating mode for hot pixel map generation.

If set to `true`, a hot pixel map is returned in `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#STATISTICS_HOT_PIXEL_MAP`.
If set to `false`, no hot pixel map will be returned.

**Range of valid values:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureResult#STATISTICS_HOT_PIXEL_MAP`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES`

### STATISTICS_LENS_SHADING_MAP_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> STATISTICS_LENS_SHADING_MAP_MODE
```

<br />

Whether the camera device will output the lens
shading map in output result metadata.

When set to ON,
android.statistics.lensShadingMap will be provided in
the output result metadata.

ON is always supported on devices with the RAW capability.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_LENS_SHADING_MAP_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_LENS_SHADING_MAP_MODE_ON`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES`

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_LENS_SHADING_MAP_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_LENS_SHADING_MAP_MODE_ON`

### STATISTICS_OIS_DATA_MODE

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> STATISTICS_OIS_DATA_MODE
```

<br />

A control for selecting whether optical stabilization (OIS) position
information is included in output result metadata.

Since optical image stabilization generally involves motion much faster than the duration
of individual image exposure, multiple OIS samples can be included for a single capture
result. For example, if the OIS reporting operates at 200 Hz, a typical camera operating
at 30fps may have 6-7 OIS samples per capture result. This information can be combined
with the rolling shutter skew to account for lens motion during image exposure in
post-processing algorithms.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_OIS_DATA_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_OIS_DATA_MODE_ON`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#STATISTICS_INFO_AVAILABLE_OIS_DATA_MODES`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#STATISTICS_INFO_AVAILABLE_OIS_DATA_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_OIS_DATA_MODE_OFF`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#STATISTICS_OIS_DATA_MODE_ON`

### TONEMAP_CURVE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<TonemapCurve> TONEMAP_CURVE
```

<br />

Tonemapping / contrast / gamma curve to use when `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE`
is CONTRAST_CURVE.

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:

    curveRed =
       [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ]
     2 <= N <= `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS`

These are sorted in order of increasing `Pin`; 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
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS`).

For devices with MONOCHROME capability, all three channels must have the same set of
control points.

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:

    curveRed = [ (0, 0), (1.0, 1.0) ]
     
![Linear mapping curve](https://developer.android.com/static/reference/images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png)

Invert mapping:

    curveRed = [ (0, 1.0), (1.0, 0) ]
     
![Inverting mapping curve](https://developer.android.com/static/reference/images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png)

Gamma 1/2.2 mapping, with 16 control points:

    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) ]
     
![Gamma = 1/2.2 tonemapping curve](https://developer.android.com/static/reference/images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png)

Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:

    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) ]
     
![sRGB tonemapping curve](https://developer.android.com/static/reference/images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png)

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE`

### TONEMAP_GAMMA

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Float> TONEMAP_GAMMA
```

<br />

Tonemapping curve to use when `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE` is
GAMMA_VALUE

The tonemap curve will be defined the following formula:

- OUT = pow(IN, 1.0 / gamma)

where IN and OUT is the input pixel value scaled to range \[0.0, 1.0\],
pow is the power function and gamma is the gamma value specified by this
key.

The same curve will be applied to all color channels. The camera device
may clip the input gamma value to its supported range. The actual applied
value will be returned in capture result.

The valid range of gamma value varies on different devices, but values
within \[1.0, 5.0\] are guaranteed not to be clipped.

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE`

### TONEMAP_MODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> TONEMAP_MODE
```

<br />

High-level global contrast/gamma/tonemapping control.

When switching to an application-defined contrast curve by setting
`https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE` to CONTRAST_CURVE, the curve is defined
per-channel with a set of `(in, out)` 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 `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE` is
CONTRAST_CURVE.

When using either FAST or HIGH_QUALITY, the camera device will
emit its own tonemap curve in `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_CURVE`.
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.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_CONTRAST_CURVE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_HIGH_QUALITY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_GAMMA_VALUE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_PRESET_CURVE`

**Available values for this device:**   

`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES`

**Optional** - The value for this key may be `null` on some devices.

**Full capability** -
Present on all camera devices that report being `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL` devices in the
`https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL` key

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL`
- `https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_CURVE`
- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_CONTRAST_CURVE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_FAST`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_HIGH_QUALITY`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_GAMMA_VALUE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_MODE_PRESET_CURVE`

### TONEMAP_PRESET_CURVE

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Key<Integer> TONEMAP_PRESET_CURVE
```

<br />

Tonemapping curve to use when `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE` is
PRESET_CURVE

The tonemap curve will be defined by specified standard.

sRGB (approximated by 16 control points):

![sRGB tonemapping curve](https://developer.android.com/static/reference/images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png)

Rec. 709 (approximated by 16 control points):

![Rec. 709 tonemapping curve](https://developer.android.com/static/reference/images/camera2/metadata/android.tonemap.curveRed/rec709_tonemap.png)

Note that above figures show a 16 control points approximation of preset
curves. Camera devices may apply a different approximation to the curve.

**Possible values:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_PRESET_CURVE_SRGB`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_PRESET_CURVE_REC709`

**Optional** - The value for this key may be `null` on some devices.

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest#TONEMAP_MODE`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_PRESET_CURVE_SRGB`
- `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#TONEMAP_PRESET_CURVE_REC709`

## Public methods

### describeContents

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object other)
```

Determine whether this CaptureRequest is equal to another CaptureRequest.

A request is considered equal to another is if it's set of key/values is equal, it's
list of output surfaces is equal, the user tag is equal, and the return values of
isReprocess() are equal.

<br />

<br />

| Parameters ||
|---|---|
| `other` | `Object`: Another instance of CaptureRequest. This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | True if the requests are the same, false otherwise. <br /> |

### get

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public T get (Key<T> key)
```

Get a capture request field value.

The field definitions can be found in `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest`.

Querying the value for the same key more than once will return a value
which is equal to the previous queried value.

<br />

<br />

| Parameters ||
|---|---|
| `key` | `Key`: The result field to read. <br /> |

| Returns ||
|---|---|
| `T` | The value of that key, or `null` if the field is not set. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the key was not valid |

### getKeys

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<Key<?>> getKeys ()
```

Returns a list of the keys contained in this map.

The list returned is not modifiable, so any attempts to modify it will throw
a `UnsupportedOperationException`.

All values retrieved by a key from this list with `#get` are guaranteed to be
non-`null`. Each key is only listed once in the list. The order of the keys
is undefined.

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key<?>>` | This value cannot be `null`. <br /> |

### getTag

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Object getTag ()
```

Retrieve the tag for this request, if any.

This tag is not used for anything by the camera device, but can be
used by an application to easily identify a CaptureRequest when it is
returned by
`https://developer.android.com/reference/android/hardware/camera2/CameraCaptureSession.CaptureCallback#onCaptureCompleted(android.hardware.camera2.CameraCaptureSession,%20android.hardware.camera2.CaptureRequest,%20android.hardware.camera2.TotalCaptureResult)`

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/Object` | the last tag Object set on this request, or `null` if no tag has been set. <br /> |

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Builder#setTag(java.lang.Object)`

### hashCode

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int hashCode ()
```

Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
`https://developer.android.com/reference/java/util/HashMap`.


The general contract of `hashCode` is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### isReprocess

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isReprocess ()
```

Determine if this is a reprocess capture request.

A reprocess capture request produces output images from an input buffer from the
`https://developer.android.com/reference/android/hardware/camera2/CameraCaptureSession`'s input `https://developer.android.com/reference/android/view/Surface`. A reprocess capture request can be
created by `https://developer.android.com/reference/android/hardware/camera2/CameraDevice#createReprocessCaptureRequest(android.hardware.camera2.TotalCaptureResult)`.

<br />

<br />

| Returns ||
|---|---|
| `boolean` | `true` if this is a reprocess capture request. `false` if this is not a reprocess capture request. <br /> |

**See also:**

- `https://developer.android.com/reference/android/hardware/camera2/CameraDevice#createReprocessCaptureRequest(android.hardware.camera2.TotalCaptureResult)`

### writeToParcel

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |

## Protected methods

### finalize

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected void finalize ()
```

Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
A subclass overrides the `finalize` method to dispose of
system resources or to perform other cleanup.


The general contract of `finalize` is that it is invoked
if and when the Java virtual
machine has determined that there is no longer any
means by which this object can be accessed by any thread that has
not yet died, except as a result of an action taken by the
finalization of some other object or class which is ready to be
finalized. The `finalize` method may take any action, including
making this object available again to other threads; the usual purpose
of `finalize`, however, is to perform cleanup actions before
the object is irrevocably discarded. For example, the finalize method
for an object that represents an input/output connection might perform
explicit I/O transactions to break the connection before the object is
permanently discarded.


The `finalize` method of class `Object` performs no
special action; it simply returns normally. Subclasses of
`Object` may override this definition.


The Java programming language does not guarantee which thread will
invoke the `finalize` method for any given object. It is
guaranteed, however, that the thread that invokes finalize will not
be holding any user-visible synchronization locks when finalize is
invoked. If an uncaught exception is thrown by the finalize method,
the exception is ignored and finalization of that object terminates.


After the `finalize` method has been invoked for an object, no
further action is taken until the Java virtual machine has again
determined that there is no longer any means by which this object can
be accessed by any thread that has not yet died, including possible
actions by other objects or classes which are ready to be finalized,
at which point the object may be discarded.


The `finalize` method is never invoked more than once by a Java
virtual machine for any given object.


Any exception thrown by the `finalize` method causes
the finalization of this object to be halted, but is otherwise
ignored.

<br />