CameraMetadata


public abstract class CameraMetadata
extends Object

java.lang.Object
   ↳ android.hardware.camera2.CameraMetadata<TKey>


The base class for camera controls and information.

This class defines the basic key/value map used for querying for camera characteristics or capture results, and for setting camera request parameters.

All instances of CameraMetadata are immutable. Beginning with API level 32, the list of keys returned by getKeys() may change depending on the state of the device, as may the values returned by any key with #get throughout the lifetime of the object. For information on whether a specific value is fixed, see the documentation for its key.

Summary

Constants

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.

int CONTROL_SCENE_MODE_BEACH

Optimized for bright, outdoor beach settings.

int CONTROL_SCENE_MODE_CANDLELIGHT

Optimized for dim settings where the main light source is a candle.

int CONTROL_SCENE_MODE_DISABLED

Indicates that no scene modes are set for a given capture request.

int CONTROL_SCENE_MODE_FACE_PRIORITY

If face detection support exists, use face detection data for auto-focus, auto-white balance, and auto-exposure routines.

int CONTROL_SCENE_MODE_FIREWORKS

Optimized for nighttime photos of fireworks.

int CONTROL_SCENE_MODE_HDR

Turn on a device-specific high dynamic range (HDR) mode.

int 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 CONTROL_SCENE_MODE_LANDSCAPE

Optimized for photos of distant macroscopic objects.

int CONTROL_SCENE_MODE_NIGHT

Optimized for low-light settings.

int CONTROL_SCENE_MODE_NIGHT_PORTRAIT

Optimized for still photos of people in low-light settings.

int CONTROL_SCENE_MODE_PARTY

Optimized for dim, indoor settings with multiple moving people.

int CONTROL_SCENE_MODE_PORTRAIT

Optimized for still photos of people.

int CONTROL_SCENE_MODE_SNOW

Optimized for bright, outdoor settings containing snow.

int CONTROL_SCENE_MODE_SPORTS

Optimized for photos of quickly moving people.

int CONTROL_SCENE_MODE_STEADYPHOTO

Optimized to avoid blurry photos due to small amounts of device motion (for example: due to hand shake).

int CONTROL_SCENE_MODE_SUNSET

Optimized for scenes of the setting sun.

int CONTROL_SCENE_MODE_THEATRE

Optimized for dim, indoor settings where flash must remain off.

int CONTROL_SETTINGS_OVERRIDE_OFF

No keys are applied sooner than the other keys when applying CaptureRequest settings to the camera device.

int CONTROL_SETTINGS_OVERRIDE_ZOOM

Zoom related keys are applied sooner than the other keys in the CaptureRequest.

int CONTROL_VIDEO_STABILIZATION_MODE_OFF

Video stabilization is disabled.

int CONTROL_VIDEO_STABILIZATION_MODE_ON

Video stabilization is enabled.

int CONTROL_VIDEO_STABILIZATION_MODE_PREVIEW_STABILIZATION

Preview stabilization, where the preview in addition to all other non-RAW streams are stabilized with the same quality of stabilization, is enabled.

int CONTROL_ZOOM_METHOD_AUTO

The camera device automatically detects whether the application does zoom with android.scaler.cropRegion or android.control.zoomRatio, and in turn decides which metadata tag reflects the effective zoom level.

int CONTROL_ZOOM_METHOD_ZOOM_RATIO

The application intends to control zoom via android.control.zoomRatio, and the effective zoom level is reflected by android.control.zoomRatio in capture results.

int DISTORTION_CORRECTION_MODE_FAST

Lens distortion correction is applied without reducing frame rate relative to sensor output.

int DISTORTION_CORRECTION_MODE_HIGH_QUALITY

High-quality distortion correction is applied, at the cost of possibly reduced frame rate relative to sensor output.

int DISTORTION_CORRECTION_MODE_OFF

No distortion correction is applied.

int EDGE_MODE_FAST

Apply edge enhancement at a quality level that does not slow down frame rate relative to sensor output.

int EDGE_MODE_HIGH_QUALITY

Apply high-quality edge enhancement, at a cost of possibly reduced output frame rate.

int EDGE_MODE_OFF

No edge enhancement is applied.

int EDGE_MODE_ZERO_SHUTTER_LAG

Edge enhancement is applied at different levels for different output streams, based on resolution.

int EXTENSION_NIGHT_MODE_INDICATOR_OFF

The camera has detected lighting conditions that are sufficiently bright.

int EXTENSION_NIGHT_MODE_INDICATOR_ON

The camera has detected low-light conditions.

int EXTENSION_NIGHT_MODE_INDICATOR_UNKNOWN

The camera can't accurately assess the scene's lighting to determine if a Night Mode Camera Extension capture would improve the photo.

int FLASH_MODE_OFF

Do not fire the flash for this capture.

int FLASH_MODE_SINGLE

If the flash is available and charged, fire flash for this capture.

int FLASH_MODE_TORCH

Transition flash to continuously on.

int FLASH_STATE_CHARGING

Flash is charging and cannot be fired.

int FLASH_STATE_FIRED

Flash fired for this capture.

int FLASH_STATE_PARTIAL

Flash partially illuminated this frame.

int FLASH_STATE_READY

Flash is ready to fire.

int FLASH_STATE_UNAVAILABLE

No flash on camera.

int HOT_PIXEL_MODE_FAST

Hot pixel correction is applied, without reducing frame rate relative to sensor raw output.

int HOT_PIXEL_MODE_HIGH_QUALITY

High-quality hot pixel correction is applied, at a cost of possibly reduced frame rate relative to sensor raw output.

int HOT_PIXEL_MODE_OFF

No hot pixel correction is applied.

int INFO_DEVICE_TYPE_BUILT_IN

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 INFO_DEVICE_TYPE_EXTERNAL

This camera device is not permanently connected to this Android device.

int INFO_DEVICE_TYPE_UNKNOWN

This camera device has an unknown classification.

int INFO_DEVICE_TYPE_VIRTUAL

This camera device produces purely virtual images, though they may be based on the output of a real hardware camera in some cases.

int INFO_SUPPORTED_HARDWARE_LEVEL_3

This camera device is capable of YUV reprocessing and RAW data capture, in addition to FULL-level capabilities.

int INFO_SUPPORTED_HARDWARE_LEVEL_EXTERNAL

This camera device is backed by an external camera connected to this Android device.

int INFO_SUPPORTED_HARDWARE_LEVEL_FULL

This camera device is capable of supporting advanced imaging applications.

int INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY

This camera device is running in backward compatibility mode.

int INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED

This camera device does not have enough capabilities to qualify as a FULL device or better.

int LENS_FACING_BACK

The camera device faces the opposite direction as the device's screen.

int LENS_FACING_EXTERNAL

The camera device is an external camera, and has no fixed facing relative to the device's screen.

int LENS_FACING_FRONT

The camera device faces the same direction as the device's screen.

int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_APPROXIMATE

The lens focus distance is measured in diopters.

int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_CALIBRATED

The lens focus distance is measured in diopters, and is calibrated.

int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_UNCALIBRATED

The lens focus distance is not accurate, and the units used for android.lens.focusDistance do not correspond to any physical units.

int LENS_OPTICAL_STABILIZATION_MODE_OFF

Optical stabilization is unavailable.

int LENS_OPTICAL_STABILIZATION_MODE_ON

Optical stabilization is enabled.

int LENS_POSE_REFERENCE_AUTOMOTIVE

The value of android.lens.poseTranslation is relative to the origin of the automotive sensor coordinate system, which is at the center of the rear axle.

int LENS_POSE_REFERENCE_GYROSCOPE

The value of android.lens.poseTranslation is relative to the position of the primary gyroscope of this Android device.

int LENS_POSE_REFERENCE_PRIMARY_CAMERA

The value of android.lens.poseTranslation is relative to the optical center of the largest camera device facing the same direction as this camera.

int LENS_POSE_REFERENCE_UNDEFINED

The camera device cannot represent the values of android.lens.poseTranslation and android.lens.poseRotation accurately enough.

int LENS_STATE_MOVING

One or several of the lens parameters (android.lens.focalLength, android.lens.focusDistance, android.lens.filterDensity or android.lens.aperture) is currently changing.

int LENS_STATE_STATIONARY

The lens parameters (android.lens.focalLength, android.lens.focusDistance, android.lens.filterDensity and android.lens.aperture) are not changing.

int LOGICAL_MULTI_CAMERA_SENSOR_SYNC_TYPE_APPROXIMATE

A software mechanism is used to synchronize between the physical cameras.

int LOGICAL_MULTI_CAMERA_SENSOR_SYNC_TYPE_CALIBRATED

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 NOISE_REDUCTION_MODE_FAST

Noise reduction is applied without reducing frame rate relative to sensor output.

int NOISE_REDUCTION_MODE_HIGH_QUALITY

High-quality noise reduction is applied, at the cost of possibly reduced frame rate relative to sensor output.

int NOISE_REDUCTION_MODE_MINIMAL

MINIMAL noise reduction is applied without reducing frame rate relative to sensor output.

int NOISE_REDUCTION_MODE_OFF

No noise reduction is applied.

int NOISE_REDUCTION_MODE_ZERO_SHUTTER_LAG

Noise reduction is applied at different levels for different output streams, based on resolution.

int REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE

The minimal set of capabilities that every camera device (regardless of android.info.supportedHardwareLevel) supports.

int REQUEST_AVAILABLE_CAPABILITIES_BURST_CAPTURE

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 REQUEST_AVAILABLE_CAPABILITIES_COLOR_SPACE_PROFILES

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 SessionConfiguration.setColorSpace(Named).

int REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO

The device supports constrained high speed video recording (frame rate >=120fps) use case.

int REQUEST_AVAILABLE_CAPABILITIES_DEPTH_OUTPUT

The camera device can produce depth measurements from its field of view.

int REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT

The device supports one or more 10-bit camera outputs according to the dynamic range profiles specified in DynamicRangeProfiles.getSupportedProfiles().

int REQUEST_AVAILABLE_CAPABILITIES_LOGICAL_MULTI_CAMERA

The camera device is a logical camera backed by two or more physical cameras.

int REQUEST_AVAILABLE_CAPABILITIES_MANUAL_POST_PROCESSING

The camera device post-processing stages can be manually controlled.

int REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR

The camera device can be manually controlled (3A algorithms such as auto-exposure, and auto-focus can be bypassed).

int REQUEST_AVAILABLE_CAPABILITIES_MONOCHROME

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 REQUEST_AVAILABLE_CAPABILITIES_MOTION_TRACKING

The camera device supports the MOTION_TRACKING value for android.control.captureIntent, which limits maximum exposure time to 20 ms.

int REQUEST_AVAILABLE_CAPABILITIES_OFFLINE_PROCESSING

The camera device supports the OFFLINE_PROCESSING use case.

int REQUEST_AVAILABLE_CAPABILITIES_PRIVATE_REPROCESSING

The camera device supports the Zero Shutter Lag reprocessing use case.

int REQUEST_AVAILABLE_CAPABILITIES_RAW

The camera device supports outputting RAW buffers and metadata for interpreting them.

int REQUEST_AVAILABLE_CAPABILITIES_READ_SENSOR_SETTINGS

The camera device supports accurately reporting the sensor settings for many of the sensor controls while the built-in 3A algorithm is running.

int REQUEST_AVAILABLE_CAPABILITIES_REMOSAIC_REPROCESSING

The device supports reprocessing from the RAW_SENSOR format with a bayer pattern given by android.sensor.info.binningFactor (m x n group of pixels with the same color filter) to a remosaiced regular bayer pattern.

int REQUEST_AVAILABLE_CAPABILITIES_SECURE_IMAGE_DATA

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 REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE

The camera device supports selecting a per-stream use case via 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 REQUEST_AVAILABLE_CAPABILITIES_SYSTEM_CAMERA

The camera device is only accessible by Android's system components and privileged applications.

int REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR

This camera device is capable of producing ultra high resolution images in addition to the image sizes described in the android.scaler.streamConfigurationMap.

int REQUEST_AVAILABLE_CAPABILITIES_YUV_REPROCESSING

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:

int SCALER_AVAILABLE_STREAM_USE_CASES_CROPPED_RAW

Cropped RAW stream when the client chooses to crop the field of view.

int SCALER_AVAILABLE_STREAM_USE_CASES_DEFAULT

Default stream use case.

int SCALER_AVAILABLE_STREAM_USE_CASES_PREVIEW

Live stream shown to the user.

int SCALER_AVAILABLE_STREAM_USE_CASES_PREVIEW_VIDEO_STILL

One single stream used for combined purposes of preview, video, and still capture.

int SCALER_AVAILABLE_STREAM_USE_CASES_STILL_CAPTURE

Still photo capture.

int SCALER_AVAILABLE_STREAM_USE_CASES_VIDEO_CALL

Long-running video call optimized for both power efficiency and video quality.

int SCALER_AVAILABLE_STREAM_USE_CASES_VIDEO_RECORD

Recording video clips.

int SCALER_CROPPING_TYPE_CENTER_ONLY

The camera device only supports centered crop regions.

int SCALER_CROPPING_TYPE_FREEFORM

The camera device supports arbitrarily chosen crop regions.

int SCALER_ROTATE_AND_CROP_180

Processed images are rotated by 180 degrees.

int SCALER_ROTATE_AND_CROP_270

Processed images are rotated by 270 degrees clockwise, and then cropped to the original aspect ratio.

int SCALER_ROTATE_AND_CROP_90

Processed images are rotated by 90 degrees clockwise, and then cropped to the original aspect ratio.

int SCALER_ROTATE_AND_CROP_AUTO

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 SCALER_ROTATE_AND_CROP_NONE

No rotate and crop is applied.

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_BGGR

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GBRG

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GRBG

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_MONO

Sensor doesn't have any Bayer color filter.

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_NIR

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 SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGB

Sensor is not Bayer; output has 3 16-bit values for each pixel, instead of just 1 16-bit value per pixel.

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGGB

int SENSOR_INFO_TIMESTAMP_SOURCE_REALTIME

Timestamps from android.sensor.timestamp are in the same timebase as SystemClock.elapsedRealtimeNanos(), and they can be compared to other timestamps using that base.

int SENSOR_INFO_TIMESTAMP_SOURCE_UNKNOWN

Timestamps from android.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 SENSOR_PIXEL_MODE_DEFAULT

This is the default sensor pixel mode.

int SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION

In this mode, sensors typically do not bin pixels, as a result can offer larger image sizes.

int SENSOR_READOUT_TIMESTAMP_HARDWARE

This camera device supports the onReadoutStarted callback as well as outputting readout timestamps.

int SENSOR_READOUT_TIMESTAMP_NOT_SUPPORTED

This camera device doesn't support readout timestamp and onReadoutStarted callback.

int SENSOR_REFERENCE_ILLUMINANT1_CLOUDY_WEATHER

int SENSOR_REFERENCE_ILLUMINANT1_COOL_WHITE_FLUORESCENT

W 3900 - 4500K

int SENSOR_REFERENCE_ILLUMINANT1_D50

int SENSOR_REFERENCE_ILLUMINANT1_D55

int SENSOR_REFERENCE_ILLUMINANT1_D65

int SENSOR_REFERENCE_ILLUMINANT1_D75

int SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT

int SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT_FLUORESCENT

D 5700 - 7100K

int SENSOR_REFERENCE_ILLUMINANT1_DAY_WHITE_FLUORESCENT

N 4600 - 5400K

int SENSOR_REFERENCE_ILLUMINANT1_FINE_WEATHER

int SENSOR_REFERENCE_ILLUMINANT1_FLASH

int SENSOR_REFERENCE_ILLUMINANT1_FLUORESCENT

int SENSOR_REFERENCE_ILLUMINANT1_ISO_STUDIO_TUNGSTEN

int SENSOR_REFERENCE_ILLUMINANT1_SHADE

int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_A

int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_B

int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_C

int SENSOR_REFERENCE_ILLUMINANT1_TUNGSTEN

Incandescent light

int SENSOR_REFERENCE_ILLUMINANT1_WHITE_FLUORESCENT

WW 3200 - 3700K

int SENSOR_TEST_PATTERN_MODE_COLOR_BARS

All pixel data is replaced with an 8-bar color pattern.

int SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY

The test pattern is similar to COLOR_BARS, except that each bar should start at its specified color at the top, and fade to gray at the bottom.

int SENSOR_TEST_PATTERN_MODE_CUSTOM1

The first custom test pattern.

int SENSOR_TEST_PATTERN_MODE_OFF

No test pattern mode is used, and the camera device returns captures from the image sensor.

int SENSOR_TEST_PATTERN_MODE_PN9

All pixel data is replaced by a pseudo-random sequence generated from a PN9 512-bit sequence (typically implemented in hardware with a linear feedback shift register).

int SENSOR_TEST_PATTERN_MODE_SOLID_COLOR

Each pixel in [R, G_even, G_odd, B] is replaced by its respective color channel provided in android.sensor.testPatternData.

int SHADING_MODE_FAST

Apply lens shading corrections, without slowing frame rate relative to sensor raw output

int SHADING_MODE_HIGH_QUALITY

Apply high-quality lens shading correction, at the cost of possibly reduced frame rate.

int SHADING_MODE_OFF

No lens shading correction is applied.

int STATISTICS_FACE_DETECT_MODE_FULL

Return all face metadata.

int STATISTICS_FACE_DETECT_MODE_OFF

Do not include face detection statistics in capture results.

int STATISTICS_FACE_DETECT_MODE_SIMPLE

Return face rectangle and confidence values only.

int STATISTICS_LENS_SHADING_MAP_MODE_OFF

Do not include a lens shading map in the capture result.

int STATISTICS_LENS_SHADING_MAP_MODE_ON

Include a lens shading map in the capture result.

int STATISTICS_OIS_DATA_MODE_OFF

Do not include OIS data in the capture result.

int STATISTICS_OIS_DATA_MODE_ON

Include OIS data in the capture result.

int STATISTICS_SCENE_FLICKER_50HZ

The camera device detects illumination flickering at 50Hz in the current scene.

int STATISTICS_SCENE_FLICKER_60HZ

The camera device detects illumination flickering at 60Hz in the current scene.

int STATISTICS_SCENE_FLICKER_NONE

The camera device does not detect any flickering illumination in the current scene.

int SYNC_MAX_LATENCY_PER_FRAME_CONTROL

Every frame has the requests immediately applied.

int SYNC_MAX_LATENCY_UNKNOWN

Each new frame has some subset (potentially the entire set) of the past requests applied to the camera settings.

int TONEMAP_MODE_CONTRAST_CURVE

Use the tone mapping curve specified in the android.tonemap.curve* entries.

int TONEMAP_MODE_FAST

Advanced gamma mapping and color enhancement may be applied, without reducing frame rate compared to raw sensor output.

int TONEMAP_MODE_GAMMA_VALUE

Use the gamma value specified in android.tonemap.gamma to perform tonemapping.

int TONEMAP_MODE_HIGH_QUALITY

High-quality gamma mapping and color enhancement will be applied, at the cost of possibly reduced frame rate compared to raw sensor output.

int TONEMAP_MODE_PRESET_CURVE

Use the preset tonemapping curve specified in android.tonemap.presetCurve to perform tonemapping.

int TONEMAP_PRESET_CURVE_REC709

Tonemapping curve is defined by ITU-R BT.709

int TONEMAP_PRESET_CURVE_SRGB

Tonemapping curve is defined by sRGB

Public methods

List<TKey> getKeys()

Returns a list of the keys contained in this map.

Inherited methods

Constants

AUTOMOTIVE_LENS_FACING_EXTERIOR_FRONT

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_EXTERIOR_FRONT

The camera device faces the front of the vehicle body frame.

Constant Value: 1 (0x00000001)

AUTOMOTIVE_LENS_FACING_EXTERIOR_LEFT

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_EXTERIOR_LEFT

The camera device faces the left side of the vehicle body frame.

Constant Value: 3 (0x00000003)

AUTOMOTIVE_LENS_FACING_EXTERIOR_OTHER

Added in API level 33
public static final 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. Applications should determine the exact facing direction from android.lens.poseRotation and android.lens.poseTranslation.

Constant Value: 0 (0x00000000)

AUTOMOTIVE_LENS_FACING_EXTERIOR_REAR

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_EXTERIOR_REAR

The camera device faces the rear of the vehicle body frame.

Constant Value: 2 (0x00000002)

AUTOMOTIVE_LENS_FACING_EXTERIOR_RIGHT

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_EXTERIOR_RIGHT

The camera device faces the right side of the vehicle body frame.

Constant Value: 4 (0x00000004)

AUTOMOTIVE_LENS_FACING_INTERIOR_OTHER

Added in API level 33
public static final 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. Applications should determine the exact facing direction from android.lens.poseRotation and android.lens.poseTranslation.

Constant Value: 5 (0x00000005)

AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_CENTER

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_CENTER

The camera device faces the center seat of the first row.

Constant Value: 7 (0x00000007)

AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_LEFT

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_LEFT

The camera device faces the left side seat of the first row.

Constant Value: 6 (0x00000006)

AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_RIGHT

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_RIGHT

The camera device faces the right seat of the first row.

Constant Value: 8 (0x00000008)

AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_CENTER

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_CENTER

The camera device faces the center seat of the second row.

Constant Value: 10 (0x0000000a)

AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_LEFT

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_LEFT

The camera device faces the left side seat of the second row.

Constant Value: 9 (0x00000009)

AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_RIGHT

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_RIGHT

The camera device faces the right side seat of the second row.

Constant Value: 11 (0x0000000b)

AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_CENTER

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_CENTER

The camera device faces the center seat of the third row.

Constant Value: 13 (0x0000000d)

AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_LEFT

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_LEFT

The camera device faces the left side seat of the third row.

Constant Value: 12 (0x0000000c)

AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_RIGHT

Added in API level 33
public static final int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_RIGHT

The camera device faces the right seat of the third row.

Constant Value: 14 (0x0000000e)

AUTOMOTIVE_LOCATION_EXTERIOR_FRONT

Added in API level 33
public static final int AUTOMOTIVE_LOCATION_EXTERIOR_FRONT

The camera device exists outside of the vehicle body frame and on its front side.

Constant Value: 2 (0x00000002)

AUTOMOTIVE_LOCATION_EXTERIOR_LEFT

Added in API level 33
public static final int AUTOMOTIVE_LOCATION_EXTERIOR_LEFT

The camera device exists outside and on left side of the vehicle body frame.

Constant Value: 4 (0x00000004)

AUTOMOTIVE_LOCATION_EXTERIOR_OTHER

Added in API level 33
public static final 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. The applications should determine the exact location from android.lens.poseTranslation.

Constant Value: 1 (0x00000001)

AUTOMOTIVE_LOCATION_EXTERIOR_REAR

Added in API level 33
public static final int AUTOMOTIVE_LOCATION_EXTERIOR_REAR

The camera device exists outside of the vehicle body frame and on its rear side.

Constant Value: 3 (0x00000003)

AUTOMOTIVE_LOCATION_EXTERIOR_RIGHT

Added in API level 33
public static final int AUTOMOTIVE_LOCATION_EXTERIOR_RIGHT

The camera device exists outside and on right side of the vehicle body frame.

Constant Value: 5 (0x00000005)

AUTOMOTIVE_LOCATION_EXTRA_FRONT

Added in API level 33
public static final int AUTOMOTIVE_LOCATION_EXTRA_FRONT

The camera device exists outside of the extra vehicle's body frame and on its front side.

Constant Value: 7 (0x00000007)

AUTOMOTIVE_LOCATION_EXTRA_LEFT

Added in API level 33
public static final int AUTOMOTIVE_LOCATION_EXTRA_LEFT

The camera device exists outside and on left side of the extra vehicle body.

Constant Value: 9 (0x00000009)

AUTOMOTIVE_LOCATION_EXTRA_OTHER

Added in API level 33
public static final 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. Applications should determine the exact location from android.lens.poseTranslation.

Constant Value: 6 (0x00000006)

AUTOMOTIVE_LOCATION_EXTRA_REAR

Added in API level 33
public static final int AUTOMOTIVE_LOCATION_EXTRA_REAR

The camera device exists outside of the extra vehicle's body frame and on its rear side.

Constant Value: 8 (0x00000008)

AUTOMOTIVE_LOCATION_EXTRA_RIGHT

Added in API level 33
public static final int AUTOMOTIVE_LOCATION_EXTRA_RIGHT

The camera device exists outside and on right side of the extra vehicle body.

Constant Value: 10 (0x0000000a)

AUTOMOTIVE_LOCATION_INTERIOR

Added in API level 33
public static final int AUTOMOTIVE_LOCATION_INTERIOR

The camera device exists inside of the vehicle cabin.

Constant Value: 0 (0x00000000)

COLOR_CORRECTION_ABERRATION_MODE_FAST

Added in API level 21
public static final int COLOR_CORRECTION_ABERRATION_MODE_FAST

Aberration correction will not slow down capture rate relative to sensor raw output.

Constant Value: 1 (0x00000001)

COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY

Added in API level 21
public static final 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)

Constant Value: 2 (0x00000002)

COLOR_CORRECTION_ABERRATION_MODE_OFF

Added in API level 21
public static final int COLOR_CORRECTION_ABERRATION_MODE_OFF

No aberration correction is applied.

Constant Value: 0 (0x00000000)

COLOR_CORRECTION_MODE_CCT

Added in API level 36
public static final int COLOR_CORRECTION_MODE_CCT

Use android.colorCorrection.colorTemperature and android.colorCorrection.colorTint to adjust the white balance based on correlated color temperature.

If AWB is enabled with android.control.awbMode != OFF, then CCT is ignored.

Constant Value: 3 (0x00000003)

COLOR_CORRECTION_MODE_FAST

Added in API level 21
public static final int COLOR_CORRECTION_MODE_FAST

Color correction processing must not slow down capture rate relative to sensor raw output.

Advanced white balance adjustments above and beyond the specified white balance pipeline may be applied.

If AWB is enabled with android.control.awbMode != OFF, then the camera device uses the last frame's AWB values (or defaults if AWB has never been run).

Constant Value: 1 (0x00000001)

COLOR_CORRECTION_MODE_HIGH_QUALITY

Added in API level 21
public static final 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.

If AWB is enabled with android.control.awbMode != OFF, then the camera device uses the last frame's AWB values (or defaults if AWB has never been run).

Constant Value: 2 (0x00000002)

COLOR_CORRECTION_MODE_TRANSFORM_MATRIX

Added in API level 21
public static final int COLOR_CORRECTION_MODE_TRANSFORM_MATRIX

Use the android.colorCorrection.transform matrix and android.colorCorrection.gains to do color conversion.

All advanced white balance adjustments (not specified by our white balance pipeline) must be disabled.

If AWB is enabled with android.control.awbMode != OFF, then TRANSFORM_MATRIX is ignored. The camera device will override this value to either FAST or HIGH_QUALITY.

Constant Value: 0 (0x00000000)

CONTROL_AE_ANTIBANDING_MODE_50HZ

Added in API level 21
public static final int CONTROL_AE_ANTIBANDING_MODE_50HZ

The camera device will adjust exposure duration to avoid banding problems with 50Hz illumination sources.

Constant Value: 1 (0x00000001)

CONTROL_AE_ANTIBANDING_MODE_60HZ

Added in API level 21
public static final int CONTROL_AE_ANTIBANDING_MODE_60HZ

The camera device will adjust exposure duration to avoid banding problems with 60Hz illumination sources.

Constant Value: 2 (0x00000002)

CONTROL_AE_ANTIBANDING_MODE_AUTO

Added in API level 21
public static final int CONTROL_AE_ANTIBANDING_MODE_AUTO

The camera device will automatically adapt its antibanding routine to the current illumination condition. This is the default mode if AUTO is available on given camera device.

Constant Value: 3 (0x00000003)

CONTROL_AE_ANTIBANDING_MODE_OFF

Added in API level 21
public static final int CONTROL_AE_ANTIBANDING_MODE_OFF

The camera device will not adjust exposure duration to avoid banding problems.

Constant Value: 0 (0x00000000)

CONTROL_AE_MODE_OFF

Added in API level 21
public static final int CONTROL_AE_MODE_OFF

The camera device's autoexposure routine is disabled.

The application-selected android.sensor.exposureTime, android.sensor.sensitivity and android.sensor.frameDuration are used by the camera device, along with android.flash.* fields, if there's a flash unit for this camera device.

Note that auto-white balance (AWB) and auto-focus (AF) behavior is device dependent when AE is in OFF mode. To have consistent behavior across different devices, it is recommended to either set AWB and AF to OFF mode or lock AWB and AF before setting AE to OFF. See android.control.awbMode, android.control.afMode, android.control.awbLock, and android.control.afTrigger for more details.

LEGACY devices do not support the OFF mode and will override attempts to use this value to ON.

Constant Value: 0 (0x00000000)

CONTROL_AE_MODE_ON

Added in API level 21
public static final int CONTROL_AE_MODE_ON

The camera device's autoexposure routine is active, with no flash control.

The application's values for android.sensor.exposureTime, android.sensor.sensitivity, and android.sensor.frameDuration are ignored. The application has control over the various android.flash.* fields.

If the device supports manual flash strength control, i.e., if android.flash.singleStrengthMaxLevel and android.flash.torchStrengthMaxLevel are greater than 1, then the auto-exposure (AE) precapture metering sequence should be triggered for the configured flash mode and strength to avoid the image being incorrectly exposed at different android.flash.strengthLevel.

Constant Value: 1 (0x00000001)

CONTROL_AE_MODE_ON_ALWAYS_FLASH

Added in API level 21
public static final 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.

The flash may be fired during a precapture sequence (triggered by android.control.aePrecaptureTrigger) and will always be fired for captures for which the android.control.captureIntent field is set to STILL_CAPTURE.

It's important to wait for the precapture sequence to complete (i.e., android.control.aeState reaches FLASH_REQUIRED, CONVERGED, or LOCKED) Dbefore submitting a STILL_CAPTURE request. Otherwise, in low-light conditions, the image captures with flash fired won't have correct exposures.

Constant Value: 3 (0x00000003)

CONTROL_AE_MODE_ON_AUTO_FLASH

Added in API level 21
public static final 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.

The flash may be fired during a precapture sequence (triggered by android.control.aePrecaptureTrigger) and may be fired for captures for which the android.control.captureIntent field is set to STILL_CAPTURE.

It's important to wait for the precapture sequence to complete (i.e., android.control.aeState reaches FLASH_REQUIRED, CONVERGED, or LOCKED) before submitting a STILL_CAPTURE request. Otherwise, in low-light conditions, the image captures with flash fired won't have correct exposures.

Constant Value: 2 (0x00000002)

CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE

Added in API level 21
public static final int CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE

Like ON_AUTO_FLASH, but with automatic red eye reduction.

If deemed necessary by the camera device, a red eye reduction flash will fire during the precapture sequence.

Constant Value: 4 (0x00000004)

CONTROL_AE_MODE_ON_EXTERNAL_FLASH

Added in API level 28
public static final int CONTROL_AE_MODE_ON_EXTERNAL_FLASH

An external flash has been turned on.

It informs the camera device that an external flash has been turned on, and that metering (and continuous focus if active) should be quickly recalculated to account for the external flash. Otherwise, this mode acts like ON.

When the external flash is turned off, AE mode should be changed to one of the other available AE modes.

If the camera device supports AE external flash mode, android.control.aeState must be FLASH_REQUIRED after the camera device finishes AE scan and it's too dark without flash.

Constant Value: 5 (0x00000005)

CONTROL_AE_MODE_ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY

Added in API level 35
public static final int CONTROL_AE_MODE_ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY

Like 'ON' but applies additional brightness boost in low light scenes.

When the scene lighting conditions are within the range defined by android.control.lowLightBoostInfoLuminanceRange this mode will apply additional brightness boost.

This mode will automatically adjust the intensity of low light boost applied according to the scene lighting conditions. A darker scene will receive more boost while a brighter scene will receive less boost.

This mode can ignore the set target frame rate to allow more light to be captured which can result in choppier motion. The frame rate can extend to lower than the android.control.aeAvailableTargetFpsRanges but will not go below 10 FPS. This mode can also increase the sensor sensitivity gain which can result in increased luma and chroma noise. The sensor sensitivity gain can extend to higher values beyond android.sensor.info.sensitivityRange. This mode may also apply additional processing to recover details in dark and bright areas of the image,and noise reduction at high sensitivity gain settings to manage the trade-off between light sensitivity and capture noise.

This mode is restricted to two output surfaces. One output surface type can either be SurfaceView or TextureView. Another output surface type can either be MediaCodec or MediaRecorder. This mode cannot be used with a target FPS range higher than 30 FPS.

If the session configuration is not supported, the AE mode reported in the CaptureResult will be 'ON' instead of 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY'.

When this AE mode is enabled, the CaptureResult field android.control.lowLightBoostState will indicate when low light boost is 'ACTIVE' or 'INACTIVE'. By default android.control.lowLightBoostState will be 'INACTIVE'.

The low light boost is 'ACTIVE' once the scene lighting condition is less than the upper bound lux value defined by android.control.lowLightBoostInfoLuminanceRange. This mode will be 'INACTIVE' once the scene lighting condition is greater than the upper bound lux value defined by android.control.lowLightBoostInfoLuminanceRange.

Constant Value: 6 (0x00000006)

CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL

Added in API level 23
public static final 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.

Constant Value: 2 (0x00000002)

CONTROL_AE_PRECAPTURE_TRIGGER_IDLE

Added in API level 21
public static final int CONTROL_AE_PRECAPTURE_TRIGGER_IDLE

The trigger is idle.

Constant Value: 0 (0x00000000)

CONTROL_AE_PRECAPTURE_TRIGGER_START

Added in API level 21
public static final int CONTROL_AE_PRECAPTURE_TRIGGER_START

The precapture metering sequence will be started by the camera device.

The exact effect of the precapture trigger depends on the current AE mode and state.

Constant Value: 1 (0x00000001)

CONTROL_AE_PRIORITY_MODE_OFF

Added in API level 36
public static final int CONTROL_AE_PRIORITY_MODE_OFF

Disable AE priority mode. This is the default value.

Constant Value: 0 (0x00000000)

CONTROL_AE_PRIORITY_MODE_SENSOR_EXPOSURE_TIME_PRIORITY

Added in API level 36
public static final 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).

The application has control over android.sensor.exposureTime while the application's values for android.sensor.sensitivity and android.sensor.frameDuration are ignored.

Constant Value: 2 (0x00000002)

CONTROL_AE_PRIORITY_MODE_SENSOR_SENSITIVITY_PRIORITY

Added in API level 36
public static final 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).

The application has control over android.sensor.sensitivity while the application's values for android.sensor.exposureTime and android.sensor.frameDuration are ignored.

Constant Value: 1 (0x00000001)

CONTROL_AE_STATE_CONVERGED

Added in API level 21
public static final int CONTROL_AE_STATE_CONVERGED

AE has a good set of control values for the current scene.

Constant Value: 2 (0x00000002)

CONTROL_AE_STATE_FLASH_REQUIRED

Added in API level 21
public static final 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.

Constant Value: 4 (0x00000004)

CONTROL_AE_STATE_INACTIVE

Added in API level 21
public static final int CONTROL_AE_STATE_INACTIVE

AE is off or recently reset.

When a camera device is opened, it starts in this state. This is a transient state, the camera device may skip reporting this state in capture result.

Constant Value: 0 (0x00000000)

CONTROL_AE_STATE_LOCKED

Added in API level 21
public static final int CONTROL_AE_STATE_LOCKED

AE has been locked.

Constant Value: 3 (0x00000003)

CONTROL_AE_STATE_PRECAPTURE

Added in API level 21
public static final int CONTROL_AE_STATE_PRECAPTURE

AE has been asked to do a precapture sequence and is currently executing it.

Precapture can be triggered through setting android.control.aePrecaptureTrigger to START. Currently active and completed (if it causes camera device internal AE lock) precapture metering sequence can be canceled through setting android.control.aePrecaptureTrigger to CANCEL.

Once PRECAPTURE completes, AE will transition to CONVERGED or FLASH_REQUIRED as appropriate. This is a transient state, the camera device may skip reporting this state in capture result.

Constant Value: 5 (0x00000005)

CONTROL_AE_STATE_SEARCHING

Added in API level 21
public static final int CONTROL_AE_STATE_SEARCHING

AE doesn't yet have a good set of control values for the current scene.

This is a transient state, the camera device may skip reporting this state in capture result.

Constant Value: 1 (0x00000001)

CONTROL_AF_MODE_AUTO

Added in API level 21
public static final int CONTROL_AF_MODE_AUTO

Basic automatic focus mode.

In this mode, the lens does not move unless the autofocus trigger action is called. When that trigger is activated, AF will transition to ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or NOT_FOCUSED).

Always supported if lens is not fixed focus.

Use android.lens.info.minimumFocusDistance to determine if lens is fixed-focus.

Triggering AF_CANCEL resets the lens position to default, and sets the AF state to INACTIVE.

Constant Value: 1 (0x00000001)

CONTROL_AF_MODE_CONTINUOUS_PICTURE

Added in API level 21
public static final 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.

The focusing behavior should be suitable for still image capture; typically this means focusing as fast as possible. When the AF trigger is not involved, the AF algorithm should start in INACTIVE state, and then transition into PASSIVE_SCAN and PASSIVE_FOCUSED states as appropriate as it attempts to maintain focus. When the AF trigger is activated, the algorithm should finish its PASSIVE_SCAN if active, and then transition into AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the lens position until a cancel AF trigger is received.

When the AF cancel trigger is activated, the algorithm should transition back to INACTIVE and then act as if it has just been started.

Constant Value: 4 (0x00000004)

CONTROL_AF_MODE_CONTINUOUS_VIDEO

Added in API level 21
public static final 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.

The focusing behavior should be suitable for good quality video recording; typically this means slower focus movement and no overshoots. When the AF trigger is not involved, the AF algorithm should start in INACTIVE state, and then transition into PASSIVE_SCAN and PASSIVE_FOCUSED states as appropriate. When the AF trigger is activated, the algorithm should immediately transition into AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the lens position until a cancel AF trigger is received.

Once cancel is received, the algorithm should transition back to INACTIVE and resume passive scan. Note that this behavior is not identical to CONTINUOUS_PICTURE, since an ongoing PASSIVE_SCAN must immediately be canceled.

Constant Value: 3 (0x00000003)

CONTROL_AF_MODE_EDOF

Added in API level 21
public static final int CONTROL_AF_MODE_EDOF

Extended depth of field (digital focus) mode.

The camera device will produce images with an extended depth of field automatically; no special focusing operations need to be done before taking a picture.

AF triggers are ignored, and the AF state will always be INACTIVE.

Constant Value: 5 (0x00000005)

CONTROL_AF_MODE_MACRO

Added in API level 21
public static final int CONTROL_AF_MODE_MACRO

Close-up focusing mode.

In this mode, the lens does not move unless the autofocus trigger action is called. When that trigger is activated, AF will transition to ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or NOT_FOCUSED). This mode is optimized for focusing on objects very close to the camera.

When that trigger is activated, AF will transition to ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or NOT_FOCUSED). Triggering cancel AF resets the lens position to default, and sets the AF state to INACTIVE.

Constant Value: 2 (0x00000002)

CONTROL_AF_MODE_OFF

Added in API level 21
public static final int CONTROL_AF_MODE_OFF

The auto-focus routine does not control the lens; android.lens.focusDistance is controlled by the application.

Constant Value: 0 (0x00000000)

CONTROL_AF_SCENE_CHANGE_DETECTED

Added in API level 28
public static final int CONTROL_AF_SCENE_CHANGE_DETECTED

Scene change is detected within the AF region(s).

Constant Value: 1 (0x00000001)

CONTROL_AF_SCENE_CHANGE_NOT_DETECTED

Added in API level 28
public static final int CONTROL_AF_SCENE_CHANGE_NOT_DETECTED

Scene change is not detected within the AF region(s).

Constant Value: 0 (0x00000000)

CONTROL_AF_STATE_ACTIVE_SCAN

Added in API level 21
public static final int CONTROL_AF_STATE_ACTIVE_SCAN

AF is performing an AF scan because it was triggered by AF trigger.

Only used by AUTO or MACRO AF modes. This is a transient state, the camera device may skip reporting this state in capture result.

Constant Value: 3 (0x00000003)

CONTROL_AF_STATE_FOCUSED_LOCKED

Added in API level 21
public static final int CONTROL_AF_STATE_FOCUSED_LOCKED

AF believes it is focused correctly and has locked focus.

This state is reached only after an explicit START AF trigger has been sent (android.control.afTrigger), when good focus has been obtained.

The lens will remain stationary until the AF mode (android.control.afMode) is changed or a new AF trigger is sent to the camera device (android.control.afTrigger).

Constant Value: 4 (0x00000004)

CONTROL_AF_STATE_INACTIVE

Added in API level 21
public static final int CONTROL_AF_STATE_INACTIVE

AF is off or has not yet tried to scan/been asked to scan.

When a camera device is opened, it starts in this state. This is a transient state, the camera device may skip reporting this state in capture result.

Constant Value: 0 (0x00000000)

CONTROL_AF_STATE_NOT_FOCUSED_LOCKED

Added in API level 21
public static final int CONTROL_AF_STATE_NOT_FOCUSED_LOCKED

AF has failed to focus successfully and has locked focus.

This state is reached only after an explicit START AF trigger has been sent (android.control.afTrigger), when good focus cannot be obtained.

The lens will remain stationary until the AF mode (android.control.afMode) is changed or a new AF trigger is sent to the camera device (android.control.afTrigger).

Constant Value: 5 (0x00000005)

CONTROL_AF_STATE_PASSIVE_FOCUSED

Added in API level 21
public static final int CONTROL_AF_STATE_PASSIVE_FOCUSED

AF currently believes it is in focus, but may restart scanning at any time.

Only used by CONTINUOUS_* AF modes. This is a transient state, the camera device may skip reporting this state in capture result.

Constant Value: 2 (0x00000002)

CONTROL_AF_STATE_PASSIVE_SCAN

Added in API level 21
public static final int CONTROL_AF_STATE_PASSIVE_SCAN

AF is currently performing an AF scan initiated the camera device in a continuous autofocus mode.

Only used by CONTINUOUS_* AF modes. This is a transient state, the camera device may skip reporting this state in capture result.

Constant Value: 1 (0x00000001)

CONTROL_AF_STATE_PASSIVE_UNFOCUSED

Added in API level 21
public static final int CONTROL_AF_STATE_PASSIVE_UNFOCUSED

AF finished a passive scan without finding focus, and may restart scanning at any time.

Only used by CONTINUOUS_* AF modes. This is a transient state, the camera device may skip reporting this state in capture result.

LEGACY camera devices do not support this state. When a passive scan has finished, it will always go to PASSIVE_FOCUSED.

Constant Value: 6 (0x00000006)

CONTROL_AF_TRIGGER_CANCEL

Added in API level 21
public static final int CONTROL_AF_TRIGGER_CANCEL

Autofocus will return to its initial state, and cancel any currently active trigger.

Constant Value: 2 (0x00000002)

CONTROL_AF_TRIGGER_IDLE

Added in API level 21
public static final int CONTROL_AF_TRIGGER_IDLE

The trigger is idle.

Constant Value: 0 (0x00000000)

CONTROL_AF_TRIGGER_START

Added in API level 21
public static final int CONTROL_AF_TRIGGER_START

Autofocus will trigger now.

Constant Value: 1 (0x00000001)

CONTROL_AUTOFRAMING_OFF

Added in API level 34
public static final int CONTROL_AUTOFRAMING_OFF

Disable autoframing.

Constant Value: 0 (0x00000000)

CONTROL_AUTOFRAMING_ON

Added in API level 34
public static final int CONTROL_AUTOFRAMING_ON

Enable autoframing to keep people in the frame's field of view.

Constant Value: 1 (0x00000001)

CONTROL_AUTOFRAMING_STATE_CONVERGED

Added in API level 34
public static final int CONTROL_AUTOFRAMING_STATE_CONVERGED

Auto-framing has reached a stable state (frame/fov is not being adjusted). The state may transition back to FRAMING if the scene changes.

Constant Value: 2 (0x00000002)

CONTROL_AUTOFRAMING_STATE_FRAMING

Added in API level 34
public static final int CONTROL_AUTOFRAMING_STATE_FRAMING

Auto-framing is in process - either zooming in, zooming out or pan is taking place.

Constant Value: 1 (0x00000001)

CONTROL_AUTOFRAMING_STATE_INACTIVE

Added in API level 34
public static final int CONTROL_AUTOFRAMING_STATE_INACTIVE

Auto-framing is inactive.

Constant Value: 0 (0x00000000)

CONTROL_AWB_MODE_AUTO

Added in API level 21
public static final int CONTROL_AWB_MODE_AUTO

The camera device's auto-white balance routine is active.

The application's values for android.colorCorrection.transform and android.colorCorrection.gains are ignored. For devices that support the MANUAL_POST_PROCESSING capability, the values used by the camera device for the transform and gains will be available in the capture result for this request.

Constant Value: 1 (0x00000001)