Added in API level 21

CaptureRequest

Kotlin |Java

public final class CaptureRequest
extends CameraMetadata<Key<?>> implements Parcelable

java.lang.Object
↳	android.hardware.camera2.CameraMetadata<android.hardware.camera2.CaptureRequest.Key<?>>
	↳	android.hardware.camera2.CaptureRequest

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 Builder instance, obtained by calling CameraDevice.createCaptureRequest or CameraDevice.CameraDeviceSetup.createCaptureRequest

CaptureRequests are given to CameraCaptureSession.capture or CameraCaptureSession.setRepeatingRequest 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 CameraDevice.createCaptureSession, 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 CameraDevice.createReprocessCaptureRequest, and used with a reprocessable capture session created with CameraDevice.createReprocessableCaptureSession.

See also:

Summary

Nested classes
`class`	`CaptureRequest.Builder` A builder for capture requests.
`class`	`CaptureRequest.Key<T>` A `Key` is used to do capture request field lookups with `CaptureRequest.get` or to set fields with `CaptureRequest.Builder.set(Key,Object)`.

Inherited constants

From class android.hardware.camera2.CameraMetadata

`int`	`AUTOMOTIVE_LENS_FACING_EXTERIOR_FRONT` The camera device faces the front of the vehicle body frame.
`int`	`AUTOMOTIVE_LENS_FACING_EXTERIOR_LEFT` The camera device faces the left side of the vehicle body frame.
`int`	`AUTOMOTIVE_LENS_FACING_EXTERIOR_OTHER` The camera device faces the outside of the vehicle body frame but not exactly one of the exterior sides defined by this enum.
`int`	`AUTOMOTIVE_LENS_FACING_EXTERIOR_REAR` The camera device faces the rear of the vehicle body frame.
`int`	`AUTOMOTIVE_LENS_FACING_EXTERIOR_RIGHT` The camera device faces the right side of the vehicle body frame.
`int`	`AUTOMOTIVE_LENS_FACING_INTERIOR_OTHER` The camera device faces the inside of the vehicle body frame but not exactly one of seats described by this enum.
`int`	`AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_CENTER` The camera device faces the center seat of the first row.
`int`	`AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_LEFT` The camera device faces the left side seat of the first row.
`int`	`AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_RIGHT` The camera device faces the right seat of the first row.
`int`	`AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_CENTER` The camera device faces the center seat of the second row.
`int`	`AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_LEFT` The camera device faces the left side seat of the second row.
`int`	`AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_RIGHT` The camera device faces the right side seat of the second row.
`int`	`AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_CENTER` The camera device faces the center seat of the third row.
`int`	`AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_LEFT` The camera device faces the left side seat of the third row.
`int`	`AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_RIGHT` The camera device faces the right seat of the third row.
`int`	`AUTOMOTIVE_LOCATION_EXTERIOR_FRONT` The camera device exists outside of the vehicle body frame and on its front side.
`int`	`AUTOMOTIVE_LOCATION_EXTERIOR_LEFT` The camera device exists outside and on left side of the vehicle body frame.
`int`	`AUTOMOTIVE_LOCATION_EXTERIOR_OTHER` The camera exists outside of the vehicle body frame but not exactly on one of the exterior locations this enum defines.
`int`	`AUTOMOTIVE_LOCATION_EXTERIOR_REAR` The camera device exists outside of the vehicle body frame and on its rear side.
`int`	`AUTOMOTIVE_LOCATION_EXTERIOR_RIGHT` The camera device exists outside and on right side of the vehicle body frame.
`int`	`AUTOMOTIVE_LOCATION_EXTRA_FRONT` The camera device exists outside of the extra vehicle's body frame and on its front side.
`int`	`AUTOMOTIVE_LOCATION_EXTRA_LEFT` The camera device exists outside and on left side of the extra vehicle body.
`int`	`AUTOMOTIVE_LOCATION_EXTRA_OTHER` 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`	`AUTOMOTIVE_LOCATION_EXTRA_REAR` The camera device exists outside of the extra vehicle's body frame and on its rear side.
`int`	`AUTOMOTIVE_LOCATION_EXTRA_RIGHT` The camera device exists outside and on right side of the extra vehicle body.
`int`	`AUTOMOTIVE_LOCATION_INTERIOR` The camera device exists inside of the vehicle cabin.
`int`	`COLOR_CORRECTION_ABERRATION_MODE_FAST` Aberration correction will not slow down capture rate relative to sensor raw output.
`int`	`COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY` Aberration correction operates at improved quality but the capture rate might be reduced (relative to sensor raw output rate)
`int`	`COLOR_CORRECTION_ABERRATION_MODE_OFF` No aberration correction is applied.
`int`	`COLOR_CORRECTION_MODE_CCT` Use `android.colorCorrection.colorTemperature` and `android.colorCorrection.colorTint` to adjust the white balance based on correlated color temperature.
`int`	`COLOR_CORRECTION_MODE_FAST` Color correction processing must not slow down capture rate relative to sensor raw output.
`int`	`COLOR_CORRECTION_MODE_HIGH_QUALITY` 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`	`COLOR_CORRECTION_MODE_TRANSFORM_MATRIX` Use the `android.colorCorrection.transform` matrix and `android.colorCorrection.gains` to do color conversion.
`int`	`CONTROL_AE_ANTIBANDING_MODE_50HZ` The camera device will adjust exposure duration to avoid banding problems with 50Hz illumination sources.
`int`	`CONTROL_AE_ANTIBANDING_MODE_60HZ` The camera device will adjust exposure duration to avoid banding problems with 60Hz illumination sources.
`int`	`CONTROL_AE_ANTIBANDING_MODE_AUTO` The camera device will automatically adapt its antibanding routine to the current illumination condition.
`int`	`CONTROL_AE_ANTIBANDING_MODE_OFF` The camera device will not adjust exposure duration to avoid banding problems.
`int`	`CONTROL_AE_MODE_OFF` The camera device's autoexposure routine is disabled.
`int`	`CONTROL_AE_MODE_ON` The camera device's autoexposure routine is active, with no flash control.
`int`	`CONTROL_AE_MODE_ON_ALWAYS_FLASH` Like ON, except that the camera device also controls the camera's flash unit, always firing it for still captures.
`int`	`CONTROL_AE_MODE_ON_AUTO_FLASH` Like ON, except that the camera device also controls the camera's flash unit, firing it in low-light conditions.
`int`	`CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE` Like ON_AUTO_FLASH, but with automatic red eye reduction.
`int`	`CONTROL_AE_MODE_ON_EXTERNAL_FLASH` An external flash has been turned on.
`int`	`CONTROL_AE_MODE_ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY` Like 'ON' but applies additional brightness boost in low light scenes.
`int`	`CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL` The camera device will cancel any currently active or completed precapture metering sequence, the auto-exposure routine will return to its initial state.
`int`	`CONTROL_AE_PRECAPTURE_TRIGGER_IDLE` The trigger is idle.
`int`	`CONTROL_AE_PRECAPTURE_TRIGGER_START` The precapture metering sequence will be started by the camera device.
`int`	`CONTROL_AE_PRIORITY_MODE_OFF` Disable AE priority mode.
`int`	`CONTROL_AE_PRIORITY_MODE_SENSOR_EXPOSURE_TIME_PRIORITY` The camera device's auto-exposure routine is active and prioritizes the application-selected exposure time (`android.sensor.exposureTime`).
`int`	`CONTROL_AE_PRIORITY_MODE_SENSOR_SENSITIVITY_PRIORITY` The camera device's auto-exposure routine is active and prioritizes the application-selected ISO (`android.sensor.sensitivity`).
`int`	`CONTROL_AE_STATE_CONVERGED` AE has a good set of control values for the current scene.
`int`	`CONTROL_AE_STATE_FLASH_REQUIRED` AE has a good set of control values, but flash needs to be fired for good quality still capture.
`int`	`CONTROL_AE_STATE_INACTIVE` AE is off or recently reset.
`int`	`CONTROL_AE_STATE_LOCKED` AE has been locked.
`int`	`CONTROL_AE_STATE_PRECAPTURE` AE has been asked to do a precapture sequence and is currently executing it.
`int`	`CONTROL_AE_STATE_SEARCHING` AE doesn't yet have a good set of control values for the current scene.
`int`	`CONTROL_AF_MODE_AUTO` Basic automatic focus mode.
`int`	`CONTROL_AF_MODE_CONTINUOUS_PICTURE` In this mode, the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream.
`int`	`CONTROL_AF_MODE_CONTINUOUS_VIDEO` In this mode, the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream.
`int`	`CONTROL_AF_MODE_EDOF` Extended depth of field (digital focus) mode.
`int`	`CONTROL_AF_MODE_MACRO` Close-up focusing mode.
`int`	`CONTROL_AF_MODE_OFF` The auto-focus routine does not control the lens; `android.lens.focusDistance` is controlled by the application.
`int`	`CONTROL_AF_SCENE_CHANGE_DETECTED` Scene change is detected within the AF region(s).
`int`	`CONTROL_AF_SCENE_CHANGE_NOT_DETECTED` Scene change is not detected within the AF region(s).
`int`	`CONTROL_AF_STATE_ACTIVE_SCAN` AF is performing an AF scan because it was triggered by AF trigger.
`int`	`CONTROL_AF_STATE_FOCUSED_LOCKED` AF believes it is focused correctly and has locked focus.
`int`	`CONTROL_AF_STATE_INACTIVE` AF is off or has not yet tried to scan/been asked to scan.
`int`	`CONTROL_AF_STATE_NOT_FOCUSED_LOCKED` AF has failed to focus successfully and has locked focus.
`int`	`CONTROL_AF_STATE_PASSIVE_FOCUSED` AF currently believes it is in focus, but may restart scanning at any time.
`int`	`CONTROL_AF_STATE_PASSIVE_SCAN` AF is currently performing an AF scan initiated the camera device in a continuous autofocus mode.
`int`	`CONTROL_AF_STATE_PASSIVE_UNFOCUSED` AF finished a passive scan without finding focus, and may restart scanning at any time.
`int`	`CONTROL_AF_TRIGGER_CANCEL` Autofocus will return to its initial state, and cancel any currently active trigger.
`int`	`CONTROL_AF_TRIGGER_IDLE` The trigger is idle.
`int`	`CONTROL_AF_TRIGGER_START` Autofocus will trigger now.
`int`	`CONTROL_AUTOFRAMING_OFF` Disable autoframing.
`int`	`CONTROL_AUTOFRAMING_ON` Enable autoframing to keep people in the frame's field of view.
`int`	`CONTROL_AUTOFRAMING_STATE_CONVERGED` Auto-framing has reached a stable state (frame/fov is not being adjusted).
`int`	`CONTROL_AUTOFRAMING_STATE_FRAMING` Auto-framing is in process - either zooming in, zooming out or pan is taking place.
`int`	`CONTROL_AUTOFRAMING_STATE_INACTIVE` Auto-framing is inactive.
`int`	`CONTROL_AWB_MODE_AUTO` The camera device's auto-white balance routine is active.
`int`	`CONTROL_AWB_MODE_CLOUDY_DAYLIGHT` The camera device's auto-white balance routine is disabled; the camera device uses cloudy daylight light as the assumed scene illumination for white balance.
`int`	`CONTROL_AWB_MODE_DAYLIGHT` The camera device's auto-white balance routine is disabled; the camera device uses daylight light as the assumed scene illumination for white balance.
`int`	`CONTROL_AWB_MODE_FLUORESCENT` The camera device's auto-white balance routine is disabled; the camera device uses fluorescent light as the assumed scene illumination for white balance.
`int`	`CONTROL_AWB_MODE_INCANDESCENT` The camera device's auto-white balance routine is disabled; the camera device uses incandescent light as the assumed scene illumination for white balance.
`int`	`CONTROL_AWB_MODE_OFF` The camera device's auto-white balance routine is disabled.
`int`	`CONTROL_AWB_MODE_SHADE` The camera device's auto-white balance routine is disabled; the camera device uses shade light as the assumed scene illumination for white balance.
`int`	`CONTROL_AWB_MODE_TWILIGHT` The camera device's auto-white balance routine is disabled; the camera device uses twilight light as the assumed scene illumination for white balance.
`int`	`CONTROL_AWB_MODE_WARM_FLUORESCENT` The camera device's auto-white balance routine is disabled; the camera device uses warm fluorescent light as the assumed scene illumination for white balance.
`int`	`CONTROL_AWB_STATE_CONVERGED` AWB has a good set of control values for the current scene.
`int`	`CONTROL_AWB_STATE_INACTIVE` AWB is not in auto mode, or has not yet started metering.
`int`	`CONTROL_AWB_STATE_LOCKED` AWB has been locked.
`int`	`CONTROL_AWB_STATE_SEARCHING` AWB doesn't yet have a good set of control values for the current scene.
`int`	`CONTROL_CAPTURE_INTENT_CUSTOM` The goal of this request doesn't fall into the other categories.
`int`	`CONTROL_CAPTURE_INTENT_MANUAL` This request is for manual capture use case where the applications want to directly control the capture parameters.
`int`	`CONTROL_CAPTURE_INTENT_MOTION_TRACKING` 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`	`CONTROL_CAPTURE_INTENT_PREVIEW` This request is for a preview-like use case.
`int`	`CONTROL_CAPTURE_INTENT_STILL_CAPTURE` This request is for a still capture-type use case.
`int`	`CONTROL_CAPTURE_INTENT_VIDEO_RECORD` This request is for a video recording use case.
`int`	`CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT` This request is for a video snapshot (still image while recording video) use case.
`int`	`CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG` This request is for a ZSL usecase; the application will stream full-resolution images and reprocess one or several later for a final capture.
`int`	`CONTROL_EFFECT_MODE_AQUA` An "aqua" effect where a blue hue is added to the image.
`int`	`CONTROL_EFFECT_MODE_BLACKBOARD` A "blackboard" effect where the image is typically displayed as regions of black, with white or grey details.
`int`	`CONTROL_EFFECT_MODE_MONO` A "monocolor" effect where the image is mapped into a single color.
`int`	`CONTROL_EFFECT_MODE_NEGATIVE` A "photo-negative" effect where the image's colors are inverted.
`int`	`CONTROL_EFFECT_MODE_OFF` No color effect will be applied.
`int`	`CONTROL_EFFECT_MODE_POSTERIZE` A "posterization" effect where the image uses discrete regions of tone rather than a continuous gradient of tones.
`int`	`CONTROL_EFFECT_MODE_SEPIA` A "sepia" effect where the image is mapped into warm gray, red, and brown tones.
`int`	`CONTROL_EFFECT_MODE_SOLARIZE` A "solarisation" effect (Sabattier effect) where the image is wholly or partially reversed in tone.
`int`	`CONTROL_EFFECT_MODE_WHITEBOARD` A "whiteboard" effect where the image is typically displayed as regions of white, with black or grey details.
`int`	`CONTROL_EXTENDED_SCENE_MODE_BOKEH_CONTINUOUS` 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`	`CONTROL_EXTENDED_SCENE_MODE_BOKEH_STILL_CAPTURE` High quality bokeh mode is enabled for all non-raw streams (including YUV, JPEG, and IMPLEMENTATION_DEFINED) when capture intent is STILL_CAPTURE.
`int`	`CONTROL_EXTENDED_SCENE_MODE_DISABLED` Extended scene mode is disabled.
`int`	`CONTROL_LOW_LIGHT_BOOST_STATE_ACTIVE` The AE mode 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY' is enabled and applied.
`int`	`CONTROL_LOW_LIGHT_BOOST_STATE_INACTIVE` The AE mode 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY' is enabled but not applied.
`int`	`CONTROL_MODE_AUTO` Use settings for each individual 3A routine.
`int`	`CONTROL_MODE_OFF` Full application control of pipeline.
`int`	`CONTROL_MODE_OFF_KEEP_STATE` Same as OFF mode, except that this capture will not be used by camera device background auto-exposure, auto-white balance and auto-focus algorithms (3A) to update their statistics.
`int`	`CONTROL_MODE_USE_EXTENDED_SCENE_MODE` Use a specific extended scene mode.
`int`	`CONTROL_MODE_USE_SCENE_MODE` Use a specific scene mode.
`int`	`CONTROL_SCENE_MODE_ACTION` Optimized for photos of quickly moving objects.
`int`	`CONTROL_SCENE_MODE_BARCODE` Optimized for accurately capturing a photo of barcode for use by camera applications that wish to read the barcode value.

CaptureRequest

Summary

Nested classes

Inherited constants