TotalCaptureResult


public final class TotalCaptureResult
extends CaptureResult

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


The total assembled results of a single image capture from the image sensor.

Contains the final configuration for the capture hardware (sensor, lens, flash), the processing pipeline, the control algorithms, and the output buffers.

A TotalCaptureResult is produced by a CameraDevice after processing a CaptureRequest. All properties listed for capture requests can also be queried on the capture result, to determine the final values used for capture. The result also includes additional metadata about the state of the camera device during the capture.

All properties returned by CameraCharacteristics.getAvailableCaptureResultKeys() are available (that is CaptureResult.get will return non-null, if and only if that key that was enabled by the request. A few keys such as CaptureResult.STATISTICS_FACES are disabled by default unless enabled with a switch (such as CaptureRequest.STATISTICS_FACE_DETECT_MODE). Refer to each key documentation on a case-by-case basis.

For a logical multi-camera device, if the CaptureRequest contains a surface for an underlying physical camera, the corresponding TotalCaptureResult object will include the metadata for that physical camera. And the mapping between the physical camera id and result metadata can be accessed via getPhysicalCameraResults(). If all requested surfaces are for the logical camera, no metadata for physical camera will be included.

TotalCaptureResult objects are immutable.

Summary

Inherited constants

int AUTOMOTIVE_LENS_FACING_EXTERIOR_FRONT

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

int AUTOMOTIVE_LENS_FACING_EXTERIOR_LEFT

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

int AUTOMOTIVE_LENS_FACING_EXTERIOR_OTHER

The camera device faces the outside of the vehicle body frame but not exactly one of the exterior sides defined by this enum.

int AUTOMOTIVE_LENS_FACING_EXTERIOR_REAR

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

int AUTOMOTIVE_LENS_FACING_EXTERIOR_RIGHT

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

int AUTOMOTIVE_LENS_FACING_INTERIOR_OTHER

The camera device faces the inside of the vehicle body frame but not exactly one of seats described by this enum.

int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_CENTER

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

int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_LEFT

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

int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_1_RIGHT

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

int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_CENTER

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

int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_LEFT

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

int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_2_RIGHT

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

int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_CENTER

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

int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_LEFT

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

int AUTOMOTIVE_LENS_FACING_INTERIOR_SEAT_ROW_3_RIGHT

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

int AUTOMOTIVE_LOCATION_EXTERIOR_FRONT

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

int AUTOMOTIVE_LOCATION_EXTERIOR_LEFT

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

int AUTOMOTIVE_LOCATION_EXTERIOR_OTHER

The camera exists outside of the vehicle body frame but not exactly on one of the exterior locations this enum defines.

int AUTOMOTIVE_LOCATION_EXTERIOR_REAR

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

int AUTOMOTIVE_LOCATION_EXTERIOR_RIGHT

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

int AUTOMOTIVE_LOCATION_EXTRA_FRONT

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

int AUTOMOTIVE_LOCATION_EXTRA_LEFT

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

int AUTOMOTIVE_LOCATION_EXTRA_OTHER

The camera device exists on an extra vehicle, such as the trailer, but not exactly on one of front, rear, left, or right side.

int AUTOMOTIVE_LOCATION_EXTRA_REAR

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

int AUTOMOTIVE_LOCATION_EXTRA_RIGHT

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

int AUTOMOTIVE_LOCATION_INTERIOR

The camera device exists inside of the vehicle cabin.

int COLOR_CORRECTION_ABERRATION_MODE_FAST

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

int COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY

Aberration correction operates at improved quality but the capture rate might be reduced (relative to sensor raw output rate)

int COLOR_CORRECTION_ABERRATION_MODE_OFF

No aberration correction is applied.

int COLOR_CORRECTION_MODE_FAST

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

int COLOR_CORRECTION_MODE_HIGH_QUALITY

Color correction processing operates at improved quality but the capture rate might be reduced (relative to sensor raw output rate)

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

int COLOR_CORRECTION_MODE_TRANSFORM_MATRIX

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

int CONTROL_AE_ANTIBANDING_MODE_50HZ

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

int CONTROL_AE_ANTIBANDING_MODE_60HZ

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

int CONTROL_AE_ANTIBANDING_MODE_AUTO

The camera device will automatically adapt its antibanding routine to the current illumination condition.

int CONTROL_AE_ANTIBANDING_MODE_OFF

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

int CONTROL_AE_MODE_OFF

The camera device's autoexposure routine is disabled.

int CONTROL_AE_MODE_ON

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

int CONTROL_AE_MODE_ON_ALWAYS_FLASH

Like ON, except that the camera device also controls the camera's flash unit, always firing it for still captures.

int CONTROL_AE_MODE_ON_AUTO_FLASH

Like ON, except that the camera device also controls the camera's flash unit, firing it in low-light conditions.

int CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE

Like ON_AUTO_FLASH, but with automatic red eye reduction.

int CONTROL_AE_MODE_ON_EXTERNAL_FLASH

An external flash has been turned on.

int CONTROL_AE_MODE_ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY

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

int CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL

The camera device will cancel any currently active or completed precapture metering sequence, the auto-exposure routine will return to its initial state.

int CONTROL_AE_PRECAPTURE_TRIGGER_IDLE

The trigger is idle.

int CONTROL_AE_PRECAPTURE_TRIGGER_START

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

int CONTROL_AE_STATE_CONVERGED

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

int CONTROL_AE_STATE_FLASH_REQUIRED

AE has a good set of control values, but flash needs to be fired for good quality still capture.

int CONTROL_AE_STATE_INACTIVE

AE is off or recently reset.

int CONTROL_AE_STATE_LOCKED

AE has been locked.

int CONTROL_AE_STATE_PRECAPTURE

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

int CONTROL_AE_STATE_SEARCHING

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

int CONTROL_AF_MODE_AUTO

Basic automatic focus mode.

int CONTROL_AF_MODE_CONTINUOUS_PICTURE

In this mode, the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream.

int CONTROL_AF_MODE_CONTINUOUS_VIDEO

In this mode, the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream.

int CONTROL_AF_MODE_EDOF

Extended depth of field (digital focus) mode.

int CONTROL_AF_MODE_MACRO

Close-up focusing mode.

int CONTROL_AF_MODE_OFF

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

int CONTROL_AF_SCENE_CHANGE_DETECTED

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

int CONTROL_AF_SCENE_CHANGE_NOT_DETECTED

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

int CONTROL_AF_STATE_ACTIVE_SCAN

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

int CONTROL_AF_STATE_FOCUSED_LOCKED

AF believes it is focused correctly and has locked focus.

int CONTROL_AF_STATE_INACTIVE

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

int CONTROL_AF_STATE_NOT_FOCUSED_LOCKED

AF has failed to focus successfully and has locked focus.

int CONTROL_AF_STATE_PASSIVE_FOCUSED

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

int CONTROL_AF_STATE_PASSIVE_SCAN

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

int CONTROL_AF_STATE_PASSIVE_UNFOCUSED

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

int CONTROL_AF_TRIGGER_CANCEL

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

int CONTROL_AF_TRIGGER_IDLE

The trigger is idle.

int CONTROL_AF_TRIGGER_START

Autofocus will trigger now.

int CONTROL_AUTOFRAMING_OFF

Disable autoframing.

int CONTROL_AUTOFRAMING_ON

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

int CONTROL_AUTOFRAMING_STATE_CONVERGED

Auto-framing has reached a stable state (frame/fov is not being adjusted).

int CONTROL_AUTOFRAMING_STATE_FRAMING

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

int CONTROL_AUTOFRAMING_STATE_INACTIVE

Auto-framing is inactive.

int CONTROL_AWB_MODE_AUTO

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

int CONTROL_AWB_MODE_CLOUDY_DAYLIGHT

The camera device's auto-white balance routine is disabled; the camera device uses cloudy daylight light as the assumed scene illumination for white balance.

int CONTROL_AWB_MODE_DAYLIGHT

The camera device's auto-white balance routine is disabled; the camera device uses daylight light as the assumed scene illumination for white balance.

int CONTROL_AWB_MODE_FLUORESCENT

The camera device's auto-white balance routine is disabled; the camera device uses fluorescent light as the assumed scene illumination for white balance.

int CONTROL_AWB_MODE_INCANDESCENT

The camera device's auto-white balance routine is disabled; the camera device uses incandescent light as the assumed scene illumination for white balance.

int CONTROL_AWB_MODE_OFF

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

int CONTROL_AWB_MODE_SHADE

The camera device's auto-white balance routine is disabled; the camera device uses shade light as the assumed scene illumination for white balance.

int CONTROL_AWB_MODE_TWILIGHT

The camera device's auto-white balance routine is disabled; the camera device uses twilight light as the assumed scene illumination for white balance.

int CONTROL_AWB_MODE_WARM_FLUORESCENT

The camera device's auto-white balance routine is disabled; the camera device uses warm fluorescent light as the assumed scene illumination for white balance.

int CONTROL_AWB_STATE_CONVERGED

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

int CONTROL_AWB_STATE_INACTIVE

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

int CONTROL_AWB_STATE_LOCKED

AWB has been locked.

int CONTROL_AWB_STATE_SEARCHING

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

int CONTROL_CAPTURE_INTENT_CUSTOM

The goal of this request doesn't fall into the other categories.

int CONTROL_CAPTURE_INTENT_MANUAL

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

int CONTROL_CAPTURE_INTENT_MOTION_TRACKING

This request is for a motion tracking use case, where the application will use camera and inertial sensor data to locate and track objects in the world.

int CONTROL_CAPTURE_INTENT_PREVIEW

This request is for a preview-like use case.

int CONTROL_CAPTURE_INTENT_STILL_CAPTURE

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

int CONTROL_CAPTURE_INTENT_VIDEO_RECORD

This request is for a video recording use case.

int CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT

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

int CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG

This request is for a ZSL usecase; the application will stream full-resolution images and reprocess one or several later for a final capture.

int CONTROL_EFFECT_MODE_AQUA

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

int CONTROL_EFFECT_MODE_BLACKBOARD

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

int CONTROL_EFFECT_MODE_MONO

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

int CONTROL_EFFECT_MODE_NEGATIVE

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

int CONTROL_EFFECT_MODE_OFF

No color effect will be applied.

int CONTROL_EFFECT_MODE_POSTERIZE

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

int CONTROL_EFFECT_MODE_SEPIA

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

int CONTROL_EFFECT_MODE_SOLARIZE

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

int CONTROL_EFFECT_MODE_WHITEBOARD

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

int CONTROL_EXTENDED_SCENE_MODE_BOKEH_CONTINUOUS

Bokeh effect must not slow down capture rate relative to sensor raw output, and the effect is applied to all processed streams no larger than the maximum streaming dimension.

int CONTROL_EXTENDED_SCENE_MODE_BOKEH_STILL_CAPTURE

High quality bokeh mode is enabled for all non-raw streams (including YUV, JPEG, and IMPLEMENTATION_DEFINED) when capture intent is STILL_CAPTURE.

int CONTROL_EXTENDED_SCENE_MODE_DISABLED

Extended scene mode is disabled.

int CONTROL_LOW_LIGHT_BOOST_STATE_ACTIVE

The AE mode 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY' is enabled and applied.

int CONTROL_LOW_LIGHT_BOOST_STATE_INACTIVE

The AE mode 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY' is enabled but not applied.

int CONTROL_MODE_AUTO

Use settings for each individual 3A routine.

int CONTROL_MODE_OFF

Full application control of pipeline.

int CONTROL_MODE_OFF_KEEP_STATE

Same as OFF mode, except that this capture will not be used by camera device background auto-exposure, auto-white balance and auto-focus algorithms (3A) to update their statistics.

int CONTROL_MODE_USE_EXTENDED_SCENE_MODE

Use a specific extended scene mode.

int CONTROL_MODE_USE_SCENE_MODE

Use a specific scene mode.

int CONTROL_SCENE_MODE_ACTION

Optimized for photos of quickly moving objects.

int CONTROL_SCENE_MODE_BARCODE

Optimized for accurately capturing a photo of barcode for use by camera applications that wish to read the barcode value.

int CONTROL_SCENE_MODE_BEACH

Optimized for bright, outdoor beach settings.

int CONTROL_SCENE_MODE_CANDLELIGHT

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

int CONTROL_SCENE_MODE_DISABLED

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

int CONTROL_SCENE_MODE_FACE_PRIORITY

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

int CONTROL_SCENE_MODE_FIREWORKS

Optimized for nighttime photos of fireworks.

int CONTROL_SCENE_MODE_HDR

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

int CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO

This constant was deprecated in API level 23. Please refer to this API documentation to find the alternatives

int CONTROL_SCENE_MODE_LANDSCAPE

Optimized for photos of distant macroscopic objects.

int CONTROL_SCENE_MODE_NIGHT

Optimized for low-light settings.

int CONTROL_SCENE_MODE_NIGHT_PORTRAIT

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

int CONTROL_SCENE_MODE_PARTY

Optimized for dim, indoor settings with multiple moving people.

int CONTROL_SCENE_MODE_PORTRAIT

Optimized for still photos of people.

int CONTROL_SCENE_MODE_SNOW

Optimized for bright, outdoor settings containing snow.

int CONTROL_SCENE_MODE_SPORTS

Optimized for photos of quickly moving people.

int CONTROL_SCENE_MODE_STEADYPHOTO

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

int CONTROL_SCENE_MODE_SUNSET

Optimized for scenes of the setting sun.

int CONTROL_SCENE_MODE_THEATRE

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

int CONTROL_SETTINGS_OVERRIDE_OFF

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

int CONTROL_SETTINGS_OVERRIDE_ZOOM

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

int CONTROL_VIDEO_STABILIZATION_MODE_OFF

Video stabilization is disabled.

int CONTROL_VIDEO_STABILIZATION_MODE_ON

Video stabilization is enabled.

int CONTROL_VIDEO_STABILIZATION_MODE_PREVIEW_STABILIZATION

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

int DISTORTION_CORRECTION_MODE_FAST

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

int DISTORTION_CORRECTION_MODE_HIGH_QUALITY

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

int DISTORTION_CORRECTION_MODE_OFF

No distortion correction is applied.

int EDGE_MODE_FAST

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

int EDGE_MODE_HIGH_QUALITY

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

int EDGE_MODE_OFF

No edge enhancement is applied.

int EDGE_MODE_ZERO_SHUTTER_LAG

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

int EXTENSION_NIGHT_MODE_INDICATOR_OFF

The camera has detected lighting conditions that are sufficiently bright.

int EXTENSION_NIGHT_MODE_INDICATOR_ON

The camera has detected low-light conditions.

int EXTENSION_NIGHT_MODE_INDICATOR_UNKNOWN

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

int FLASH_MODE_OFF

Do not fire the flash for this capture.

int FLASH_MODE_SINGLE

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

int FLASH_MODE_TORCH

Transition flash to continuously on.

int FLASH_STATE_CHARGING

Flash is charging and cannot be fired.

int FLASH_STATE_FIRED

Flash fired for this capture.

int FLASH_STATE_PARTIAL

Flash partially illuminated this frame.

int FLASH_STATE_READY

Flash is ready to fire.

int FLASH_STATE_UNAVAILABLE

No flash on camera.

int HOT_PIXEL_MODE_FAST

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

int HOT_PIXEL_MODE_HIGH_QUALITY

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

int HOT_PIXEL_MODE_OFF

No hot pixel correction is applied.

int INFO_SUPPORTED_HARDWARE_LEVEL_3

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

int INFO_SUPPORTED_HARDWARE_LEVEL_EXTERNAL

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

int INFO_SUPPORTED_HARDWARE_LEVEL_FULL

This camera device is capable of supporting advanced imaging applications.

int INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY

This camera device is running in backward compatibility mode.

int INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED

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

int LENS_FACING_BACK

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

int LENS_FACING_EXTERNAL

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

int LENS_FACING_FRONT

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

int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_APPROXIMATE

The lens focus distance is measured in diopters.

int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_CALIBRATED

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

int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_UNCALIBRATED

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

int LENS_OPTICAL_STABILIZATION_MODE_OFF

Optical stabilization is unavailable.

int LENS_OPTICAL_STABILIZATION_MODE_ON

Optical stabilization is enabled.

int LENS_POSE_REFERENCE_AUTOMOTIVE

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

int LENS_POSE_REFERENCE_GYROSCOPE

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

int LENS_POSE_REFERENCE_PRIMARY_CAMERA

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

int LENS_POSE_REFERENCE_UNDEFINED

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

int LENS_STATE_MOVING

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

int LENS_STATE_STATIONARY

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

int LOGICAL_MULTI_CAMERA_SENSOR_SYNC_TYPE_APPROXIMATE

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

int LOGICAL_MULTI_CAMERA_SENSOR_SYNC_TYPE_CALIBRATED

The camera device supports frame timestamp synchronization at the hardware level, and the timestamp of a physical stream image accurately reflects its start-of-exposure time.

int NOISE_REDUCTION_MODE_FAST

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

int NOISE_REDUCTION_MODE_HIGH_QUALITY

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

int NOISE_REDUCTION_MODE_MINIMAL

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

int NOISE_REDUCTION_MODE_OFF

No noise reduction is applied.

int NOISE_REDUCTION_MODE_ZERO_SHUTTER_LAG

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

int REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE

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

int REQUEST_AVAILABLE_CAPABILITIES_BURST_CAPTURE

The camera device supports capturing high-resolution images at >= 20 frames per second, in at least the uncompressed YUV format, when post-processing settings are set to FAST.

int REQUEST_AVAILABLE_CAPABILITIES_COLOR_SPACE_PROFILES

The device supports querying the possible combinations of color spaces, image formats, and dynamic range profiles supported by the camera and requesting a particular color space for a session via SessionConfiguration.setColorSpace(Named).

int REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO

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

int REQUEST_AVAILABLE_CAPABILITIES_DEPTH_OUTPUT

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

int REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT

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

int REQUEST_AVAILABLE_CAPABILITIES_LOGICAL_MULTI_CAMERA

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

int REQUEST_AVAILABLE_CAPABILITIES_MANUAL_POST_PROCESSING

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

int REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR

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

int REQUEST_AVAILABLE_CAPABILITIES_MONOCHROME

The camera device is a monochrome camera that doesn't contain a color filter array, and for YUV_420_888 stream, the pixel values on U and V planes are all 128.

int REQUEST_AVAILABLE_CAPABILITIES_MOTION_TRACKING

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

int REQUEST_AVAILABLE_CAPABILITIES_OFFLINE_PROCESSING

The camera device supports the OFFLINE_PROCESSING use case.

int REQUEST_AVAILABLE_CAPABILITIES_PRIVATE_REPROCESSING

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

int REQUEST_AVAILABLE_CAPABILITIES_RAW

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

int REQUEST_AVAILABLE_CAPABILITIES_READ_SENSOR_SETTINGS

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

int REQUEST_AVAILABLE_CAPABILITIES_REMOSAIC_REPROCESSING

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

int REQUEST_AVAILABLE_CAPABILITIES_SECURE_IMAGE_DATA

The camera device is capable of writing image data into a region of memory inaccessible to Android userspace or the Android kernel, and only accessible to trusted execution environments (TEE).

int REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE

The camera device supports selecting a per-stream use case via OutputConfiguration.setStreamUseCase(long) so that the device can optimize camera pipeline parameters such as tuning, sensor mode, or ISP settings for a specific user scenario.

int REQUEST_AVAILABLE_CAPABILITIES_SYSTEM_CAMERA

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

int REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR

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

int REQUEST_AVAILABLE_CAPABILITIES_YUV_REPROCESSING

The camera device supports the YUV_420_888 reprocessing use case, similar as PRIVATE_REPROCESSING, This capability requires the camera device to support the following:

int SCALER_AVAILABLE_STREAM_USE_CASES_CROPPED_RAW

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

int SCALER_AVAILABLE_STREAM_USE_CASES_DEFAULT

Default stream use case.

int SCALER_AVAILABLE_STREAM_USE_CASES_PREVIEW

Live stream shown to the user.

int SCALER_AVAILABLE_STREAM_USE_CASES_PREVIEW_VIDEO_STILL

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

int SCALER_AVAILABLE_STREAM_USE_CASES_STILL_CAPTURE

Still photo capture.

int SCALER_AVAILABLE_STREAM_USE_CASES_VIDEO_CALL

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

int SCALER_AVAILABLE_STREAM_USE_CASES_VIDEO_RECORD

Recording video clips.

int SCALER_CROPPING_TYPE_CENTER_ONLY

The camera device only supports centered crop regions.

int SCALER_CROPPING_TYPE_FREEFORM

The camera device supports arbitrarily chosen crop regions.

int SCALER_ROTATE_AND_CROP_180

Processed images are rotated by 180 degrees.

int SCALER_ROTATE_AND_CROP_270

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

int SCALER_ROTATE_AND_CROP_90

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

int SCALER_ROTATE_AND_CROP_AUTO

The camera API automatically selects the best concrete value for rotate-and-crop based on the application's support for resizability and the current multi-window mode.

int SCALER_ROTATE_AND_CROP_NONE

No rotate and crop is applied.

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_BGGR

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GBRG

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GRBG

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_MONO

Sensor doesn't have any Bayer color filter.

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_NIR

Sensor has a near infrared filter capturing light with wavelength between roughly 750nm and 1400nm, and the same filter covers the whole sensor array.

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGB

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

int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGGB

int SENSOR_INFO_TIMESTAMP_SOURCE_REALTIME

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

int SENSOR_INFO_TIMESTAMP_SOURCE_UNKNOWN

Timestamps from android.sensor.timestamp are in nanoseconds and monotonic, but can not be compared to timestamps from other subsystems (e.g.

int SENSOR_PIXEL_MODE_DEFAULT

This is the default sensor pixel mode.

int SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION

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

int SENSOR_READOUT_TIMESTAMP_HARDWARE

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

int SENSOR_READOUT_TIMESTAMP_NOT_SUPPORTED

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

int SENSOR_REFERENCE_ILLUMINANT1_CLOUDY_WEATHER

int SENSOR_REFERENCE_ILLUMINANT1_COOL_WHITE_FLUORESCENT

W 3900 - 4500K

int SENSOR_REFERENCE_ILLUMINANT1_D50

int SENSOR_REFERENCE_ILLUMINANT1_D55

int SENSOR_REFERENCE_ILLUMINANT1_D65

int SENSOR_REFERENCE_ILLUMINANT1_D75

int SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT

int SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT_FLUORESCENT

D 5700 - 7100K

int SENSOR_REFERENCE_ILLUMINANT1_DAY_WHITE_FLUORESCENT

N 4600 - 5400K

int SENSOR_REFERENCE_ILLUMINANT1_FINE_WEATHER

int SENSOR_REFERENCE_ILLUMINANT1_FLASH

int SENSOR_REFERENCE_ILLUMINANT1_FLUORESCENT

int SENSOR_REFERENCE_ILLUMINANT1_ISO_STUDIO_TUNGSTEN

int SENSOR_REFERENCE_ILLUMINANT1_SHADE

int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_A

int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_B

int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_C

int SENSOR_REFERENCE_ILLUMINANT1_TUNGSTEN

Incandescent light

int SENSOR_REFERENCE_ILLUMINANT1_WHITE_FLUORESCENT

WW 3200 - 3700K

int SENSOR_TEST_PATTERN_MODE_COLOR_BARS

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

int SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY

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

int SENSOR_TEST_PATTERN_MODE_CUSTOM1

The first custom test pattern.

int SENSOR_TEST_PATTERN_MODE_OFF

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

int SENSOR_TEST_PATTERN_MODE_PN9

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

int SENSOR_TEST_PATTERN_MODE_SOLID_COLOR

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

int SHADING_MODE_FAST

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

int SHADING_MODE_HIGH_QUALITY

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

int SHADING_MODE_OFF

No lens shading correction is applied.

int STATISTICS_FACE_DETECT_MODE_FULL

Return all face metadata.

int STATISTICS_FACE_DETECT_MODE_OFF

Do not include face detection statistics in capture results.

int STATISTICS_FACE_DETECT_MODE_SIMPLE

Return face rectangle and confidence values only.

int STATISTICS_LENS_SHADING_MAP_MODE_OFF

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

int STATISTICS_LENS_SHADING_MAP_MODE_ON

Include a lens shading map in the capture result.

int STATISTICS_OIS_DATA_MODE_OFF

Do not include OIS data in the capture result.

int STATISTICS_OIS_DATA_MODE_ON

Include OIS data in the capture result.

int STATISTICS_SCENE_FLICKER_50HZ

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

int STATISTICS_SCENE_FLICKER_60HZ

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

int STATISTICS_SCENE_FLICKER_NONE

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

int SYNC_MAX_LATENCY_PER_FRAME_CONTROL

Every frame has the requests immediately applied.

int SYNC_MAX_LATENCY_UNKNOWN

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

int TONEMAP_MODE_CONTRAST_CURVE

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

int TONEMAP_MODE_FAST

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

int TONEMAP_MODE_GAMMA_VALUE

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

int TONEMAP_MODE_HIGH_QUALITY

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

int TONEMAP_MODE_PRESET_CURVE

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

int TONEMAP_PRESET_CURVE_REC709

Tonemapping curve is defined by ITU-R BT.709

int TONEMAP_PRESET_CURVE_SRGB

Tonemapping curve is defined by sRGB

Inherited fields

public static final Key<Boolean> BLACK_LEVEL_LOCK

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

public static final Key<Integer> COLOR_CORRECTION_ABERRATION_MODE

Mode of operation for the chromatic aberration correction algorithm.

public static final Key<RggbChannelVector> COLOR_CORRECTION_GAINS

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

public static final Key<Integer> COLOR_CORRECTION_MODE

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

public static final Key<ColorSpaceTransform> COLOR_CORRECTION_TRANSFORM

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

public static final Key<Integer> CONTROL_AE_ANTIBANDING_MODE

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

public static final Key<Integer> CONTROL_AE_EXPOSURE_COMPENSATION

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

public static final Key<Boolean> CONTROL_AE_LOCK

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

public static final Key<Integer> CONTROL_AE_MODE

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

public static final Key<Integer> CONTROL_AE_PRECAPTURE_TRIGGER

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

public static final Key<MeteringRectangle[]> CONTROL_AE_REGIONS

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

public static final Key<Integer> CONTROL_AE_STATE

Current state of the auto-exposure (AE) algorithm.

public static final Key<Range<Integer>> CONTROL_AE_TARGET_FPS_RANGE

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

public static final Key<Integer> CONTROL_AF_MODE

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

public static final Key<MeteringRectangle[]> CONTROL_AF_REGIONS

List of metering areas to use for auto-focus.

public static final Key<Integer> CONTROL_AF_SCENE_CHANGE

Whether a significant scene change is detected within the currently-set AF region(s).

public static final Key<Integer> CONTROL_AF_STATE

Current state of auto-focus (AF) algorithm.

public static final Key<Integer> CONTROL_AF_TRIGGER

Whether the camera device will trigger autofocus for this request.

public static final Key<Integer> CONTROL_AUTOFRAMING

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

public static final Key<Integer> CONTROL_AUTOFRAMING_STATE

Current state of auto-framing.

public static final Key<Boolean> CONTROL_AWB_LOCK

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

public static final Key<Integer> CONTROL_AWB_MODE

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

public static final Key<MeteringRectangle[]> CONTROL_AWB_REGIONS

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

public static final Key<Integer> CONTROL_AWB_STATE

Current state of auto-white balance (AWB) algorithm.

public static final Key<Integer> CONTROL_CAPTURE_INTENT

Information to the camera device 3A (auto-exposure, auto-focus, auto-white balance) routines about the purpose of this capture, to help the camera device to decide optimal 3A strategy.

public static final Key<Integer> CONTROL_EFFECT_MODE

A special color effect to apply.

public static final Key<Boolean> CONTROL_ENABLE_ZSL

Allow camera device to enable zero-shutter-lag mode for requests with android.control.captureIntent == STILL_CAPTURE.

public static final Key<Integer> CONTROL_EXTENDED_SCENE_MODE

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

public static final Key<Integer> CONTROL_LOW_LIGHT_BOOST_STATE

Current state of the low light boost AE mode.

public static final Key<Integer> CONTROL_MODE

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

public static final Key<Integer> CONTROL_POST_RAW_SENSITIVITY_BOOST

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

public static final Key<Integer> CONTROL_SCENE_MODE

Control for which scene mode is currently active.

public static final Key<Integer> CONTROL_SETTINGS_OVERRIDE

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

public static final Key<Integer> CONTROL_VIDEO_STABILIZATION_MODE

Whether video stabilization is active.

public static final Key<Float> CONTROL_ZOOM_RATIO

The desired zoom ratio

Instead of using android.scaler.cropRegion for zoom, the application can now choose to use this tag to specify the desired zoom level.

public static final Key<Integer> DISTORTION_CORRECTION_MODE

Mode of operation for the lens distortion correction block.

public static final Key<Integer> EDGE_MODE

Operation mode for edge enhancement.

public static final Key<Integer> EXTENSION_CURRENT_TYPE

Contains the extension type of the currently active extension

The capture result will only be supported and included by camera extension sessions.

public static final Key<Integer> EXTENSION_NIGHT_MODE_INDICATOR

Indicates when to activate Night Mode Camera Extension for high-quality still captures in low-light conditions.

public static final Key<Integer> EXTENSION_STRENGTH

Strength of the extension post-processing effect

This control allows Camera extension clients to configure the strength of the applied extension effect.

public static final Key<Integer> FLASH_MODE

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

public static final Key<Integer> FLASH_STATE

Current state of the flash unit.

public static final Key<Integer> FLASH_STRENGTH_LEVEL

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

public static final Key<Integer> HOT_PIXEL_MODE

Operational mode for hot pixel correction.

public static final Key<Location> JPEG_GPS_LOCATION

A location object to use when generating image GPS metadata.

public static final Key<Integer> JPEG_ORIENTATION

The orientation for a JPEG image.

public static final Key<Byte> JPEG_QUALITY

Compression quality of the final JPEG image.

public static final Key<Byte> JPEG_THUMBNAIL_QUALITY

Compression quality of JPEG thumbnail.

public static final Key<Size> JPEG_THUMBNAIL_SIZE

Resolution of embedded JPEG thumbnail.

public static final Key<Float> LENS_APERTURE

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

public static final Key<float[]> LENS_DISTORTION

The correction coefficients to correct for this camera device's radial and tangential lens distortion.

public static final Key<Float> LENS_FILTER_DENSITY

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

public static final Key<Float> LENS_FOCAL_LENGTH

The desired lens focal length; used for optical zoom.

public static final Key<Float> LENS_FOCUS_DISTANCE

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

public static final Key<Pair<FloatFloat>> LENS_FOCUS_RANGE

The range of scene distances that are in sharp focus (depth of field).

public static final Key<float[]> LENS_INTRINSIC_CALIBRATION

The parameters for this camera device's intrinsic calibration.

public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE

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

public static final Key<float[]> LENS_POSE_ROTATION

The orientation of the camera relative to the sensor coordinate system.

public static final Key<float[]> LENS_POSE_TRANSLATION

Position of the camera optical center.

public static final Key<float[]> LENS_RADIAL_DISTORTION

This field was deprecated in API level 28.

This field was inconsistently defined in terms of its normalization. Use android.lens.distortion instead.

public static final Key<Integer> LENS_STATE

Current lens status.

public static final Key<String> LOGICAL_MULTI_CAMERA_ACTIVE_PHYSICAL_ID

String containing the ID of the underlying active physical camera.

public static final Key<Rect> LOGICAL_MULTI_CAMERA_ACTIVE_PHYSICAL_SENSOR_CROP_REGION

The current region of the active physical sensor that will be read out for this capture.

public static final Key<Integer> NOISE_REDUCTION_MODE

Mode of operation for the noise reduction algorithm.

public static final Key<Float> REPROCESS_EFFECTIVE_EXPOSURE_FACTOR

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

public static final Key<Byte> REQUEST_PIPELINE_DEPTH

Specifies the number of pipeline stages the frame went through from when it was exposed to when the final completed result was available to the framework.

public static final Key<Rect> SCALER_CROP_REGION

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

public static final Key<Rect> SCALER_RAW_CROP_REGION

The region of the sensor that corresponds to the RAW read out for this capture when the stream use case of a RAW stream is set to CROPPED_RAW.

public static final Key<Integer> SCALER_ROTATE_AND_CROP

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

public static final Key<float[]> SENSOR_DYNAMIC_BLACK_LEVEL

A per-frame dynamic black level offset for each of the color filter arrangement (CFA) mosaic channels.

public static final Key<Integer> SENSOR_DYNAMIC_WHITE_LEVEL

Maximum raw value output by sensor for this frame.

public static final Key<Long> SENSOR_EXPOSURE_TIME

Duration each pixel is exposed to light.

public static final Key<Long> SENSOR_FRAME_DURATION

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

public static final Key<Float> SENSOR_GREEN_SPLIT

The worst-case divergence between Bayer green channels.

public static final Key<Rational[]> SENSOR_NEUTRAL_COLOR_POINT

The estimated camera neutral color in the native sensor colorspace at the time of capture.

public static final Key<Pair[]<DoubleDouble>> SENSOR_NOISE_PROFILE

Noise model coefficients for each CFA mosaic channel.

public static final Key<Integer> SENSOR_PIXEL_MODE

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

public static final Key<Boolean> SENSOR_RAW_BINNING_FACTOR_USED

Whether RAW images requested have their bayer pattern as described by android.sensor.info.binningFactor.

public static final Key<Long> SENSOR_ROLLING_SHUTTER_SKEW

Duration between the start of exposure for the first row of the image sensor, and the start of exposure for one past the last row of the image sensor.

public static final Key<Integer> SENSOR_SENSITIVITY

The amount of gain applied to sensor data before processing.

public static final Key<int[]> SENSOR_TEST_PATTERN_DATA

A pixel [R, G_even, G_odd, B] that supplies the test pattern when android.sensor.testPatternMode is SOLID_COLOR.

public static final Key<Integer> SENSOR_TEST_PATTERN_MODE

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

public static final Key<Long> SENSOR_TIMESTAMP

Time at start of exposure of first row of the image sensor active array, in nanoseconds.

public static final Key<Integer> SHADING_MODE

Quality of lens shading correction applied to the image data.

public static final Key<Face[]> STATISTICS_FACES

List of the faces detected through camera face detection in this capture.

public static final Key<Integer> STATISTICS_FACE_DETECT_MODE

Operating mode for the face detector unit.

public static final Key<Point[]> STATISTICS_HOT_PIXEL_MAP

List of (x, y) coordinates of hot/defective pixels on the sensor.

public static final Key<Boolean> STATISTICS_HOT_PIXEL_MAP_MODE

Operating mode for hot pixel map generation.

public static final Key<LensIntrinsicsSample[]> STATISTICS_LENS_INTRINSICS_SAMPLES

An array of intra-frame lens intrinsic samples.

public static final Key<LensShadingMap> STATISTICS_LENS_SHADING_CORRECTION_MAP

The shading map is a low-resolution floating-point map that lists the coefficients used to correct for vignetting, for each Bayer color channel.

public static final Key<Integer> STATISTICS_LENS_SHADING_MAP_MODE

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

public static final Key<Integer> STATISTICS_OIS_DATA_MODE

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

public static final Key<OisSample[]> STATISTICS_OIS_SAMPLES

An array of optical stabilization (OIS) position samples.

public static final Key<Integer> STATISTICS_SCENE_FLICKER

The camera device estimated scene illumination lighting frequency.

public static final Key<TonemapCurve> TONEMAP_CURVE

Tonemapping / contrast / gamma curve to use when android.tonemap.mode is CONTRAST_CURVE.

public static final Key<Float> TONEMAP_GAMMA

Tonemapping curve to use when android.tonemap.mode is GAMMA_VALUE

The tonemap curve will be defined the following formula:

  • OUT = pow(IN, 1.0 / gamma)

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

public static final Key<Integer> TONEMAP_MODE

High-level global contrast/gamma/tonemapping control.

public static final Key<Integer> TONEMAP_PRESET_CURVE

Tonemapping curve to use when android.tonemap.mode is PRESET_CURVE

The tonemap curve will be defined by specified standard.

Public methods

List<CaptureResult> getPartialResults()

Get the read-only list of partial results that compose this total result.

Map<StringCaptureResult> getPhysicalCameraResults()

This method was deprecated in API level 31.

Please use getPhysicalCameraTotalResults() instead to get the physical cameras' TotalCaptureResult.

Map<StringTotalCaptureResult> getPhysicalCameraTotalResults()

Get the map between physical camera ids and their total capture result metadata

This function can be called for logical multi-camera devices, which are devices that have REQUEST_AVAILABLE_CAPABILITIES_LOGICAL_MULTI_CAMERA capability.

Inherited methods

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

Get a capture result field value.

String getCameraId()

Get the camera ID of the camera that produced this capture result.

long getFrameNumber()

Get the frame number associated with this result.

List<Key<?>> getKeys()

Returns a list of the keys contained in this map.

CaptureRequest getRequest()

Get the request associated with this result.

int getSequenceId()

The sequence ID for this failure that was returned by the CameraCaptureSession.capture family of functions.

List<Key<?>> getKeys()

Returns a list of the keys contained in this map.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

getPartialResults

Added in API level 21
public List<CaptureResult> getPartialResults ()

Get the read-only list of partial results that compose this total result.

The list is returned is unmodifiable; attempting to modify it will result in a UnsupportedOperationException being thrown.

The list size will be inclusive between 0 and CameraCharacteristics.REQUEST_PARTIAL_RESULT_COUNT, with elements in ascending order of when CameraCaptureSession.CaptureCallback.onCaptureProgressed was invoked.

Returns
List<CaptureResult> unmodifiable list of partial results This value cannot be null.

getPhysicalCameraResults

Added in API level 28
Deprecated in API level 31
public Map<StringCaptureResult> getPhysicalCameraResults ()

This method was deprecated in API level 31.

Please use getPhysicalCameraTotalResults() instead to get the physical cameras' TotalCaptureResult.

Get the map between physical camera ids and their capture result metadata

This function can be called for logical multi-camera devices, which are devices that have REQUEST_AVAILABLE_CAPABILITIES_LOGICAL_MULTI_CAMERA capability and calls to CameraCharacteristics.getPhysicalCameraIds() return a non-empty set of physical devices that are backing the logical camera.

If one or more streams from the underlying physical cameras were requested by the corresponding capture request, this function returns the result metadata for those physical cameras. Otherwise, an empty map is returned.

Returns
Map<StringCaptureResult> unmodifiable map between physical camera ids and their capture result metadata

getPhysicalCameraTotalResults

Added in API level 31
public Map<StringTotalCaptureResult> getPhysicalCameraTotalResults ()

Get the map between physical camera ids and their total capture result metadata

This function can be called for logical multi-camera devices, which are devices that have REQUEST_AVAILABLE_CAPABILITIES_LOGICAL_MULTI_CAMERA capability.

If one or more streams from the underlying physical cameras were requested by the corresponding capture request, this function returns the total result metadata for those physical cameras. Otherwise, an empty map is returned.

This function replaces the deprecated getPhysicalCameraResults(), and its return value is a map of TotalCaptureResult rather than CaptureResult.

To reprocess an image from a physical camera stream, typically returned from a MultiResolutionImageReader, the application must look up this map to get the TotalCaptureResult from the physical camera and pass it to CameraDevice.createReprocessCaptureRequest(TotalCaptureResult).

Returns
Map<StringTotalCaptureResult> unmodifiable map between physical camera ids and their total capture result metadata This value cannot be null.

Discover the latest app development tools, platform updates, training, and documentation for developers across every Android device.

Updated Jan 23, 2025

Discover the latest app development tools, platform updates, training, and documentation for developers across every Android device.

Updated Jan 23, 2025

Discover the latest app development tools, platform updates, training, and documentation for developers across every Android device.

Updated Jan 23, 2025