Skip to content

Most visited

Recently visited

navigation

CameraMetadata

public abstract class CameraMetadata
extends Object

java.lang.Object
   ↳ android.hardware.camera2.CameraMetadata<TKey>
Known Direct Subclasses
Known Indirect Subclasses


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. The list of keys with getKeys() never changes, nor do the values returned by any key with #get throughout the lifetime of the object.

See also:

Summary

Constants

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_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_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_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_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_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_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_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_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 flame.

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_VIDEO_STABILIZATION_MODE_OFF

Video stabilization is disabled.

int CONTROL_VIDEO_STABILIZATION_MODE_ON

Video stabilization is enabled.

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

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_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 peform 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 peform 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

From class java.lang.Object

Constants

COLOR_CORRECTION_ABERRATION_MODE_FAST

added in API level 21
int COLOR_CORRECTION_ABERRATION_MODE_FAST

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

See also:

Constant Value: 1 (0x00000001)

COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY

added in API level 21
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)

See also:

Constant Value: 2 (0x00000002)

COLOR_CORRECTION_ABERRATION_MODE_OFF

added in API level 21
int COLOR_CORRECTION_ABERRATION_MODE_OFF

No aberration correction is applied.

See also:

Constant Value: 0 (0x00000000)

COLOR_CORRECTION_MODE_FAST

added in API level 21
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).

See also:

Constant Value: 1 (0x00000001)

COLOR_CORRECTION_MODE_HIGH_QUALITY

added in API level 21
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).

See also:

Constant Value: 2 (0x00000002)

COLOR_CORRECTION_MODE_TRANSFORM_MATRIX

added in API level 21
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.

See also:

Constant Value: 0 (0x00000000)

CONTROL_AE_ANTIBANDING_MODE_50HZ

added in API level 21
int CONTROL_AE_ANTIBANDING_MODE_50HZ

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

See also:

Constant Value: 1 (0x00000001)

CONTROL_AE_ANTIBANDING_MODE_60HZ

added in API level 21
int CONTROL_AE_ANTIBANDING_MODE_60HZ

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

See also:

Constant Value: 2 (0x00000002)

CONTROL_AE_ANTIBANDING_MODE_AUTO

added in API level 21
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.

See also:

Constant Value: 3 (0x00000003)

CONTROL_AE_ANTIBANDING_MODE_OFF

added in API level 21
int CONTROL_AE_ANTIBANDING_MODE_OFF

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

See also:

Constant Value: 0 (0x00000000)

CONTROL_AE_MODE_OFF

added in API level 21
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.

See also:

Constant Value: 0 (0x00000000)

CONTROL_AE_MODE_ON

added in API level 21
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.

See also:

Constant Value: 1 (0x00000001)

CONTROL_AE_MODE_ON_ALWAYS_FLASH

added in API level 21
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

See also:

Constant Value: 3 (0x00000003)

CONTROL_AE_MODE_ON_AUTO_FLASH

added in API level 21
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

See also:

Constant Value: 2 (0x00000002)

CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE

added in API level 21
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.

See also:

Constant Value: 4 (0x00000004)

CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL

added in API level 23
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.

See also:

Constant Value: 2 (0x00000002)

CONTROL_AE_PRECAPTURE_TRIGGER_IDLE

added in API level 21
int CONTROL_AE_PRECAPTURE_TRIGGER_IDLE

The trigger is idle.

See also:

Constant Value: 0 (0x00000000)

CONTROL_AE_PRECAPTURE_TRIGGER_START

added in API level 21
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.

See also:

Constant Value: 1 (0x00000001)

CONTROL_AE_STATE_CONVERGED

added in API level 21
int CONTROL_AE_STATE_CONVERGED

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

See also:

Constant Value: 2 (0x00000002)

CONTROL_AE_STATE_FLASH_REQUIRED

added in API level 21
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.

See also:

Constant Value: 4 (0x00000004)

CONTROL_AE_STATE_INACTIVE

added in API level 21
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.

See also:

Constant Value: 0 (0x00000000)

CONTROL_AE_STATE_LOCKED

added in API level 21
int CONTROL_AE_STATE_LOCKED

AE has been locked.

See also:

Constant Value: 3 (0x00000003)

CONTROL_AE_STATE_PRECAPTURE

added in API level 21
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.

See also:

Constant Value: 5 (0x00000005)

CONTROL_AE_STATE_SEARCHING

added in API level 21
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.

See also:

Constant Value: 1 (0x00000001)

CONTROL_AF_MODE_AUTO

added in API level 21
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.

See also:

Constant Value: 1 (0x00000001)

CONTROL_AF_MODE_CONTINUOUS_PICTURE

added in API level 21
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.

See also:

Constant Value: 4 (0x00000004)

CONTROL_AF_MODE_CONTINUOUS_VIDEO

added in API level 21
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.

See also:

Constant Value: 3 (0x00000003)

CONTROL_AF_MODE_EDOF

added in API level 21
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.

See also:

Constant Value: 5 (0x00000005)

CONTROL_AF_MODE_MACRO

added in API level 21
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.

See also:

Constant Value: 2 (0x00000002)

CONTROL_AF_MODE_OFF

added in API level 21
int CONTROL_AF_MODE_OFF

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

See also:

Constant Value: 0 (0x00000000)

CONTROL_AF_STATE_ACTIVE_SCAN

added in API level 21
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.

See also:

Constant Value: 3 (0x00000003)

CONTROL_AF_STATE_FOCUSED_LOCKED

added in API level 21
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).

See also:

Constant Value: 4 (0x00000004)

CONTROL_AF_STATE_INACTIVE

added in API level 21
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.

See also:

Constant Value: 0 (0x00000000)

CONTROL_AF_STATE_NOT_FOCUSED_LOCKED

added in API level 21
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).

See also:

Constant Value: 5 (0x00000005)

CONTROL_AF_STATE_PASSIVE_FOCUSED

added in API level 21
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.

See also:

Constant Value: 2 (0x00000002)

CONTROL_AF_STATE_PASSIVE_SCAN

added in API level 21
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.

See also:

Constant Value: 1 (0x00000001)

CONTROL_AF_STATE_PASSIVE_UNFOCUSED

added in API level 21
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.

See also:

Constant Value: 6 (0x00000006)

CONTROL_AF_TRIGGER_CANCEL

added in API level 21
int CONTROL_AF_TRIGGER_CANCEL

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

See also:

Constant Value: 2 (0x00000002)

CONTROL_AF_TRIGGER_IDLE

added in API level 21
int CONTROL_AF_TRIGGER_IDLE

The trigger is idle.

See also:

Constant Value: 0 (0x00000000)

CONTROL_AF_TRIGGER_START

added in API level 21
int CONTROL_AF_TRIGGER_START

Autofocus will trigger now.

See also:

Constant Value: 1 (0x00000001)

CONTROL_AWB_MODE_AUTO

added in API level 21
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.

See also:

Constant Value: 1 (0x00000001)

CONTROL_AWB_MODE_CLOUDY_DAYLIGHT

added in API level 21
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.

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.

See also:

Constant Value: 6 (0x00000006)

CONTROL_AWB_MODE_DAYLIGHT

added in API level 21
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.

While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant D65.

The application's values for 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.

See also:

Constant Value: 5 (0x00000005)

CONTROL_AWB_MODE_FLUORESCENT

added in API level 21
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.

While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant F2.

The application's values for 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.

See also:

Constant Value: 3 (0x00000003)

CONTROL_AWB_MODE_INCANDESCENT

added in API level 21
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.

While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant A.

The application's values for 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.

See also:

Constant Value: 2 (0x00000002)

CONTROL_AWB_MODE_OFF

added in API level 21
int CONTROL_AWB_MODE_OFF

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

The application-selected color transform matrix (android.colorCorrection.transform) and gains (android.colorCorrection.gains) are used by the camera device for manual white balance control.

See also:

Constant Value: 0 (0x00000000)

CONTROL_AWB_MODE_SHADE

added in API level 21
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.

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.

See also:

Constant Value: 8 (0x00000008)

CONTROL_AWB_MODE_TWILIGHT

added in API level 21
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.

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.

See also:

Constant Value: 7 (0x00000007)

CONTROL_AWB_MODE_WARM_FLUORESCENT

added in API level 21
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.

While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant F4.

The application's values for 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.

See also:

Constant Value: 4 (0x00000004)

CONTROL_AWB_STATE_CONVERGED

added in API level 21
int CONTROL_AWB_STATE_CONVERGED

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

See also:

Constant Value: 2 (0x00000002)

CONTROL_AWB_STATE_INACTIVE

added in API level 21
int CONTROL_AWB_STATE_INACTIVE

AWB is not in auto mode, or has not yet started metering.

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

See also:

Constant Value: 0 (0x00000000)

CONTROL_AWB_STATE_LOCKED

added in API level 21
int CONTROL_AWB_STATE_LOCKED

AWB has been locked.

See also:

Constant Value: 3 (0x00000003)

CONTROL_AWB_STATE_SEARCHING

added in API level 21
int CONTROL_AWB_STATE_SEARCHING

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

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

See also:

Constant Value: 1 (0x00000001)

CONTROL_CAPTURE_INTENT_CUSTOM

added in API level 21
int CONTROL_CAPTURE_INTENT_CUSTOM

The goal of this request doesn't fall into the other categories. The camera device will default to preview-like behavior.

See also:

Constant Value: 0 (0x00000000)

CONTROL_CAPTURE_INTENT_MANUAL

added in API level 21
int CONTROL_CAPTURE_INTENT_MANUAL

This request is for manual capture use case where the applications want to directly control the capture parameters.

For example, the application may wish to manually control android.sensor.exposureTime, android.sensor.sensitivity, etc.

See also:

Constant Value: 6 (0x00000006)

CONTROL_CAPTURE_INTENT_PREVIEW

added in API level 21
int CONTROL_CAPTURE_INTENT_PREVIEW

This request is for a preview-like use case.

The precapture trigger may be used to start off a metering w/flash sequence.

See also:

Constant Value: 1 (0x00000001)

CONTROL_CAPTURE_INTENT_STILL_CAPTURE

added in API level 21
int CONTROL_CAPTURE_INTENT_STILL_CAPTURE

This request is for a still capture-type use case.

If the flash unit is under automatic control, it may fire as needed.

See also:

Constant Value: 2 (0x00000002)

CONTROL_CAPTURE_INTENT_VIDEO_RECORD

added in API level 21
int CONTROL_CAPTURE_INTENT_VIDEO_RECORD

This request is for a video recording use case.

See also:

Constant Value: 3 (0x00000003)

CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT

added in API level 21
int CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT

This request is for a video snapshot (still image while recording video) use case.

The camera device should take the highest-quality image possible (given the other settings) without disrupting the frame rate of video recording.

See also:

Constant Value: 4 (0x00000004)

CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG

added in API level 21
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.

See also:

Constant Value: 5 (0x00000005)

CONTROL_EFFECT_MODE_AQUA

added in API level 21
int CONTROL_EFFECT_MODE_AQUA

An "aqua" effect where a blue hue is added to the image.

See also:

Constant Value: 8 (0x00000008)

CONTROL_EFFECT_MODE_BLACKBOARD

added in API level 21
int CONTROL_EFFECT_MODE_BLACKBOARD

A "blackboard" effect where the image is typically displayed as regions of black, with white or grey details.

See also:

Constant Value: 7 (0x00000007)

CONTROL_EFFECT_MODE_MONO

added in API level 21
int CONTROL_EFFECT_MODE_MONO

A "monocolor" effect where the image is mapped into a single color.

This will typically be grayscale.

See also:

Constant Value: 1 (0x00000001)

CONTROL_EFFECT_MODE_NEGATIVE

added in API level 21
int CONTROL_EFFECT_MODE_NEGATIVE

A "photo-negative" effect where the image's colors are inverted.

See also:

Constant Value: 2 (0x00000002)

CONTROL_EFFECT_MODE_OFF

added in API level 21
int CONTROL_EFFECT_MODE_OFF

No color effect will be applied.

See also:

Constant Value: 0 (0x00000000)

CONTROL_EFFECT_MODE_POSTERIZE

added in API level 21
int CONTROL_EFFECT_MODE_POSTERIZE

A "posterization" effect where the image uses discrete regions of tone rather than a continuous gradient of tones.

See also:

Constant Value: 5 (0x00000005)

CONTROL_EFFECT_MODE_SEPIA

added in API level 21
int CONTROL_EFFECT_MODE_SEPIA

A "sepia" effect where the image is mapped into warm gray, red, and brown tones.

See also:

Constant Value: 4 (0x00000004)

CONTROL_EFFECT_MODE_SOLARIZE

added in API level 21
int CONTROL_EFFECT_MODE_SOLARIZE

A "solarisation" effect (Sabattier effect) where the image is wholly or partially reversed in tone.

See also:

Constant Value: 3 (0x00000003)

CONTROL_EFFECT_MODE_WHITEBOARD

added in API level 21
int CONTROL_EFFECT_MODE_WHITEBOARD

A "whiteboard" effect where the image is typically displayed as regions of white, with black or grey details.

See also:

Constant Value: 6 (0x00000006)

CONTROL_MODE_AUTO

added in API level 21
int CONTROL_MODE_AUTO

Use settings for each individual 3A routine.

Manual control of capture parameters is disabled. All controls in android.control.* besides sceneMode take effect.

See also:

Constant Value: 1 (0x00000001)

CONTROL_MODE_OFF

added in API level 21
int CONTROL_MODE_OFF

Full application control of pipeline.

All control by the device's metering and focusing (3A) routines is disabled, and no other settings in android.control.* have any effect, except that android.control.captureIntent may be used by the camera device to select post-processing values for processing blocks that do not allow for manual control, or are not exposed by the camera API.

However, the camera device's 3A routines may continue to collect statistics and update their internal state so that when control is switched to AUTO mode, good control values can be immediately applied.

See also:

Constant Value: 0 (0x00000000)

CONTROL_MODE_OFF_KEEP_STATE

added in API level 21
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.

Specifically, the 3A routines are locked to the last values set from a request with AUTO, OFF, or USE_SCENE_MODE, and any statistics or state updates collected from manual captures with OFF_KEEP_STATE will be discarded by the camera device.

See also:

Constant Value: 3 (0x00000003)

CONTROL_MODE_USE_SCENE_MODE

added in API level 21
int CONTROL_MODE_USE_SCENE_MODE

Use a specific scene mode.

Enabling this disables control.aeMode, control.awbMode and control.afMode controls; the camera device will ignore those settings while USE_SCENE_MODE is active (except for FACE_PRIORITY scene mode). Other control entries are still active. This setting can only be used if scene mode is supported (i.e. android.control.availableSceneModes contain some modes other than DISABLED).

See also:

Constant Value: 2 (0x00000002)

CONTROL_SCENE_MODE_ACTION

added in API level 21
int CONTROL_SCENE_MODE_ACTION

Optimized for photos of quickly moving objects.

Similar to SPORTS.

See also:

Constant Value: 2 (0x00000002)

CONTROL_SCENE_MODE_BARCODE

added in API level 21
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.

See also:

Constant Value: 16 (0x00000010)

CONTROL_SCENE_MODE_BEACH

added in API level 21
int CONTROL_SCENE_MODE_BEACH

Optimized for bright, outdoor beach settings.

See also:

Constant Value: 8 (0x00000008)

CONTROL_SCENE_MODE_CANDLELIGHT

added in API level 21
int CONTROL_SCENE_MODE_CANDLELIGHT

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

See also:

Constant Value: 15 (0x0000000f)

CONTROL_SCENE_MODE_DISABLED

added in API level 21
int CONTROL_SCENE_MODE_DISABLED

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

See also:

Constant Value: 0 (0x00000000)

CONTROL_SCENE_MODE_FACE_PRIORITY

added in API level 21
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.

If face detection statistics are disabled (i.e. android.statistics.faceDetectMode is set to OFF), this should still operate correctly (but will not return face detection statistics to the framework).

Unlike the other scene modes, android.control.aeMode, android.control.awbMode, and android.control.afMode remain active when FACE_PRIORITY is set.

See also:

Constant Value: 1 (0x00000001)

CONTROL_SCENE_MODE_FIREWORKS

added in API level 21
int CONTROL_SCENE_MODE_FIREWORKS

Optimized for nighttime photos of fireworks.

See also:

Constant Value: 12 (0x0000000c)

CONTROL_SCENE_MODE_HDR

added in API level 22
int CONTROL_SCENE_MODE_HDR

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

In this scene mode, the camera device captures images that keep a larger range of scene illumination levels visible in the final image. For example, when taking a picture of a object in front of a bright window, both the object and the scene through the window may be visible when using HDR mode, while in normal AUTO mode, one or the other may be poorly exposed. As a tradeoff, HDR mode generally takes much longer to capture a single image, has no user control, and may have other artifacts depending on the HDR method used.

Therefore, HDR captures operate at a much slower rate than regular captures.

In this mode, on LIMITED or FULL devices, when a request is made with a android.control.captureIntent of STILL_CAPTURE, the camera device will capture an image using a high dynamic range capture technique. On LEGACY devices, captures that target a JPEG-format output will be captured with HDR, and the capture intent is not relevant.

The HDR capture may involve the device capturing a burst of images internally and combining them into one, or it may involve the device using specialized high dynamic range capture hardware. In all cases, a single image is produced in response to a capture request submitted while in HDR mode.

Since substantial post-processing is generally needed to produce an HDR image, only YUV, PRIVATE, and JPEG outputs are supported for LIMITED/FULL device HDR captures, and only JPEG outputs are supported for LEGACY HDR captures. Using a RAW output for HDR capture is not supported.

Some devices may also support always-on HDR, which applies HDR processing at full frame rate. For these devices, intents other than STILL_CAPTURE will also produce an HDR output with no frame rate impact compared to normal operation, though the quality may be lower than for STILL_CAPTURE intents.

If SCENE_MODE_HDR is used with unsupported output types or capture intents, the images captured will be as if the SCENE_MODE was not enabled at all.

See also:

Constant Value: 18 (0x00000012)

CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO

added in API level 21
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

This is deprecated, please use createConstrainedHighSpeedCaptureSession(List, CameraCaptureSession.StateCallback, Handler) and createHighSpeedRequestList(CaptureRequest) for high speed video recording.

Optimized for high speed video recording (frame rate >=60fps) use case.

The supported high speed video sizes and fps ranges are specified in android.control.availableHighSpeedVideoConfigurations. To get desired output frame rates, the application is only allowed to select video size and fps range combinations listed in this static metadata. The fps range can be control via android.control.aeTargetFpsRange.

In this mode, the camera device will override aeMode, awbMode, and afMode to ON, ON, and CONTINUOUS_VIDEO, respectively. All post-processing block mode controls will be overridden to be FAST. Therefore, no manual control of capture and post-processing parameters is possible. All other controls operate the same as when android.control.mode == AUTO. This means that all other android.control.* fields continue to work, such as

Outside of android.control.*, the following controls will work:

For high speed recording use case, the actual maximum supported frame rate may be lower than what camera can output, depending on the destination Surfaces for the image data. For example, if the destination surface is from video encoder, the application need check if the video encoder is capable of supporting the high frame rate for a given video size, or it will end up with lower recording frame rate. If the destination surface is from preview window, the preview frame rate will be bounded by the screen refresh rate.

The camera device will only support up to 2 output high speed streams (processed non-stalling format defined in android.request.maxNumOutputStreams) in this mode. This control will be effective only if all of below conditions are true:

  • The application created no more than maxNumHighSpeedStreams processed non-stalling format output streams, where maxNumHighSpeedStreams is calculated as min(2, android.request.maxNumOutputStreams[Processed (but not-stalling)]).
  • The stream sizes are selected from the sizes reported by android.control.availableHighSpeedVideoConfigurations.
  • No processed non-stalling or raw streams are configured.

When above conditions are NOT satistied, the controls of this mode and android.control.aeTargetFpsRange will be ignored by the camera device, the camera device will fall back to android.control.mode == AUTO, and the returned capture result metadata will give the fps range choosen by the camera device.

Switching into or out of this mode may trigger some camera ISP/sensor reconfigurations, which may introduce extra latency. It is recommended that the application avoids unnecessary scene mode switch as much as possible.

See also:

Constant Value: 17 (0x00000011)

CONTROL_SCENE_MODE_LANDSCAPE

added in API level 21
int CONTROL_SCENE_MODE_LANDSCAPE

Optimized for photos of distant macroscopic objects.

See also:

Constant Value: 4 (0x00000004)

CONTROL_SCENE_MODE_NIGHT

added in API level 21
int CONTROL_SCENE_MODE_NIGHT

Optimized for low-light settings.

See also:

Constant Value: 5 (0x00000005)

CONTROL_SCENE_MODE_NIGHT_PORTRAIT

added in API level 21
int CONTROL_SCENE_MODE_NIGHT_PORTRAIT

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

See also:

Constant Value: 6 (0x00000006)

CONTROL_SCENE_MODE_PARTY

added in API level 21
int CONTROL_SCENE_MODE_PARTY

Optimized for dim, indoor settings with multiple moving people.

See also:

Constant Value: 14 (0x0000000e)

CONTROL_SCENE_MODE_PORTRAIT

added in API level 21
int CONTROL_SCENE_MODE_PORTRAIT

Optimized for still photos of people.

See also:

Constant Value: 3 (0x00000003)

CONTROL_SCENE_MODE_SNOW

added in API level 21
int CONTROL_SCENE_MODE_SNOW

Optimized for bright, outdoor settings containing snow.

See also:

Constant Value: 9 (0x00000009)

CONTROL_SCENE_MODE_SPORTS

added in API level 21
int CONTROL_SCENE_MODE_SPORTS

Optimized for photos of quickly moving people.

Similar to ACTION.

See also:

Constant Value: 13 (0x0000000d)

CONTROL_SCENE_MODE_STEADYPHOTO

added in API level 21
int CONTROL_SCENE_MODE_STEADYPHOTO

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

See also:

Constant Value: 11 (0x0000000b)

CONTROL_SCENE_MODE_SUNSET

added in API level 21
int CONTROL_SCENE_MODE_SUNSET

Optimized for scenes of the setting sun.

See also:

Constant Value: 10 (0x0000000a)

CONTROL_SCENE_MODE_THEATRE

added in API level 21
int CONTROL_SCENE_MODE_THEATRE

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

See also:

Constant Value: 7 (0x00000007)

CONTROL_VIDEO_STABILIZATION_MODE_OFF

added in API level 21
int CONTROL_VIDEO_STABILIZATION_MODE_OFF

Video stabilization is disabled.

See also:

Constant Value: 0 (0x00000000)

CONTROL_VIDEO_STABILIZATION_MODE_ON

added in API level 21
int CONTROL_VIDEO_STABILIZATION_MODE_ON

Video stabilization is enabled.

See also:

Constant Value: 1 (0x00000001)

EDGE_MODE_FAST

added in API level 21
int EDGE_MODE_FAST

Apply edge enhancement at a quality level that does not slow down frame rate relative to sensor output. It may be the same as OFF if edge enhancement will slow down frame rate relative to sensor.

See also:

Constant Value: 1 (0x00000001)

EDGE_MODE_HIGH_QUALITY

added in API level 21
int EDGE_MODE_HIGH_QUALITY

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

See also:

Constant Value: 2 (0x00000002)

EDGE_MODE_OFF

added in API level 21
int EDGE_MODE_OFF

No edge enhancement is applied.

See also:

Constant Value: 0 (0x00000000)

EDGE_MODE_ZERO_SHUTTER_LAG

added in API level 23
int EDGE_MODE_ZERO_SHUTTER_LAG

Edge enhancement is applied at different levels for different output streams, based on resolution. Streams at maximum recording resolution (see createCaptureSession(List, CameraCaptureSession.StateCallback, Handler)) or below have edge enhancement applied, while higher-resolution streams have no edge enhancement applied. The level of edge enhancement for low-resolution streams is tuned so that frame rate is not impacted, and the quality is equal to or better than FAST (since it is only applied to lower-resolution outputs, quality may improve from FAST).

This mode is intended to be used by applications operating in a zero-shutter-lag mode with YUV or PRIVATE reprocessing, where the application continuously captures high-resolution intermediate buffers into a circular buffer, from which a final image is produced via reprocessing when a user takes a picture. For such a use case, the high-resolution buffers must not have edge enhancement applied to maximize efficiency of preview and to avoid double-applying enhancement when reprocessed, while low-resolution buffers (used for recording or preview, generally) need edge enhancement applied for reasonable preview quality.

This mode is guaranteed to be supported by devices that support either the YUV_REPROCESSING or PRIVATE_REPROCESSING capabilities (android.request.availableCapabilities lists either of those capabilities) and it will be the default mode for CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.

See also:

Constant Value: 3 (0x00000003)

FLASH_MODE_OFF

added in API level 21
int FLASH_MODE_OFF

Do not fire the flash for this capture.

See also:

Constant Value: 0 (0x00000000)

FLASH_MODE_SINGLE

added in API level 21
int FLASH_MODE_SINGLE

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

See also:

Constant Value: 1 (0x00000001)

FLASH_MODE_TORCH

added in API level 21
int FLASH_MODE_TORCH

Transition flash to continuously on.

See also:

Constant Value: 2 (0x00000002)

FLASH_STATE_CHARGING

added in API level 21
int FLASH_STATE_CHARGING

Flash is charging and cannot be fired.

See also:

Constant Value: 1 (0x00000001)

FLASH_STATE_FIRED

added in API level 21
int FLASH_STATE_FIRED

Flash fired for this capture.

See also:

Constant Value: 3 (0x00000003)

FLASH_STATE_PARTIAL

added in API level 21
int FLASH_STATE_PARTIAL

Flash partially illuminated this frame.

This is usually due to the next or previous frame having the flash fire, and the flash spilling into this capture due to hardware limitations.

See also:

Constant Value: 4 (0x00000004)

FLASH_STATE_READY

added in API level 21
int FLASH_STATE_READY

Flash is ready to fire.

See also:

Constant Value: 2 (0x00000002)

FLASH_STATE_UNAVAILABLE

added in API level 21
int FLASH_STATE_UNAVAILABLE

No flash on camera.

See also:

Constant Value: 0 (0x00000000)

HOT_PIXEL_MODE_FAST

added in API level 21
int HOT_PIXEL_MODE_FAST

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

The hotpixel map may be returned in android.statistics.hotPixelMap.

See also:

Constant Value: 1 (0x00000001)

HOT_PIXEL_MODE_HIGH_QUALITY

added in API level 21
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.

The hotpixel map may be returned in android.statistics.hotPixelMap.

See also:

Constant Value: 2 (0x00000002)

HOT_PIXEL_MODE_OFF

added in API level 21
int HOT_PIXEL_MODE_OFF

No hot pixel correction is applied.

The frame rate must not be reduced relative to sensor raw output for this option.

The hotpixel map may be returned in android.statistics.hotPixelMap.

See also:

Constant Value: 0 (0x00000000)

INFO_SUPPORTED_HARDWARE_LEVEL_3

added in API level 24
int INFO_SUPPORTED_HARDWARE_LEVEL_3

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

The stream configurations listed in the LEVEL_3, RAW, FULL, LEGACY and LIMITED tables in the createCaptureSession documentation are guaranteed to be supported.

The following additional capabilities are guaranteed to be supported:

See also:

Constant Value: 3 (0x00000003)

INFO_SUPPORTED_HARDWARE_LEVEL_FULL

added in API level 21
int INFO_SUPPORTED_HARDWARE_LEVEL_FULL

This camera device is capable of supporting advanced imaging applications.

The stream configurations listed in the FULL, LEGACY and LIMITED tables in the createCaptureSession documentation are guaranteed to be supported.

A FULL device will support below capabilities:

Note: Pre-API level 23, FULL devices also supported arbitrary cropping region (android.scaler.croppingType == FREEFORM); this requirement was relaxed in API level 23, and FULL devices may only support CENTERED cropping.

See also:

Constant Value: 1 (0x00000001)

INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY

added in API level 21
int INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY

This camera device is running in backward compatibility mode.

Only the stream configurations listed in the LEGACY table in the createCaptureSession documentation are supported.

A LEGACY device does not support per-frame control, manual sensor control, manual post-processing, arbitrary cropping regions, and has relaxed performance constraints. No additional capabilities beyond BACKWARD_COMPATIBLE will ever be listed by a LEGACY device in android.request.availableCapabilities.

In addition, the android.control.aePrecaptureTrigger is not functional on LEGACY devices. Instead, every request that includes a JPEG-format output target is treated as triggering a still capture, internally executing a precapture trigger. This may fire the flash for flash power metering during precapture, and then fire the flash for the final capture, if a flash is available on the device and the AE mode is set to enable the flash.

See also:

Constant Value: 2 (0x00000002)

INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED

added in API level 21
int INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED

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

Only the stream configurations listed in the LEGACY and LIMITED tables in the createCaptureSession documentation are guaranteed to be supported.

All LIMITED devices support the BACKWARDS_COMPATIBLE capability, indicating basic support for color image capture. The only exception is that the device may alternatively support only the DEPTH_OUTPUT capability, if it can only output depth measurements and not color images.

LIMITED devices and above require the use of android.control.aePrecaptureTrigger to lock exposure metering (and calculate flash power, for cameras with flash) before capturing a high-quality still image.

A LIMITED device that only lists the BACKWARDS_COMPATIBLE capability is only required to support full-automatic operation and post-processing (OFF is not supported for android.control.aeMode, android.control.afMode, or android.control.awbMode)

Additional capabilities may optionally be supported by a LIMITED-level device, and can be checked for in android.request.availableCapabilities.

See also:

Constant Value: 0 (0x00000000)

LENS_FACING_BACK

added in API level 21
int LENS_FACING_BACK

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

See also:

Constant Value: 1 (0x00000001)

LENS_FACING_EXTERNAL

added in API level 23
int LENS_FACING_EXTERNAL

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

See also:

Constant Value: 2 (0x00000002)

LENS_FACING_FRONT

added in API level 21
int LENS_FACING_FRONT

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

See also:

Constant Value: 0 (0x00000000)

LENS_INFO_FOCUS_DISTANCE_CALIBRATION_APPROXIMATE

added in API level 21
int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_APPROXIMATE

The lens focus distance is measured in diopters.

However, setting the lens to the same focus distance on separate occasions may result in a different real focus distance, depending on factors such as the orientation of the device, the age of the focusing mechanism, and the device temperature.

See also:

Constant Value: 1 (0x00000001)

LENS_INFO_FOCUS_DISTANCE_CALIBRATION_CALIBRATED

added in API level 21
int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_CALIBRATED

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

The lens mechanism is calibrated so that setting the same focus distance is repeatable on multiple occasions with good accuracy, and the focus distance corresponds to the real physical distance to the plane of best focus.

See also:

Constant Value: 2 (0x00000002)

LENS_INFO_FOCUS_DISTANCE_CALIBRATION_UNCALIBRATED

added in API level 21
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.

Setting the lens to the same focus distance on separate occasions may result in a different real focus distance, depending on factors such as the orientation of the device, the age of the focusing mechanism, and the device temperature. The focus distance value will still be in the range of [0, android.lens.info.minimumFocusDistance], where 0 represents the farthest focus.

See also:

Constant Value: 0 (0x00000000)

LENS_OPTICAL_STABILIZATION_MODE_OFF

added in API level 21
int LENS_OPTICAL_STABILIZATION_MODE_OFF

Optical stabilization is unavailable.

See also:

Constant Value: 0 (0x00000000)

LENS_OPTICAL_STABILIZATION_MODE_ON

added in API level 21
int LENS_OPTICAL_STABILIZATION_MODE_ON

Optical stabilization is enabled.

See also:

Constant Value: 1 (0x00000001)

LENS_STATE_MOVING

added in API level 21
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.

See also:

Constant Value: 1 (0x00000001)

LENS_STATE_STATIONARY

added in API level 21
int LENS_STATE_STATIONARY

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

See also:

Constant Value: 0 (0x00000000)

NOISE_REDUCTION_MODE_FAST

added in API level 21
int NOISE_REDUCTION_MODE_FAST

Noise reduction is applied without reducing frame rate relative to sensor output. It may be the same as OFF if noise reduction will reduce frame rate relative to sensor.

See also:

Constant Value: 1 (0x00000001)

NOISE_REDUCTION_MODE_HIGH_QUALITY

added in API level 21
int NOISE_REDUCTION_MODE_HIGH_QUALITY

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

See also:

Constant Value: 2 (0x00000002)

NOISE_REDUCTION_MODE_MINIMAL

added in API level 23
int NOISE_REDUCTION_MODE_MINIMAL

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

See also:

Constant Value: 3 (0x00000003)

NOISE_REDUCTION_MODE_OFF

added in API level 21
int NOISE_REDUCTION_MODE_OFF

No noise reduction is applied.

See also:

Constant Value: 0 (0x00000000)

NOISE_REDUCTION_MODE_ZERO_SHUTTER_LAG

added in API level 23
int NOISE_REDUCTION_MODE_ZERO_SHUTTER_LAG

Noise reduction is applied at different levels for different output streams, based on resolution. Streams at maximum recording resolution (see createCaptureSession(List, CameraCaptureSession.StateCallback, Handler)) or below have noise reduction applied, while higher-resolution streams have MINIMAL (if supported) or no noise reduction applied (if MINIMAL is not supported.) The degree of noise reduction for low-resolution streams is tuned so that frame rate is not impacted, and the quality is equal to or better than FAST (since it is only applied to lower-resolution outputs, quality may improve from FAST).

This mode is intended to be used by applications operating in a zero-shutter-lag mode with YUV or PRIVATE reprocessing, where the application continuously captures high-resolution intermediate buffers into a circular buffer, from which a final image is produced via reprocessing when a user takes a picture. For such a use case, the high-resolution buffers must not have noise reduction applied to maximize efficiency of preview and to avoid over-applying noise filtering when reprocessing, while low-resolution buffers (used for recording or preview, generally) need noise reduction applied for reasonable preview quality.

This mode is guaranteed to be supported by devices that support either the YUV_REPROCESSING or PRIVATE_REPROCESSING capabilities (android.request.availableCapabilities lists either of those capabilities) and it will be the default mode for CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.

See also:

Constant Value: 4 (0x00000004)

REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE

added in API level 21
int REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE

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

This capability is listed by all normal devices, and indicates that the camera device has a feature set that's comparable to the baseline requirements for the older android.hardware.Camera API.

Devices with the DEPTH_OUTPUT capability might not list this capability, indicating that they support only depth measurement, not standard color output.

See also:

Constant Value: 0 (0x00000000)

REQUEST_AVAILABLE_CAPABILITIES_BURST_CAPTURE

added in API level 22
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. Additionally, maximum-resolution images can be captured at >= 10 frames per second. Here, 'high resolution' means at least 8 megapixels, or the maximum resolution of the device, whichever is smaller.

More specifically, this means that a size matching the camera device's active array size is listed as a supported size for the YUV_420_888 format in either getOutputSizes(int) or getHighResolutionOutputSizes(int), with a minimum frame duration for that format and size of either <= 1/20 s, or <= 1/10 s, respectively; and the android.control.aeAvailableTargetFpsRanges entry lists at least one FPS range where the minimum FPS is >= 1 / minimumFrameDuration for the maximum-size YUV_420_888 format. If that maximum size is listed in getHighResolutionOutputSizes(int), then the list of resolutions for YUV_420_888 from getOutputSizes(int) contains at least one resolution >= 8 megapixels, with a minimum frame duration of <= 1/20 s.

If the device supports the RAW10, RAW12, then those can also be captured at the same rate as the maximum-size YUV_420_888 resolution is.

If the device supports the PRIVATE_REPROCESSING capability, then the same guarantees as for the YUV_420_888 format also apply to the PRIVATE format.

In addition, the android.sync.maxLatency field is guaranted to have a value between 0 and 4, inclusive. android.control.aeLockAvailable and android.control.awbLockAvailable are also guaranteed to be true so burst capture with these two locks ON yields consistent image output.

See also:

Constant Value: 6 (0x00000006)

REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO

added in API level 23
int REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO

The device supports constrained high speed video recording (frame rate >=120fps) use case. The camera device will support high speed capture session created by createConstrainedHighSpeedCaptureSession(List, CameraCaptureSession.StateCallback, Handler), which only accepts high speed request lists created by createHighSpeedRequestList(CaptureRequest).

A camera device can still support high speed video streaming by advertising the high speed FPS ranges in android.control.aeAvailableTargetFpsRanges. For this case, all normal capture request per frame control and synchronization requirements will apply to the high speed fps ranges, the same as all other fps ranges. This capability describes the capability of a specialized operating mode with many limitations (see below), which is only targeted at high speed video recording.

The supported high speed video sizes and fps ranges are specified in getHighSpeedVideoFpsRanges(). To get desired output frame rates, the application is only allowed to select video size and FPS range combinations provided by getHighSpeedVideoSizes(). The fps range can be controlled via android.control.aeTargetFpsRange.

In this capability, the camera device will override aeMode, awbMode, and afMode to ON, AUTO, and CONTINUOUS_VIDEO, respectively. All post-processing block mode controls will be overridden to be FAST. Therefore, no manual control of capture and post-processing parameters is possible. All other controls operate the same as when android.control.mode == AUTO. This means that all other android.control.* fields continue to work, such as

Outside of android.control.*, the following controls will work:

For high speed recording use case, the actual maximum supported frame rate may be lower than what camera can output, depending on the destination Surfaces for the image data. For example, if the destination surface is from video encoder, the application need check if the video encoder is capable of supporting the high frame rate for a given video size, or it will end up with lower recording frame rate. If the destination surface is from preview window, the actual preview frame rate will be bounded by the screen refresh rate.

The camera device will only support up to 2 high speed simultaneous output surfaces (preview and recording surfaces) in this mode. Above controls will be effective only if all of below conditions are true:

When above conditions are NOT satistied, createConstrainedHighSpeedCaptureSession(List, CameraCaptureSession.StateCallback, Handler) will fail.

Switching to a FPS range that has different maximum FPS may trigger some camera device reconfigurations, which may introduce extra latency. It is recommended that the application avoids unnecessary maximum target FPS changes as much as possible during high speed streaming.

See also:

Constant Value: 9 (0x00000009)

REQUEST_AVAILABLE_CAPABILITIES_DEPTH_OUTPUT

added in API level 23
int REQUEST_AVAILABLE_CAPABILITIES_DEPTH_OUTPUT

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

This capability requires the camera device to support the following:

Generally, depth output operates at a slower frame rate than standard color capture, so the DEPTH16 and DEPTH_POINT_CLOUD formats will commonly have a stall duration that should be accounted for (see getOutputStallDuration(int, Size)). On a device that supports both depth and color-based output, to enable smooth preview, using a repeating burst is recommended, where a depth-output target is only included once every N frames, where N is the ratio between preview output rate and depth output rate, including depth stall time.

See also:

Constant Value: 8 (0x00000008)

REQUEST_AVAILABLE_CAPABILITIES_MANUAL_POST_PROCESSING

added in API level 21
int REQUEST_AVAILABLE_CAPABILITIES_MANUAL_POST_PROCESSING

The camera device post-processing stages can be manually controlled. The camera device supports basic manual control of the image post-processing stages. This means the following controls are guaranteed to be supported:

If auto white balance is enabled, then the camera device will accurately report the values applied by AWB in the result.

A given camera device may also support additional post-processing controls, but this capability only covers the above list of controls.

See also:

Constant Value: 2 (0x00000002)

REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR

added in API level 21
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). The camera device supports basic manual control of the sensor image acquisition related stages. This means the following controls are guaranteed to be supported:

If any of the above 3A algorithms are enabled, then the camera device will accurately report the values applied by 3A in the result.

A given camera device may also support additional manual sensor controls, but this capability only covers the above list of controls.

If this is supported, android.scaler.streamConfigurationMap will additionally return a min frame duration that is greater than zero for each supported size-format combination.

See also:

Constant Value: 1 (0x00000001)

REQUEST_AVAILABLE_CAPABILITIES_PRIVATE_REPROCESSING

added in API level 23
int REQUEST_AVAILABLE_CAPABILITIES_PRIVATE_REPROCESSING

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

See also:

Constant Value: 4 (0x00000004)

REQUEST_AVAILABLE_CAPABILITIES_RAW

added in API level 21
int REQUEST_AVAILABLE_CAPABILITIES_RAW

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

Devices supporting the RAW capability allow both for saving DNG files, and for direct application processing of raw sensor images.

See also:

Constant Value: 3 (0x00000003)

REQUEST_AVAILABLE_CAPABILITIES_READ_SENSOR_SETTINGS

added in API level 22
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. This allows reporting of sensor settings even when these settings cannot be manually changed.

The values reported for the following controls are guaranteed to be available in the CaptureResult, including when 3A is enabled:

This capability is a subset of the MANUAL_SENSOR control capability, and will always be included if the MANUAL_SENSOR capability is available.

See also:

Constant Value: 5 (0x00000005)

REQUEST_AVAILABLE_CAPABILITIES_YUV_REPROCESSING

added in API level 23
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:

See also:

Constant Value: 7 (0x00000007)

SCALER_CROPPING_TYPE_CENTER_ONLY

added in API level 21
int SCALER_CROPPING_TYPE_CENTER_ONLY

The camera device only supports centered crop regions.

See also:

Constant Value: 0 (0x00000000)

SCALER_CROPPING_TYPE_FREEFORM

added in API level 21
int SCALER_CROPPING_TYPE_FREEFORM

The camera device supports arbitrarily chosen crop regions.

See also:

Constant Value: 1 (0x00000001)

SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_BGGR

added in API level 21
int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_BGGR

See also:

Constant Value: 3 (0x00000003)

SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GBRG

added in API level 21
int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GBRG

See also:

Constant Value: 2 (0x00000002)

SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GRBG

added in API level 21
int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GRBG

See also:

Constant Value: 1 (0x00000001)

SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGB

added in API level 21
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.

See also:

Constant Value: 4 (0x00000004)

SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGGB

added in API level 21
int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGGB

See also:

Constant Value: 0 (0x00000000)

SENSOR_INFO_TIMESTAMP_SOURCE_REALTIME

added in API level 21
int SENSOR_INFO_TIMESTAMP_SOURCE_REALTIME

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

See also:

Constant Value: 1 (0x00000001)

SENSOR_INFO_TIMESTAMP_SOURCE_UNKNOWN

added in API level 21
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. Timestamps between streams and results for a single camera instance are comparable, and the timestamps for all buffers and the result metadata generated by a single capture are identical.

See also:

Constant Value: 0 (0x00000000)

SENSOR_REFERENCE_ILLUMINANT1_CLOUDY_WEATHER

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_CLOUDY_WEATHER

See also:

Constant Value: 10 (0x0000000a)

SENSOR_REFERENCE_ILLUMINANT1_COOL_WHITE_FLUORESCENT

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_COOL_WHITE_FLUORESCENT

W 3900 - 4500K

See also:

Constant Value: 14 (0x0000000e)

SENSOR_REFERENCE_ILLUMINANT1_D50

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_D50

See also:

Constant Value: 23 (0x00000017)

SENSOR_REFERENCE_ILLUMINANT1_D55

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_D55

See also:

Constant Value: 20 (0x00000014)

SENSOR_REFERENCE_ILLUMINANT1_D65

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_D65

See also:

Constant Value: 21 (0x00000015)

SENSOR_REFERENCE_ILLUMINANT1_D75

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_D75

See also:

Constant Value: 22 (0x00000016)

SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT

See also:

Constant Value: 1 (0x00000001)

SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT_FLUORESCENT

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT_FLUORESCENT

D 5700 - 7100K

See also:

Constant Value: 12 (0x0000000c)

SENSOR_REFERENCE_ILLUMINANT1_DAY_WHITE_FLUORESCENT

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_DAY_WHITE_FLUORESCENT

N 4600 - 5400K

See also:

Constant Value: 13 (0x0000000d)

SENSOR_REFERENCE_ILLUMINANT1_FINE_WEATHER

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_FINE_WEATHER

See also:

Constant Value: 9 (0x00000009)

SENSOR_REFERENCE_ILLUMINANT1_FLASH

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_FLASH

See also:

Constant Value: 4 (0x00000004)

SENSOR_REFERENCE_ILLUMINANT1_FLUORESCENT

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_FLUORESCENT

See also:

Constant Value: 2 (0x00000002)

SENSOR_REFERENCE_ILLUMINANT1_ISO_STUDIO_TUNGSTEN

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_ISO_STUDIO_TUNGSTEN

See also:

Constant Value: 24 (0x00000018)

SENSOR_REFERENCE_ILLUMINANT1_SHADE

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_SHADE

See also:

Constant Value: 11 (0x0000000b)

SENSOR_REFERENCE_ILLUMINANT1_STANDARD_A

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_A

See also:

Constant Value: 17 (0x00000011)

SENSOR_REFERENCE_ILLUMINANT1_STANDARD_B

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_B

See also:

Constant Value: 18 (0x00000012)

SENSOR_REFERENCE_ILLUMINANT1_STANDARD_C

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_C

See also:

Constant Value: 19 (0x00000013)

SENSOR_REFERENCE_ILLUMINANT1_TUNGSTEN

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_TUNGSTEN

Incandescent light

See also:

Constant Value: 3 (0x00000003)

SENSOR_REFERENCE_ILLUMINANT1_WHITE_FLUORESCENT

added in API level 21
int SENSOR_REFERENCE_ILLUMINANT1_WHITE_FLUORESCENT

WW 3200 - 3700K

See also:

Constant Value: 15 (0x0000000f)

SENSOR_TEST_PATTERN_MODE_COLOR_BARS

added in API level 21
int SENSOR_TEST_PATTERN_MODE_COLOR_BARS

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

The vertical bars (left-to-right) are as follows:

  • 100% white
  • yellow
  • cyan
  • green
  • magenta
  • red
  • blue
  • black

In general the image would look like the following:

W Y C G M R B K
 W Y C G M R B K
 W Y C G M R B K
 W Y C G M R B K
 W Y C G M R B K
 . . . . . . . .
 . . . . . . . .
 . . . . . . . .

 (B = Blue, K = Black)
 

Each bar should take up 1/8 of the sensor pixel array width. When this is not possible, the bar size should be rounded down to the nearest integer and the pattern can repeat on the right side.

Each bar's height must always take up the full sensor pixel array height.

Each pixel in this test pattern must be set to either 0% intensity or 100% intensity.

See also:

Constant Value: 2 (0x00000002)

SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY

added in API level 21
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.

Furthermore each bar is further subdivided into a left and right half. The left half should have a smooth gradient, and the right half should have a quantized gradient.

In particular, the right half's should consist of blocks of the same color for 1/16th active sensor pixel array width.

The least significant bits in the quantized gradient should be copied from the most significant bits of the smooth gradient.

The height of each bar should always be a multiple of 128. When this is not the case, the pattern should repeat at the bottom of the image.

See also:

Constant Value: 3 (0x00000003)

SENSOR_TEST_PATTERN_MODE_CUSTOM1

added in API level 21
int SENSOR_TEST_PATTERN_MODE_CUSTOM1

The first custom test pattern. All custom patterns that are available only on this camera device are at least this numeric value.

All of the custom test patterns will be static (that is the raw image must not vary from frame to frame).

See also:

Constant Value: 256 (0x00000100)

SENSOR_TEST_PATTERN_MODE_OFF

added in API level 21
int SENSOR_TEST_PATTERN_MODE_OFF

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

This is the default if the key is not set.

See also:

Constant Value: 0 (0x00000000)

SENSOR_TEST_PATTERN_MODE_PN9

added in API level 21
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).

The generator should be reset at the beginning of each frame, and thus each subsequent raw frame with this test pattern should be exactly the same as the last.

See also:

Constant Value: 4 (0x00000004)

SENSOR_TEST_PATTERN_MODE_SOLID_COLOR

added in API level 21
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.

For example:

android.testPatternData = [0, 0xFFFFFFFF, 0xFFFFFFFF, 0]
 

All green pixels are 100% green. All red/blue pixels are black.

android.testPatternData = [0xFFFFFFFF, 0, 0xFFFFFFFF, 0]
 

All red pixels are 100% red. Only the odd green pixels are 100% green. All blue pixels are 100% black.

See also:

Constant Value: 1 (0x00000001)

SHADING_MODE_FAST

added in API level 21
int SHADING_MODE_FAST

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

See also:

Constant Value: 1 (0x00000001)

SHADING_MODE_HIGH_QUALITY

added in API level 21
int SHADING_MODE_HIGH_QUALITY

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

See also:

Constant Value: 2 (0x00000002)

SHADING_MODE_OFF

added in API level 21
int SHADING_MODE_OFF

No lens shading correction is applied.

See also:

Constant Value: 0 (0x00000000)

STATISTICS_FACE_DETECT_MODE_FULL

added in API level 21
int STATISTICS_FACE_DETECT_MODE_FULL

Return all face metadata.

In this mode, face rectangles, scores, landmarks, and face IDs are all valid.

See also:

Constant Value: 2 (0x00000002)

STATISTICS_FACE_DETECT_MODE_OFF

added in API level 21
int STATISTICS_FACE_DETECT_MODE_OFF

Do not include face detection statistics in capture results.

See also:

Constant Value: 0 (0x00000000)

STATISTICS_FACE_DETECT_MODE_SIMPLE

added in API level 21
int STATISTICS_FACE_DETECT_MODE_SIMPLE

Return face rectangle and confidence values only.

See also:

Constant Value: 1 (0x00000001)

STATISTICS_LENS_SHADING_MAP_MODE_OFF

added in API level 21
int STATISTICS_LENS_SHADING_MAP_MODE_OFF

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

See also:

Constant Value: 0 (0x00000000)

STATISTICS_LENS_SHADING_MAP_MODE_ON

added in API level 21
int STATISTICS_LENS_SHADING_MAP_MODE_ON

Include a lens shading map in the capture result.

See also:

Constant Value: 1 (0x00000001)

STATISTICS_SCENE_FLICKER_50HZ

added in API level 21
int STATISTICS_SCENE_FLICKER_50HZ

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

See also:

Constant Value: 1 (0x00000001)

STATISTICS_SCENE_FLICKER_60HZ

added in API level 21
int STATISTICS_SCENE_FLICKER_60HZ

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

See also:

Constant Value: 2 (0x00000002)

STATISTICS_SCENE_FLICKER_NONE

added in API level 21
int STATISTICS_SCENE_FLICKER_NONE

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

See also:

Constant Value: 0 (0x00000000)

SYNC_MAX_LATENCY_PER_FRAME_CONTROL

added in API level 21
int SYNC_MAX_LATENCY_PER_FRAME_CONTROL

Every frame has the requests immediately applied.

Changing controls over multiple requests one after another will produce results that have those controls applied atomically each frame.

All FULL capability devices will have this as their maxLatency.

See also:

Constant Value: 0 (0x00000000)

SYNC_MAX_LATENCY_UNKNOWN

added in API level 21
int SYNC_MAX_LATENCY_UNKNOWN

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

By submitting a series of identical requests, the camera device will eventually have the camera settings applied, but it is unknown when that exact point will be.

All LEGACY capability devices will have this as their maxLatency.

See also:

Constant Value: -1 (0xffffffff)

TONEMAP_MODE_CONTRAST_CURVE

added in API level 21
int TONEMAP_MODE_CONTRAST_CURVE

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

All color enhancement and tonemapping must be disabled, except for applying the tonemapping curve specified by android.tonemap.curve.

Must not slow down frame rate relative to raw sensor output.

See also:

Constant Value: 0 (0x00000000)

TONEMAP_MODE_FAST

added in API level 21
int TONEMAP_MODE_FAST

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

See also:

Constant Value: 1 (0x00000001)

TONEMAP_MODE_GAMMA_VALUE

added in API level 23
int TONEMAP_MODE_GAMMA_VALUE

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

All color enhancement and tonemapping must be disabled, except for applying the tonemapping curve specified by android.tonemap.gamma.

Must not slow down frame rate relative to raw sensor output.

See also:

Constant Value: 3 (0x00000003)

TONEMAP_MODE_HIGH_QUALITY

added in API level 21
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.

See also:

Constant Value: 2 (0x00000002)

TONEMAP_MODE_PRESET_CURVE

added in API level 23
int TONEMAP_MODE_PRESET_CURVE

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

All color enhancement and tonemapping must be disabled, except for applying the tonemapping curve specified by android.tonemap.presetCurve.

Must not slow down frame rate relative to raw sensor output.

See also:

Constant Value: 4 (0x00000004)

TONEMAP_PRESET_CURVE_REC709

added in API level 23
int TONEMAP_PRESET_CURVE_REC709

Tonemapping curve is defined by ITU-R BT.709

See also:

Constant Value: 1 (0x00000001)

TONEMAP_PRESET_CURVE_SRGB

added in API level 23
int TONEMAP_PRESET_CURVE_SRGB

Tonemapping curve is defined by sRGB

See also:

Constant Value: 0 (0x00000000)

Public methods

getKeys

added in API level 21
List<TKey> 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.

Returns
List<TKey> List of the keys contained in this map.

This value will never be null.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.