File Doc Category Size Date Package
CameraMetadata.java API Doc Android 5.1 API 94988 Thu Mar 12 22:22:10 GMT 2015 android.hardware.camera2

CameraMetadata

java.lang.Object

public abstract class CameraMetadata extends Object

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 {@link #getKeys()} never changes, nor do the values returned by any key with {@code #get} throughout the lifetime of the object.

see: CameraDevice
see: CameraManager
see: CameraCharacteristics

Fields Summary
private static final String
TAG
private static final boolean
VERBOSE
public static final int
LENS_INFO_FOCUS_DISTANCE_CALIBRATION_UNCALIBRATED
The lens focus distance is not accurate, and the units used for {@link CaptureRequest#LENS_FOCUS_DISTANCE 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, {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}], where 0 represents the farthest focus.
public static final 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.
public static final 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.
public static final int
LENS_FACING_FRONT
The camera device faces the same direction as the device's screen.
public static final int
LENS_FACING_BACK
The camera device faces the opposite direction as the device's screen.
public static final int
REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE
The minimal set of capabilities that every camera device (regardless of {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel}) supports.

This capability is listed by all 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.
public static final 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:

Manual frame duration control

{@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}

{@link CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION android.sensor.info.maxFrameDuration}

Manual exposure control

{@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}

{@link CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE android.sensor.info.exposureTimeRange}

Manual sensitivity control

{@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}

{@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}

Manual lens control (if the lens is adjustable)

android.lens.*

Manual flash control (if a flash unit is present)

android.flash.*

Manual black level locking

{@link CaptureRequest#BLACK_LEVEL_LOCK android.blackLevel.lock}

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, {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} will additionally return a min frame duration that is greater than zero for each supported size-format combination.
public static final 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:

Manual tonemap control

{@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}

{@link CaptureRequest#TONEMAP_MODE android.tonemap.mode}

{@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}

Manual white balance control

{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}

{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains}

Manual lens shading map control

{@link CaptureRequest#SHADING_MODE android.shading.mode}

{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode}

android.statistics.lensShadingMap

android.lens.info.shadingMapSize

Manual aberration correction control (if aberration correction is supported)

{@link CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE android.colorCorrection.aberrationMode}

{@link CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES android.colorCorrection.availableAberrationModes}

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.
public static final 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.

RAW_SENSOR is supported as an output format.

The maximum available resolution for RAW_SENSOR streams will match either the value in {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize} or {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.

All DNG-related optional metadata entries are provided by the camera device.

public static final int
REQUEST_AVAILABLE_CAPABILITIES_ZSL
The camera device supports the Zero Shutter Lag use case.

At least one input stream can be used.

RAW_OPAQUE is supported as an output/input format

Using RAW_OPAQUE does not cause a frame rate drop relative to the sensor's maximum capture rate (at that resolution).

RAW_OPAQUE will be reprocessable into both YUV_420_888 and JPEG formats.

The maximum available resolution for RAW_OPAQUE streams (both input/output) will match the maximum available resolution of JPEG streams.

public static final 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:

Exposure control

{@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}

Sensitivity control

{@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}

Lens controls (if the lens is adjustable)

{@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance}

{@link CaptureRequest#LENS_APERTURE android.lens.aperture}

This capability is a subset of the MANUAL_SENSOR control capability, and will always be included if the MANUAL_SENSOR capability is available.
public static final int
REQUEST_AVAILABLE_CAPABILITIES_BURST_CAPTURE
The camera device supports capturing maximum-resolution images at >= 20 frames per second, in at least the uncompressed YUV format, when post-processing settings are set to FAST.

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 {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}, the minimum frame duration for that format and size is <= 1/20 s, and the {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES 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.

In addition, the {@link CameraCharacteristics#SYNC_MAX_LATENCY android.sync.maxLatency} field is guaranted to have a value between 0 and 4, inclusive.
public static final int
SCALER_CROPPING_TYPE_CENTER_ONLY
The camera device only supports centered crop regions.
public static final int
SCALER_CROPPING_TYPE_FREEFORM
The camera device supports arbitrarily chosen crop regions.
public static final int
SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGGB
public static final int
SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GRBG
public static final int
SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GBRG
public static final int
SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_BGGR
public static final 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.
public static final int
SENSOR_INFO_TIMESTAMP_SOURCE_UNKNOWN
Timestamps from {@link CaptureResult#SENSOR_TIMESTAMP 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.
public static final int
SENSOR_INFO_TIMESTAMP_SOURCE_REALTIME
Timestamps from {@link CaptureResult#SENSOR_TIMESTAMP android.sensor.timestamp} are in the same timebase as android.os.SystemClock#elapsedRealtimeNanos(), and they can be compared to other timestamps using that base.
public static final int
SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT
public static final int
SENSOR_REFERENCE_ILLUMINANT1_FLUORESCENT
public static final int
SENSOR_REFERENCE_ILLUMINANT1_TUNGSTEN
Incandescent light
public static final int
SENSOR_REFERENCE_ILLUMINANT1_FLASH
public static final int
SENSOR_REFERENCE_ILLUMINANT1_FINE_WEATHER
public static final int
SENSOR_REFERENCE_ILLUMINANT1_CLOUDY_WEATHER
public static final int
SENSOR_REFERENCE_ILLUMINANT1_SHADE
public static final int
SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT_FLUORESCENT
D 5700 - 7100K
public static final int
SENSOR_REFERENCE_ILLUMINANT1_DAY_WHITE_FLUORESCENT
N 4600 - 5400K
public static final int
SENSOR_REFERENCE_ILLUMINANT1_COOL_WHITE_FLUORESCENT
W 3900 - 4500K
public static final int
SENSOR_REFERENCE_ILLUMINANT1_WHITE_FLUORESCENT
WW 3200 - 3700K
public static final int
SENSOR_REFERENCE_ILLUMINANT1_STANDARD_A
public static final int
SENSOR_REFERENCE_ILLUMINANT1_STANDARD_B
public static final int
SENSOR_REFERENCE_ILLUMINANT1_STANDARD_C
public static final int
SENSOR_REFERENCE_ILLUMINANT1_D55
public static final int
SENSOR_REFERENCE_ILLUMINANT1_D65
public static final int
SENSOR_REFERENCE_ILLUMINANT1_D75
public static final int
SENSOR_REFERENCE_ILLUMINANT1_D50
public static final int
SENSOR_REFERENCE_ILLUMINANT1_ISO_STUDIO_TUNGSTEN
public static final int
LED_AVAILABLE_LEDS_TRANSMIT
android.led.transmit control is used.
public static final int
INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED
This camera device has only limited capabilities.
public static final int
INFO_SUPPORTED_HARDWARE_LEVEL_FULL
This camera device is capable of supporting advanced imaging applications.
public static final int
INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY
This camera device is running in backward compatibility mode.
public static final int
SYNC_MAX_LATENCY_PER_FRAME_CONTROL
Every frame has the requests immediately applied.

Furthermore for all results, android.sync.frameNumber == CaptureResult#getFrameNumber()

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.
public static final 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.
public static final int
COLOR_CORRECTION_MODE_TRANSFORM_MATRIX
Use the {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} matrix and {@link CaptureRequest#COLOR_CORRECTION_GAINS 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 {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != OFF, then TRANSFORM_MATRIX is ignored. The camera device will override this value to either FAST or HIGH_QUALITY.
public static final int
COLOR_CORRECTION_MODE_FAST
Color correction processing must not slow down capture rate relative to sensor raw output.

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

If AWB is enabled with {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != OFF, then the camera device uses the last frame's AWB values (or defaults if AWB has never been run).
public static final int
COLOR_CORRECTION_MODE_HIGH_QUALITY
Color correction processing operates at improved quality but reduced 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 {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != OFF, then the camera device uses the last frame's AWB values (or defaults if AWB has never been run).
public static final int
COLOR_CORRECTION_ABERRATION_MODE_OFF
No aberration correction is applied.
public static final int
COLOR_CORRECTION_ABERRATION_MODE_FAST
Aberration correction will not slow down capture rate relative to sensor raw output.
public static final int
COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY
Aberration correction operates at improved quality but reduced capture rate (relative to sensor raw output).
public static final int
CONTROL_AE_ANTIBANDING_MODE_OFF
The camera device will not adjust exposure duration to avoid banding problems.
public static final int
CONTROL_AE_ANTIBANDING_MODE_50HZ
The camera device will adjust exposure duration to avoid banding problems with 50Hz illumination sources.
public static final int
CONTROL_AE_ANTIBANDING_MODE_60HZ
The camera device will adjust exposure duration to avoid banding problems with 60Hz illumination sources.
public static final int
CONTROL_AE_ANTIBANDING_MODE_AUTO
The camera device will automatically adapt its antibanding routine to the current illumination condition. This is the default mode if AUTO is available on given camera device.
public static final int
CONTROL_AE_MODE_OFF
The camera device's autoexposure routine is disabled.

The application-selected {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity} and {@link CaptureRequest#SENSOR_FRAME_DURATION 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 {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}, {@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock}, and {@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger} for more details.

LEGACY devices do not support the OFF mode and will override attempts to use this value to ON.
public static final int
CONTROL_AE_MODE_ON
The camera device's autoexposure routine is active, with no flash control.

The application's values for {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} are ignored. The application has control over the various android.flash.* fields.
public static final int
CONTROL_AE_MODE_ON_AUTO_FLASH
Like ON, except that the camera device also controls the camera's flash unit, firing it in low-light conditions.

The flash may be fired during a precapture sequence (triggered by {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) and may be fired for captures for which the {@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} field is set to STILL_CAPTURE
public static final int
CONTROL_AE_MODE_ON_ALWAYS_FLASH
Like ON, except that the camera device also controls the camera's flash unit, always firing it for still captures.

The flash may be fired during a precapture sequence (triggered by {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) and will always be fired for captures for which the {@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} field is set to STILL_CAPTURE
public static final int
CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE
Like ON_AUTO_FLASH, but with automatic red eye reduction.

If deemed necessary by the camera device, a red eye reduction flash will fire during the precapture sequence.
public static final int
CONTROL_AE_PRECAPTURE_TRIGGER_IDLE
The trigger is idle.
public static final int
CONTROL_AE_PRECAPTURE_TRIGGER_START
The precapture metering sequence will be started by the camera device.

The exact effect of the precapture trigger depends on the current AE mode and state.
public static final int
CONTROL_AF_MODE_OFF
The auto-focus routine does not control the lens; {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} is controlled by the application.
public static final int
CONTROL_AF_MODE_AUTO
Basic automatic focus mode.

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

Always supported if lens is not fixed focus.

Use {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 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.
public static final int
CONTROL_AF_MODE_MACRO
Close-up focusing mode.

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

When that trigger is activated, AF will transition to ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or NOT_FOCUSED). Triggering cancel AF resets the lens position to default, and sets the AF state to INACTIVE.
public static final int
CONTROL_AF_MODE_CONTINUOUS_VIDEO
In this mode, the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream.

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

Once cancel is received, the algorithm should transition back to INACTIVE and resume passive scan. Note that this behavior is not identical to CONTINUOUS_PICTURE, since an ongoing PASSIVE_SCAN must immediately be canceled.
public static final int
CONTROL_AF_MODE_CONTINUOUS_PICTURE
In this mode, the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream.

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

When the AF cancel trigger is activated, the algorithm should transition back to INACTIVE and then act as if it has just been started.
public static final int
CONTROL_AF_MODE_EDOF
Extended depth of field (digital focus) mode.

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

AF triggers are ignored, and the AF state will always be INACTIVE.
public static final int
CONTROL_AF_TRIGGER_IDLE
The trigger is idle.
public static final int
CONTROL_AF_TRIGGER_START
Autofocus will trigger now.
public static final int
CONTROL_AF_TRIGGER_CANCEL
Autofocus will return to its initial state, and cancel any currently active trigger.
public static final int
CONTROL_AWB_MODE_OFF
The camera device's auto-white balance routine is disabled.

The application-selected color transform matrix ({@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}) and gains ({@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains}) are used by the camera device for manual white balance control.
public static final int
CONTROL_AWB_MODE_AUTO
The camera device's auto-white balance routine is active.

The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} and {@link CaptureRequest#COLOR_CORRECTION_GAINS 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.
public static final 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 {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} and {@link CaptureRequest#COLOR_CORRECTION_GAINS 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.
public static final 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 {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} and {@link CaptureRequest#COLOR_CORRECTION_GAINS 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.
public static final 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 {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} and {@link CaptureRequest#COLOR_CORRECTION_GAINS 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.
public static final 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 {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} and {@link CaptureRequest#COLOR_CORRECTION_GAINS 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.
public static final 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 {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} and {@link CaptureRequest#COLOR_CORRECTION_GAINS 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.
public static final 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 {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} and {@link CaptureRequest#COLOR_CORRECTION_GAINS 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.
public static final 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 {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} and {@link CaptureRequest#COLOR_CORRECTION_GAINS 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.
public static final 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.
public static final 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.
public static final 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.
public static final int
CONTROL_CAPTURE_INTENT_VIDEO_RECORD
This request is for a video recording use case.
public static final 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.
public static final 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.
public static final 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 {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, etc.
public static final int
CONTROL_EFFECT_MODE_OFF
No color effect will be applied.
public static final int
CONTROL_EFFECT_MODE_MONO
A "monocolor" effect where the image is mapped into a single color.

This will typically be grayscale.
public static final int
CONTROL_EFFECT_MODE_NEGATIVE
A "photo-negative" effect where the image's colors are inverted.
public static final int
CONTROL_EFFECT_MODE_SOLARIZE
A "solarisation" effect (Sabattier effect) where the image is wholly or partially reversed in tone.
public static final int
CONTROL_EFFECT_MODE_SEPIA
A "sepia" effect where the image is mapped into warm gray, red, and brown tones.
public static final int
CONTROL_EFFECT_MODE_POSTERIZE
A "posterization" effect where the image uses discrete regions of tone rather than a continuous gradient of tones.
public static final int
CONTROL_EFFECT_MODE_WHITEBOARD
A "whiteboard" effect where the image is typically displayed as regions of white, with black or grey details.
public static final int
CONTROL_EFFECT_MODE_BLACKBOARD
A "blackboard" effect where the image is typically displayed as regions of black, with white or grey details.
public static final int
CONTROL_EFFECT_MODE_AQUA
An "aqua" effect where a blue hue is added to the image.
public static final 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 {@link CaptureRequest#CONTROL_CAPTURE_INTENT 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.
public static final 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.
public static final 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. {@link CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES android.control.availableSceneModes} contain some modes other than DISABLED).
public static final 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.
public static final int
CONTROL_SCENE_MODE_DISABLED
Indicates that no scene modes are set for a given capture request.
public static final 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. {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE 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, {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}, {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} remain active when FACE_PRIORITY is set.
public static final int
CONTROL_SCENE_MODE_ACTION
Optimized for photos of quickly moving objects.

Similar to SPORTS.
public static final int
CONTROL_SCENE_MODE_PORTRAIT
Optimized for still photos of people.
public static final int
CONTROL_SCENE_MODE_LANDSCAPE
Optimized for photos of distant macroscopic objects.
public static final int
CONTROL_SCENE_MODE_NIGHT
Optimized for low-light settings.
public static final int
CONTROL_SCENE_MODE_NIGHT_PORTRAIT
Optimized for still photos of people in low-light settings.
public static final int
CONTROL_SCENE_MODE_THEATRE
Optimized for dim, indoor settings where flash must remain off.
public static final int
CONTROL_SCENE_MODE_BEACH
Optimized for bright, outdoor beach settings.
public static final int
CONTROL_SCENE_MODE_SNOW
Optimized for bright, outdoor settings containing snow.
public static final int
CONTROL_SCENE_MODE_SUNSET
Optimized for scenes of the setting sun.
public static final int
CONTROL_SCENE_MODE_STEADYPHOTO
Optimized to avoid blurry photos due to small amounts of device motion (for example: due to hand shake).
public static final int
CONTROL_SCENE_MODE_FIREWORKS
Optimized for nighttime photos of fireworks.
public static final int
CONTROL_SCENE_MODE_SPORTS
Optimized for photos of quickly moving people.

Similar to ACTION.
public static final int
CONTROL_SCENE_MODE_PARTY
Optimized for dim, indoor settings with multiple moving people.
public static final int
CONTROL_SCENE_MODE_CANDLELIGHT
Optimized for dim settings where the main light source is a flame.
public static final 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.
public static final int
CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO
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 {@link CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE 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 {@link CaptureRequest#CONTROL_MODE android.control.mode} == AUTO. This means that all other android.control.* fields continue to work, such as

{@link CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE android.control.aeTargetFpsRange}

{@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation}

{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock}

{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock}

{@link CaptureRequest#CONTROL_EFFECT_MODE android.control.effectMode}

{@link CaptureRequest#CONTROL_AE_REGIONS android.control.aeRegions}

{@link CaptureRequest#CONTROL_AF_REGIONS android.control.afRegions}

{@link CaptureRequest#CONTROL_AWB_REGIONS android.control.awbRegions}

{@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}

{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}

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

{@link CaptureRequest#FLASH_MODE android.flash.mode} (automatic flash for still capture will not work since aeMode is ON)

{@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode} (if it is supported)

{@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}

{@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode}

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 {@link CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE android.control.aeTargetFpsRange} will be ignored by the camera device, the camera device will fall back to {@link CaptureRequest#CONTROL_MODE 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.
public static final 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 {@link CaptureRequest#CONTROL_CAPTURE_INTENT 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 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.
public static final int
CONTROL_VIDEO_STABILIZATION_MODE_OFF
Video stabilization is disabled.
public static final int
CONTROL_VIDEO_STABILIZATION_MODE_ON
Video stabilization is enabled.
public static final int
EDGE_MODE_OFF
No edge enhancement is applied.
public static final int
EDGE_MODE_FAST
Apply edge enhancement at a quality level that does not slow down frame rate relative to sensor output
public static final int
EDGE_MODE_HIGH_QUALITY
Apply high-quality edge enhancement, at a cost of reducing output frame rate.
public static final int
FLASH_MODE_OFF
Do not fire the flash for this capture.
public static final int
FLASH_MODE_SINGLE
If the flash is available and charged, fire flash for this capture.
public static final int
FLASH_MODE_TORCH
Transition flash to continuously on.
public static final 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 {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.
public static final 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 {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.
public static final int
HOT_PIXEL_MODE_HIGH_QUALITY
High-quality hot pixel correction is applied, at a cost of reducing frame rate relative to sensor raw output.

The hotpixel map may be returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.
public static final int
LENS_OPTICAL_STABILIZATION_MODE_OFF
Optical stabilization is unavailable.
public static final int
LENS_OPTICAL_STABILIZATION_MODE_ON
Optical stabilization is enabled.
public static final int
NOISE_REDUCTION_MODE_OFF
No noise reduction is applied.
public static final int
NOISE_REDUCTION_MODE_FAST
Noise reduction is applied without reducing frame rate relative to sensor output.
public static final int
NOISE_REDUCTION_MODE_HIGH_QUALITY
High-quality noise reduction is applied, at the cost of reducing frame rate relative to sensor output.
public static final 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.
public static final 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 {@link CaptureRequest#SENSOR_TEST_PATTERN_DATA 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.
public static final 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.
public static final 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.
public static final 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.
public static final 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).
public static final int
SHADING_MODE_OFF
No lens shading correction is applied.
public static final int
SHADING_MODE_FAST
Apply lens shading corrections, without slowing frame rate relative to sensor raw output
public static final int
SHADING_MODE_HIGH_QUALITY
Apply high-quality lens shading correction, at the cost of reduced frame rate.
public static final int
STATISTICS_FACE_DETECT_MODE_OFF
Do not include face detection statistics in capture results.
public static final int
STATISTICS_FACE_DETECT_MODE_SIMPLE
Return face rectangle and confidence values only.
public static final int
STATISTICS_FACE_DETECT_MODE_FULL
Return all face metadata.

In this mode, face rectangles, scores, landmarks, and face IDs are all valid.
public static final int
STATISTICS_LENS_SHADING_MAP_MODE_OFF
Do not include a lens shading map in the capture result.
public static final int
STATISTICS_LENS_SHADING_MAP_MODE_ON
Include a lens shading map in the capture result.
public static final int
TONEMAP_MODE_CONTRAST_CURVE
Use the tone mapping curve specified in the {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}* entries.

All color enhancement and tonemapping must be disabled, except for applying the tonemapping curve specified by {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}.

Must not slow down frame rate relative to raw sensor output.
public static final int
TONEMAP_MODE_FAST
Advanced gamma mapping and color enhancement may be applied, without reducing frame rate compared to raw sensor output.
public static final int
TONEMAP_MODE_HIGH_QUALITY
High-quality gamma mapping and color enhancement will be applied, at the cost of reduced frame rate compared to raw sensor output.
public static final int
CONTROL_AE_STATE_INACTIVE
AE is off or recently reset.

When a camera device is opened, it starts in this state. This is a transient state, the camera device may skip reporting this state in capture result.
public static final int
CONTROL_AE_STATE_SEARCHING
AE doesn't yet have a good set of control values for the current scene.

This is a transient state, the camera device may skip reporting this state in capture result.
public static final int
CONTROL_AE_STATE_CONVERGED
AE has a good set of control values for the current scene.
public static final int
CONTROL_AE_STATE_LOCKED
AE has been locked.
public static final int
CONTROL_AE_STATE_FLASH_REQUIRED
AE has a good set of control values, but flash needs to be fired for good quality still capture.
public static final int
CONTROL_AE_STATE_PRECAPTURE
AE has been asked to do a precapture sequence and is currently executing it.

Precapture can be triggered through setting {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} to START.

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.
public static final int
CONTROL_AF_STATE_INACTIVE
AF is off or has not yet tried to scan/been asked to scan.

When a camera device is opened, it starts in this state. This is a transient state, the camera device may skip reporting this state in capture result.
public static final int
CONTROL_AF_STATE_PASSIVE_SCAN
AF is currently performing an AF scan initiated the camera device in a continuous autofocus mode.

Only used by CONTINUOUS_* AF modes. This is a transient state, the camera device may skip reporting this state in capture result.
public static final int
CONTROL_AF_STATE_PASSIVE_FOCUSED
AF currently believes it is in focus, but may restart scanning at any time.

Only used by CONTINUOUS_* AF modes. This is a transient state, the camera device may skip reporting this state in capture result.
public static final int
CONTROL_AF_STATE_ACTIVE_SCAN
AF is performing an AF scan because it was triggered by AF trigger.

Only used by AUTO or MACRO AF modes. This is a transient state, the camera device may skip reporting this state in capture result.
public static final int
CONTROL_AF_STATE_FOCUSED_LOCKED
AF believes it is focused correctly and has locked focus.

This state is reached only after an explicit START AF trigger has been sent ({@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}), when good focus has been obtained.

The lens will remain stationary until the AF mode ({@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}) is changed or a new AF trigger is sent to the camera device ({@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}).
public static final int
CONTROL_AF_STATE_NOT_FOCUSED_LOCKED
AF has failed to focus successfully and has locked focus.

This state is reached only after an explicit START AF trigger has been sent ({@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}), when good focus cannot be obtained.

The lens will remain stationary until the AF mode ({@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}) is changed or a new AF trigger is sent to the camera device ({@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}).
public static final int
CONTROL_AF_STATE_PASSIVE_UNFOCUSED
AF finished a passive scan without finding focus, and may restart scanning at any time.

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

LEGACY camera devices do not support this state. When a passive scan has finished, it will always go to PASSIVE_FOCUSED.
public static final 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.
public static final 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.
public static final int
CONTROL_AWB_STATE_CONVERGED
AWB has a good set of control values for the current scene.
public static final int
CONTROL_AWB_STATE_LOCKED
AWB has been locked.
public static final int
FLASH_STATE_UNAVAILABLE
No flash on camera.
public static final int
FLASH_STATE_CHARGING
Flash is charging and cannot be fired.
public static final int
FLASH_STATE_READY
Flash is ready to fire.
public static final int
FLASH_STATE_FIRED
Flash fired for this capture.
public static final 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.
public static final int
LENS_STATE_STATIONARY
The lens parameters ({@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance}, {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}) are not changing.
public static final int
LENS_STATE_MOVING
One or several of the lens parameters ({@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance}, {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} or {@link CaptureRequest#LENS_APERTURE android.lens.aperture}) is currently changing.
public static final int
STATISTICS_SCENE_FLICKER_NONE
The camera device does not detect any flickering illumination in the current scene.
public static final int
STATISTICS_SCENE_FLICKER_50HZ
The camera device detects illumination flickering at 50Hz in the current scene.
public static final int
STATISTICS_SCENE_FLICKER_60HZ
The camera device detects illumination flickering at 60Hz in the current scene.
public static final int
SYNC_FRAME_NUMBER_CONVERGING
The current result is not yet fully synchronized to any request.

Synchronization is in progress, and reading metadata from this result may include a mix of data that have taken effect since the last synchronization time.

In some future result, within {@link CameraCharacteristics#SYNC_MAX_LATENCY android.sync.maxLatency} frames, this value will update to the actual frame number frame number the result is guaranteed to be synchronized to (as long as the request settings remain constant).
public static final int
SYNC_FRAME_NUMBER_UNKNOWN
The current result's synchronization status is unknown.

The result may have already converged, or it may be in progress. Reading from this result may include some mix of settings from past requests.

After a settings change, the new settings will eventually all take effect for the output buffers and results. However, this value will not change when that happens. Altering settings rapidly may provide outcomes using mixes of settings from recent requests.

This value is intended primarily for backwards compatibility with the older camera implementations (for android.hardware.Camera).
Constructors Summary
protected CameraMetadata()
Set a camera metadata field to a value. The field definitions can be found in {@link CameraCharacteristics}, {@link CaptureResult}, and {@link CaptureRequest}.
param
key The metadata field to write.
param
value The value to set the field to, which must be of a matching type to the key.
hide
Methods Summary
protected abstract java.lang.Class getKeyClass()
hide
public java.util.List 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 {@code UnsupportedOperationException}.

All values retrieved by a key from this list with {@code #get} are guaranteed to be non-{@code null}. Each key is only listed once in the list. The order of the keys is undefined.
return
List of the keys contained in this map.
Class<CameraMetadata<TKey>> thisClass = (Class<CameraMetadata<TKey>>) getClass(); return Collections.unmodifiableList( getKeysStatic(thisClass, getKeyClass(), this, /*filterTags*/null));
static java.util.ArrayList getKeysStatic(java.lang.Class type, java.lang.Class keyClass, android.hardware.camera2.CameraMetadata instance, int[] filterTags)
Return a list of all the Key that are declared as a field inside of the class {@code type}.
Optionally, if {@code instance} is not null, then filter out any keys with null values.

Optionally, if {@code filterTags} is not {@code null}, then filter out any keys whose native {@code tag} is not in {@code filterTags}. The {@code filterTags} array will be sorted as a side effect.
if (VERBOSE) Log.v(TAG, "getKeysStatic for " + type); // TotalCaptureResult does not have any of the keys on it, use CaptureResult instead if (type.equals(TotalCaptureResult.class)) { type = CaptureResult.class; } if (filterTags != null) { Arrays.sort(filterTags); } ArrayList<TKey> keyList = new ArrayList<TKey>(); Field[] fields = type.getDeclaredFields(); for (Field field : fields) { // Filter for Keys that are public if (field.getType().isAssignableFrom(keyClass) && (field.getModifiers() & Modifier.PUBLIC) != 0) { TKey key; try { key = (TKey) field.get(instance); } catch (IllegalAccessException e) { throw new AssertionError("Can't get IllegalAccessException", e); } catch (IllegalArgumentException e) { throw new AssertionError("Can't get IllegalArgumentException", e); } if (instance == null || instance.getProtected(key) != null) { if (shouldKeyBeAdded(key, field, filterTags)) { keyList.add(key); if (VERBOSE) { Log.v(TAG, "getKeysStatic - key was added - " + key); } } else if (VERBOSE) { Log.v(TAG, "getKeysStatic - key was filtered - " + key); } } } } return keyList;
protected abstract T getProtected(TKey key)
Get a camera metadata field value.
The field definitions can be found in {@link CameraCharacteristics}, {@link CaptureResult}, and {@link CaptureRequest}.

Querying the value for the same key more than once will return a value which is equal to the previous queried value.
throws
IllegalArgumentException if the key was not valid
param
key The metadata field to read.
return
The value of that key, or {@code null} if the field is not set.
hide
private static boolean shouldKeyBeAdded(TKey key, java.lang.reflect.Field field, int[] filterTags)
if (key == null) { throw new NullPointerException("key must not be null"); } CameraMetadataNative.Key nativeKey; /* * Get the native key from the public api key */ if (key instanceof CameraCharacteristics.Key) { nativeKey = ((CameraCharacteristics.Key)key).getNativeKey(); } else if (key instanceof CaptureResult.Key) { nativeKey = ((CaptureResult.Key)key).getNativeKey(); } else if (key instanceof CaptureRequest.Key) { nativeKey = ((CaptureRequest.Key)key).getNativeKey(); } else { // Reject fields that aren't a key throw new IllegalArgumentException("key type must be that of a metadata key"); } if (field.getAnnotation(PublicKey.class) == null) { // Never expose @hide keys up to the API user return false; } // No filtering necessary if (filterTags == null) { return true; } if (field.getAnnotation(SyntheticKey.class) != null) { // This key is synthetic, so calling #getTag will throw IAE // TODO: don't just assume all public+synthetic keys are always available return true; } /* * Regular key: look up it's native tag and see if it's in filterTags */ int keyTag = nativeKey.getTag(); // non-negative result is returned iff the value is in the array return Arrays.binarySearch(filterTags, keyTag) >= 0;