Skip to content

Most visited

Recently visited

navigation

CameraCharacteristics

public final class CameraCharacteristics
extends CameraMetadata<Key<?>>

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


The properties describing a CameraDevice.

These properties are fixed for a given CameraDevice, and can be queried through the CameraManager interface with getCameraCharacteristics(String).

CameraCharacteristics objects are immutable.

See also:

Summary

Nested classes

class CameraCharacteristics.Key<T>

A Key is used to do camera characteristics field lookups with get(CameraCharacteristics.Key)

Inherited constants

From class android.hardware.camera2.CameraMetadata

Fields

public static final Key<int[]> COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES

List of aberration correction modes for android.colorCorrection.aberrationMode that are supported by this camera device.

public static final Key<int[]> CONTROL_AE_AVAILABLE_ANTIBANDING_MODES

List of auto-exposure antibanding modes for android.control.aeAntibandingMode that are supported by this camera device.

public static final Key<int[]> CONTROL_AE_AVAILABLE_MODES

List of auto-exposure modes for android.control.aeMode that are supported by this camera device.

public static final Key<Range[]<Integer>> CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES

List of frame rate ranges for android.control.aeTargetFpsRange supported by this camera device.

public static final Key<Range<Integer>> CONTROL_AE_COMPENSATION_RANGE

Maximum and minimum exposure compensation values for android.control.aeExposureCompensation, in counts of android.control.aeCompensationStep, that are supported by this camera device.

public static final Key<Rational> CONTROL_AE_COMPENSATION_STEP

Smallest step by which the exposure compensation can be changed.

public static final Key<Boolean> CONTROL_AE_LOCK_AVAILABLE

Whether the camera device supports android.control.aeLock

Devices with MANUAL_SENSOR capability or BURST_CAPTURE capability will always list true.

public static final Key<int[]> CONTROL_AF_AVAILABLE_MODES

List of auto-focus (AF) modes for android.control.afMode that are supported by this camera device.

public static final Key<int[]> CONTROL_AVAILABLE_EFFECTS

List of color effects for android.control.effectMode that are supported by this camera device.

public static final Key<int[]> CONTROL_AVAILABLE_MODES

List of control modes for android.control.mode that are supported by this camera device.

public static final Key<int[]> CONTROL_AVAILABLE_SCENE_MODES

List of scene modes for android.control.sceneMode that are supported by this camera device.

public static final Key<int[]> CONTROL_AVAILABLE_VIDEO_STABILIZATION_MODES

List of video stabilization modes for android.control.videoStabilizationMode that are supported by this camera device.

public static final Key<int[]> CONTROL_AWB_AVAILABLE_MODES

List of auto-white-balance modes for android.control.awbMode that are supported by this camera device.

public static final Key<Boolean> CONTROL_AWB_LOCK_AVAILABLE

Whether the camera device supports android.control.awbLock

Devices with MANUAL_POST_PROCESSING capability or BURST_CAPTURE capability will always list true.

public static final Key<Integer> CONTROL_MAX_REGIONS_AE

The maximum number of metering regions that can be used by the auto-exposure (AE) routine.

public static final Key<Integer> CONTROL_MAX_REGIONS_AF

The maximum number of metering regions that can be used by the auto-focus (AF) routine.

public static final Key<Integer> CONTROL_MAX_REGIONS_AWB

The maximum number of metering regions that can be used by the auto-white balance (AWB) routine.

public static final Key<Range<Integer>> CONTROL_POST_RAW_SENSITIVITY_BOOST_RANGE

Range of boosts for android.control.postRawSensitivityBoost supported by this camera device.

public static final Key<Boolean> DEPTH_DEPTH_IS_EXCLUSIVE

Indicates whether a capture request may target both a DEPTH16 / DEPTH_POINT_CLOUD output, and normal color outputs (such as YUV_420_888, JPEG, or RAW) simultaneously.

public static final Key<int[]> EDGE_AVAILABLE_EDGE_MODES

List of edge enhancement modes for android.edge.mode that are supported by this camera device.

public static final Key<Boolean> FLASH_INFO_AVAILABLE

Whether this camera device has a flash unit.

public static final Key<int[]> HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES

List of hot pixel correction modes for android.hotPixel.mode that are supported by this camera device.

public static final Key<Integer> INFO_SUPPORTED_HARDWARE_LEVEL

Generally classifies the overall set of the camera device functionality.

public static final Key<Size[]> JPEG_AVAILABLE_THUMBNAIL_SIZES

List of JPEG thumbnail sizes for android.jpeg.thumbnailSize supported by this camera device.

public static final Key<Integer> LENS_FACING

Direction the camera faces relative to device screen.

public static final Key<float[]> LENS_INFO_AVAILABLE_APERTURES

List of aperture size values for android.lens.aperture that are supported by this camera device.

public static final Key<float[]> LENS_INFO_AVAILABLE_FILTER_DENSITIES

List of neutral density filter values for android.lens.filterDensity that are supported by this camera device.

public static final Key<float[]> LENS_INFO_AVAILABLE_FOCAL_LENGTHS

List of focal lengths for android.lens.focalLength that are supported by this camera device.

public static final Key<int[]> LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION

List of optical image stabilization (OIS) modes for android.lens.opticalStabilizationMode that are supported by this camera device.

public static final Key<Integer> LENS_INFO_FOCUS_DISTANCE_CALIBRATION

The lens focus distance calibration quality.

public static final Key<Float> LENS_INFO_HYPERFOCAL_DISTANCE

Hyperfocal distance for this lens.

public static final Key<Float> LENS_INFO_MINIMUM_FOCUS_DISTANCE

Shortest distance from frontmost surface of the lens that can be brought into sharp focus.

public static final Key<float[]> LENS_INTRINSIC_CALIBRATION

The parameters for this camera device's intrinsic calibration.

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

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

public static final Key<int[]> NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES

List of noise reduction modes for android.noiseReduction.mode that are supported by this camera device.

public static final Key<Integer> REPROCESS_MAX_CAPTURE_STALL

The maximal camera capture pipeline stall (in unit of frame count) introduced by a reprocess capture request.

public static final Key<int[]> REQUEST_AVAILABLE_CAPABILITIES

List of capabilities that this camera device advertises as fully supporting.

public static final Key<Integer> REQUEST_MAX_NUM_INPUT_STREAMS

The maximum numbers of any type of input streams that can be configured and used simultaneously by a camera device.

public static final Key<Integer> REQUEST_MAX_NUM_OUTPUT_PROC

The maximum numbers of different types of output streams that can be configured and used simultaneously by a camera device for any processed (but not-stalling) formats.

public static final Key<Integer> REQUEST_MAX_NUM_OUTPUT_PROC_STALLING

The maximum numbers of different types of output streams that can be configured and used simultaneously by a camera device for any processed (and stalling) formats.

public static final Key<Integer> REQUEST_MAX_NUM_OUTPUT_RAW

The maximum numbers of different types of output streams that can be configured and used simultaneously by a camera device for any RAW formats.

public static final Key<Integer> REQUEST_PARTIAL_RESULT_COUNT

Defines how many sub-components a result will be composed of.

public static final Key<Byte> REQUEST_PIPELINE_MAX_DEPTH

Specifies the number of maximum pipeline stages a frame has to go through from when it's exposed to when it's available to the framework.

public static final Key<Float> SCALER_AVAILABLE_MAX_DIGITAL_ZOOM

The maximum ratio between both active area width and crop region width, and active area height and crop region height, for android.scaler.cropRegion.

public static final Key<Integer> SCALER_CROPPING_TYPE

The crop type that this camera device supports.

public static final Key<StreamConfigurationMap> SCALER_STREAM_CONFIGURATION_MAP

The available stream configurations that this camera device supports; also includes the minimum frame durations and the stall durations for each format/size combination.

public static final Key<int[]> SENSOR_AVAILABLE_TEST_PATTERN_MODES

List of sensor test pattern modes for android.sensor.testPatternMode supported by this camera device.

public static final Key<BlackLevelPattern> SENSOR_BLACK_LEVEL_PATTERN

A fixed black level offset for each of the color filter arrangement (CFA) mosaic channels.

public static final Key<ColorSpaceTransform> SENSOR_CALIBRATION_TRANSFORM1

A per-device calibration transform matrix that maps from the reference sensor colorspace to the actual device sensor colorspace.

public static final Key<ColorSpaceTransform> SENSOR_CALIBRATION_TRANSFORM2

A per-device calibration transform matrix that maps from the reference sensor colorspace to the actual device sensor colorspace (this is the colorspace of the raw buffer data).

public static final Key<ColorSpaceTransform> SENSOR_COLOR_TRANSFORM1

A matrix that transforms color values from CIE XYZ color space to reference sensor color space.

public static final Key<ColorSpaceTransform> SENSOR_COLOR_TRANSFORM2

A matrix that transforms color values from CIE XYZ color space to reference sensor color space.

public static final Key<ColorSpaceTransform> SENSOR_FORWARD_MATRIX1

A matrix that transforms white balanced camera colors from the reference sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.

public static final Key<ColorSpaceTransform> SENSOR_FORWARD_MATRIX2

A matrix that transforms white balanced camera colors from the reference sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.

public static final Key<Rect> SENSOR_INFO_ACTIVE_ARRAY_SIZE

The area of the image sensor which corresponds to active pixels after any geometric distortion correction has been applied.

public static final Key<Integer> SENSOR_INFO_COLOR_FILTER_ARRANGEMENT

The arrangement of color filters on sensor; represents the colors in the top-left 2x2 section of the sensor, in reading order.

public static final Key<Range<Long>> SENSOR_INFO_EXPOSURE_TIME_RANGE

The range of image exposure times for android.sensor.exposureTime supported by this camera device.

public static final Key<Boolean> SENSOR_INFO_LENS_SHADING_APPLIED

Whether the RAW images output from this camera device are subject to lens shading correction.

public static final Key<Long> SENSOR_INFO_MAX_FRAME_DURATION

The maximum possible frame duration (minimum frame rate) for android.sensor.frameDuration that is supported this camera device.

public static final Key<SizeF> SENSOR_INFO_PHYSICAL_SIZE

The physical dimensions of the full pixel array.

public static final Key<Size> SENSOR_INFO_PIXEL_ARRAY_SIZE

Dimensions of the full pixel array, possibly including black calibration pixels.

public static final Key<Rect> SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE

The area of the image sensor which corresponds to active pixels prior to the application of any geometric distortion correction.

public static final Key<Range<Integer>> SENSOR_INFO_SENSITIVITY_RANGE

Range of sensitivities for android.sensor.sensitivity supported by this camera device.

public static final Key<Integer> SENSOR_INFO_TIMESTAMP_SOURCE

The time base source for sensor capture start timestamps.

public static final Key<Integer> SENSOR_INFO_WHITE_LEVEL

Maximum raw value output by sensor.

public static final Key<Integer> SENSOR_MAX_ANALOG_SENSITIVITY

Maximum sensitivity that is implemented purely through analog gain.

public static final Key<Rect[]> SENSOR_OPTICAL_BLACK_REGIONS

List of disjoint rectangles indicating the sensor optically shielded black pixel regions.

public static final Key<Integer> SENSOR_ORIENTATION

Clockwise angle through which the output image needs to be rotated to be upright on the device screen in its native orientation.

public static final Key<Integer> SENSOR_REFERENCE_ILLUMINANT1

The standard reference illuminant used as the scene light source when calculating the android.sensor.colorTransform1, android.sensor.calibrationTransform1, and android.sensor.forwardMatrix1 matrices.

public static final Key<Byte> SENSOR_REFERENCE_ILLUMINANT2

The standard reference illuminant used as the scene light source when calculating the android.sensor.colorTransform2, android.sensor.calibrationTransform2, and android.sensor.forwardMatrix2 matrices.

public static final Key<int[]> SHADING_AVAILABLE_MODES

List of lens shading modes for android.shading.mode that are supported by this camera device.

public static final Key<int[]> STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES

List of face detection modes for android.statistics.faceDetectMode that are supported by this camera device.

public static final Key<boolean[]> STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES

List of hot pixel map output modes for android.statistics.hotPixelMapMode that are supported by this camera device.

public static final Key<int[]> STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES

List of lens shading map output modes for android.statistics.lensShadingMapMode that are supported by this camera device.

public static final Key<Integer> STATISTICS_INFO_MAX_FACE_COUNT

The maximum number of simultaneously detectable faces.

public static final Key<Integer> SYNC_MAX_LATENCY

The maximum number of frames that can occur after a request (different than the previous) has been submitted, and before the result's state becomes synchronized.

public static final Key<int[]> TONEMAP_AVAILABLE_TONE_MAP_MODES

List of tonemapping modes for android.tonemap.mode that are supported by this camera device.

public static final Key<Integer> TONEMAP_MAX_CURVE_POINTS

Maximum number of supported points in the tonemap curve that can be used for android.tonemap.curve.

Public methods

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

Get a camera characteristics field value.

List<Key<?>> getAvailableCaptureRequestKeys()

Returns the list of keys supported by this CameraDevice for querying with a CaptureRequest.

List<Key<?>> getAvailableCaptureResultKeys()

Returns the list of keys supported by this CameraDevice for querying with a CaptureResult.

List<Key<?>> getKeys()

Returns a list of the keys contained in this map.

Inherited methods

From class android.hardware.camera2.CameraMetadata
From class java.lang.Object

Fields

COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES

added in API level 21
Key<int[]> COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES

List of aberration correction modes for android.colorCorrection.aberrationMode that are supported by this camera device.

This key lists the valid modes for android.colorCorrection.aberrationMode. If no aberration correction modes are available for a device, this list will solely include OFF mode. All camera devices will support either OFF or FAST mode.

Camera devices that support the MANUAL_POST_PROCESSING capability will always list OFF mode. This includes all FULL level devices.

LEGACY devices will always only support FAST mode.

Range of valid values:
Any value listed in android.colorCorrection.aberrationMode

This key is available on all devices.

See also:

CONTROL_AE_AVAILABLE_ANTIBANDING_MODES

added in API level 21
Key<int[]> CONTROL_AE_AVAILABLE_ANTIBANDING_MODES

List of auto-exposure antibanding modes for android.control.aeAntibandingMode that are supported by this camera device.

Not all of the auto-exposure anti-banding modes may be supported by a given camera device. This field lists the valid anti-banding modes that the application may request for this camera device with the android.control.aeAntibandingMode control.

Range of valid values:
Any value listed in android.control.aeAntibandingMode

This key is available on all devices.

See also:

CONTROL_AE_AVAILABLE_MODES

added in API level 21
Key<int[]> CONTROL_AE_AVAILABLE_MODES

List of auto-exposure modes for android.control.aeMode that are supported by this camera device.

Not all the auto-exposure modes may be supported by a given camera device, especially if no flash unit is available. This entry lists the valid modes for android.control.aeMode for this camera device.

All camera devices support ON, and all camera devices with flash units support ON_AUTO_FLASH and ON_ALWAYS_FLASH.

FULL mode camera devices always support OFF mode, which enables application control of camera exposure time, sensitivity, and frame duration.

LEGACY mode camera devices never support OFF mode. LIMITED mode devices support OFF if they support the MANUAL_SENSOR capability.

Range of valid values:
Any value listed in android.control.aeMode

This key is available on all devices.

See also:

CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES

added in API level 21
Key<Range[]<Integer>> CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES

List of frame rate ranges for android.control.aeTargetFpsRange supported by this camera device.

For devices at the LEGACY level or above:

For devices at the LIMITED level or above:

  • For YUV_420_888 burst capture use case, this list will always include (min, max) and (max, max) where min <= 15 and max = the maximum output frame rate of the maximum YUV_420_888 output size.

Units: Frames per second (FPS)

This key is available on all devices.

See also:

CONTROL_AE_COMPENSATION_RANGE

added in API level 21
Key<Range<Integer>> CONTROL_AE_COMPENSATION_RANGE

Maximum and minimum exposure compensation values for android.control.aeExposureCompensation, in counts of android.control.aeCompensationStep, that are supported by this camera device.

Range of valid values:

Range [0,0] indicates that exposure compensation is not supported.

For LIMITED and FULL devices, range must follow below requirements if exposure compensation is supported (range != [0, 0]):

Min.exposure compensation * android.control.aeCompensationStep <= -2 EV

Max.exposure compensation * android.control.aeCompensationStep >= 2 EV

LEGACY devices may support a smaller range than this.

This key is available on all devices.

See also:

CONTROL_AE_COMPENSATION_STEP

added in API level 21
Key<Rational> CONTROL_AE_COMPENSATION_STEP

Smallest step by which the exposure compensation can be changed.

This is the unit for android.control.aeExposureCompensation. For example, if this key has a value of 1/2, then a setting of -2 for android.control.aeExposureCompensation means that the target EV offset for the auto-exposure routine is -1 EV.

One unit of EV compensation changes the brightness of the captured image by a factor of two. +1 EV doubles the image brightness, while -1 EV halves the image brightness.

Units: Exposure Value (EV)

This key is available on all devices.

See also:

CONTROL_AE_LOCK_AVAILABLE

added in API level 23
Key<Boolean> CONTROL_AE_LOCK_AVAILABLE

Whether the camera device supports android.control.aeLock

Devices with MANUAL_SENSOR capability or BURST_CAPTURE capability will always list true. This includes FULL devices.

This key is available on all devices.

See also:

CONTROL_AF_AVAILABLE_MODES

added in API level 21
Key<int[]> CONTROL_AF_AVAILABLE_MODES

List of auto-focus (AF) modes for android.control.afMode that are supported by this camera device.

Not all the auto-focus modes may be supported by a given camera device. This entry lists the valid modes for android.control.afMode for this camera device.

All LIMITED and FULL mode camera devices will support OFF mode, and all camera devices with adjustable focuser units (android.lens.info.minimumFocusDistance > 0) will support AUTO mode.

LEGACY devices will support OFF mode only if they support focusing to infinity (by also setting android.lens.focusDistance to 0.0f).

Range of valid values:
Any value listed in android.control.afMode

This key is available on all devices.

See also:

CONTROL_AVAILABLE_EFFECTS

added in API level 21
Key<int[]> CONTROL_AVAILABLE_EFFECTS

List of color effects for android.control.effectMode that are supported by this camera device.

This list contains the color effect modes that can be applied to images produced by the camera device. Implementations are not expected to be consistent across all devices. If no color effect modes are available for a device, this will only list OFF.

A color effect will only be applied if android.control.mode != OFF. OFF is always included in this list.

This control has no effect on the operation of other control routines such as auto-exposure, white balance, or focus.

Range of valid values:
Any value listed in android.control.effectMode

This key is available on all devices.

See also:

CONTROL_AVAILABLE_MODES

added in API level 23
Key<int[]> CONTROL_AVAILABLE_MODES

List of control modes for android.control.mode that are supported by this camera device.

This list contains control modes that can be set for the camera device. LEGACY mode devices will always support AUTO mode. LIMITED and FULL devices will always support OFF, AUTO modes.

Range of valid values:
Any value listed in android.control.mode

This key is available on all devices.

See also:

CONTROL_AVAILABLE_SCENE_MODES

added in API level 21
Key<int[]> CONTROL_AVAILABLE_SCENE_MODES

List of scene modes for android.control.sceneMode that are supported by this camera device.

This list contains scene modes that can be set for the camera device. Only scene modes that have been fully implemented for the camera device may be included here. Implementations are not expected to be consistent across all devices.

If no scene modes are supported by the camera device, this will be set to DISABLED. Otherwise DISABLED will not be listed.

FACE_PRIORITY is always listed if face detection is supported (i.e.android.statistics.info.maxFaceCount > 0).

Range of valid values:
Any value listed in android.control.sceneMode

This key is available on all devices.

See also:

CONTROL_AVAILABLE_VIDEO_STABILIZATION_MODES

added in API level 21
Key<int[]> CONTROL_AVAILABLE_VIDEO_STABILIZATION_MODES

List of video stabilization modes for android.control.videoStabilizationMode that are supported by this camera device.

OFF will always be listed.

Range of valid values:
Any value listed in android.control.videoStabilizationMode

This key is available on all devices.

See also:

CONTROL_AWB_AVAILABLE_MODES

added in API level 21
Key<int[]> CONTROL_AWB_AVAILABLE_MODES

List of auto-white-balance modes for android.control.awbMode that are supported by this camera device.

Not all the auto-white-balance modes may be supported by a given camera device. This entry lists the valid modes for android.control.awbMode for this camera device.

All camera devices will support ON mode.

Camera devices that support the MANUAL_POST_PROCESSING capability will always support OFF mode, which enables application control of white balance, by using android.colorCorrection.transform and android.colorCorrection.gains(android.colorCorrection.mode must be set to TRANSFORM_MATRIX). This includes all FULL mode camera devices.

Range of valid values:
Any value listed in android.control.awbMode

This key is available on all devices.

See also:

CONTROL_AWB_LOCK_AVAILABLE

added in API level 23
Key<Boolean> CONTROL_AWB_LOCK_AVAILABLE

Whether the camera device supports android.control.awbLock

Devices with MANUAL_POST_PROCESSING capability or BURST_CAPTURE capability will always list true. This includes FULL devices.

This key is available on all devices.

See also:

CONTROL_MAX_REGIONS_AE

added in API level 21
Key<Integer> CONTROL_MAX_REGIONS_AE

The maximum number of metering regions that can be used by the auto-exposure (AE) routine.

This corresponds to the the maximum allowed number of elements in android.control.aeRegions.

Range of valid values:
Value will be >= 0. For FULL-capability devices, this value will be >= 1.

This key is available on all devices.

See also:

CONTROL_MAX_REGIONS_AF

added in API level 21
Key<Integer> CONTROL_MAX_REGIONS_AF

The maximum number of metering regions that can be used by the auto-focus (AF) routine.

This corresponds to the the maximum allowed number of elements in android.control.afRegions.

Range of valid values:
Value will be >= 0. For FULL-capability devices, this value will be >= 1.

This key is available on all devices.

See also:

CONTROL_MAX_REGIONS_AWB

added in API level 21
Key<Integer> CONTROL_MAX_REGIONS_AWB

The maximum number of metering regions that can be used by the auto-white balance (AWB) routine.

This corresponds to the the maximum allowed number of elements in android.control.awbRegions.

Range of valid values:
Value will be >= 0.

This key is available on all devices.

See also:

CONTROL_POST_RAW_SENSITIVITY_BOOST_RANGE

added in API level 24
Key<Range<Integer>> CONTROL_POST_RAW_SENSITIVITY_BOOST_RANGE

Range of boosts for android.control.postRawSensitivityBoost supported by this camera device.

Devices support post RAW sensitivity boost will advertise android.control.postRawSensitivityBoost key for controling post RAW sensitivity boost.

This key will be null for devices that do not support any RAW format outputs. For devices that do support RAW format outputs, this key will always present, and if a device does not support post RAW sensitivity boost, it will list (100, 100) in this key.

Units: ISO arithmetic units, the same as android.sensor.sensitivity

Optional - This value may be null on some devices.

See also:

DEPTH_DEPTH_IS_EXCLUSIVE

added in API level 23
Key<Boolean> DEPTH_DEPTH_IS_EXCLUSIVE

Indicates whether a capture request may target both a DEPTH16 / DEPTH_POINT_CLOUD output, and normal color outputs (such as YUV_420_888, JPEG, or RAW) simultaneously.

If TRUE, including both depth and color outputs in a single capture request is not supported. An application must interleave color and depth requests. If FALSE, a single request can target both types of output.

Typically, this restriction exists on camera devices that need to emit a specific pattern or wavelength of light to measure depth values, which causes the color image to be corrupted during depth measurement.

Optional - This value may be null on some devices.

Limited capability - Present on all camera devices that report being at least HARDWARE_LEVEL_LIMITED devices in the android.info.supportedHardwareLevel key

See also:

EDGE_AVAILABLE_EDGE_MODES

added in API level 21
Key<int[]> EDGE_AVAILABLE_EDGE_MODES

List of edge enhancement modes for android.edge.mode that are supported by this camera device.

Full-capability camera devices must always support OFF; camera devices that support YUV_REPROCESSING or PRIVATE_REPROCESSING will list ZERO_SHUTTER_LAG; all devices will list FAST.

Range of valid values:
Any value listed in android.edge.mode

Optional - This value may be null on some devices.

Full capability - Present on all camera devices that report being HARDWARE_LEVEL_FULL devices in the android.info.supportedHardwareLevel key

See also:

FLASH_INFO_AVAILABLE

added in API level 21
Key<Boolean> FLASH_INFO_AVAILABLE

Whether this camera device has a flash unit.

Will be false if no flash is available.

If there is no flash unit, none of the flash controls do anything. This key is available on all devices.

HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES

added in API level 21
Key<int[]> HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES

List of hot pixel correction modes for android.hotPixel.mode that are supported by this camera device.

FULL mode camera devices will always support FAST.

Range of valid values:
Any value listed in android.hotPixel.mode

Optional - This value may be null on some devices.

See also:

INFO_SUPPORTED_HARDWARE_LEVEL

added in API level 21
Key<Integer> INFO_SUPPORTED_HARDWARE_LEVEL

Generally classifies the overall set of the camera device functionality.

The supported hardware level is a high-level description of the camera device's capabilities, summarizing several capabilities into one field. Each level adds additional features to the previous one, and is always a strict superset of the previous level. The ordering is LEGACY < LIMITED < FULL < LEVEL_3.

Starting from LEVEL_3, the level enumerations are guaranteed to be in increasing numerical value as well. To check if a given device is at least at a given hardware level, the following code snippet can be used:

// Returns true if the device supports the required hardware level, or better.
 boolean isHardwareLevelSupported(CameraCharacteristics c, int requiredLevel) {
     int deviceLevel = c.get(CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL);
     if (deviceLevel == CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY) {
         return requiredLevel == deviceLevel;
     }
     // deviceLevel is not LEGACY, can use numerical sort
     return requiredLevel <= deviceLevel;
 }
 

At a high level, the levels are:

  • LEGACY devices operate in a backwards-compatibility mode for older Android devices, and have very limited capabilities.
  • LIMITED devices represent the baseline feature set, and may also include additional capabilities that are subsets of FULL.
  • FULL devices additionally support per-frame manual control of sensor, flash, lens and post-processing settings, and image capture at a high rate.
  • LEVEL_3 devices additionally support YUV reprocessing and RAW image capture, along with additional output stream configurations.

See the individual level enums for full descriptions of the supported capabilities. The android.request.availableCapabilities entry describes the device's capabilities at a finer-grain level, if needed. In addition, many controls have their available settings or ranges defined in individual CameraCharacteristics entries.

Some features are not part of any particular hardware level or capability and must be queried separately. These include:

Possible values:

This key is available on all devices.

See also:

JPEG_AVAILABLE_THUMBNAIL_SIZES

added in API level 21
Key<Size[]> JPEG_AVAILABLE_THUMBNAIL_SIZES

List of JPEG thumbnail sizes for android.jpeg.thumbnailSize supported by this camera device.

This list will include at least one non-zero resolution, plus (0,0) for indicating no thumbnail should be generated.

Below condiditions will be satisfied for this size list:

  • The sizes will be sorted by increasing pixel area (width x height). If several resolutions have the same area, they will be sorted by increasing width.
  • The aspect ratio of the largest thumbnail size will be same as the aspect ratio of largest JPEG output size in android.scaler.availableStreamConfigurations. The largest size is defined as the size that has the largest pixel area in a given size list.
  • Each output JPEG size in android.scaler.availableStreamConfigurations will have at least one corresponding size that has the same aspect ratio in availableThumbnailSizes, and vice versa.
  • All non-(0, 0) sizes will have non-zero widths and heights. This key is available on all devices.

See also:

LENS_FACING

added in API level 21
Key<Integer> LENS_FACING

Direction the camera faces relative to device screen.

Possible values:

This key is available on all devices.

See also:

LENS_INFO_AVAILABLE_APERTURES

added in API level 21
Key<float[]> LENS_INFO_AVAILABLE_APERTURES

List of aperture size values for android.lens.aperture that are supported by this camera device.

If the camera device doesn't support a variable lens aperture, this list will contain only one value, which is the fixed aperture size.

If the camera device supports a variable aperture, the aperture values in this list will be sorted in ascending order.

Units: The aperture f-number

Optional - This value may be null on some devices.

Full capability - Present on all camera devices that report being HARDWARE_LEVEL_FULL devices in the android.info.supportedHardwareLevel key

See also:

LENS_INFO_AVAILABLE_FILTER_DENSITIES

added in API level 21
Key<float[]> LENS_INFO_AVAILABLE_FILTER_DENSITIES

List of neutral density filter values for android.lens.filterDensity that are supported by this camera device.

If a neutral density filter is not supported by this camera device, this list will contain only 0. Otherwise, this list will include every filter density supported by the camera device, in ascending order.

Units: Exposure value (EV)

Range of valid values:

Values are >= 0

Optional - This value may be null on some devices.

Full capability - Present on all camera devices that report being HARDWARE_LEVEL_FULL devices in the android.info.supportedHardwareLevel key

See also:

LENS_INFO_AVAILABLE_FOCAL_LENGTHS

added in API level 21
Key<float[]> LENS_INFO_AVAILABLE_FOCAL_LENGTHS

List of focal lengths for android.lens.focalLength that are supported by this camera device.

If optical zoom is not supported, this list will only contain a single value corresponding to the fixed focal length of the device. Otherwise, this list will include every focal length supported by the camera device, in ascending order.

Units: Millimeters

Range of valid values:

Values are > 0

This key is available on all devices.

See also:

LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION

added in API level 21
Key<int[]> LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION

List of optical image stabilization (OIS) modes for android.lens.opticalStabilizationMode that are supported by this camera device.

If OIS is not supported by a given camera device, this list will contain only OFF.

Range of valid values:
Any value listed in android.lens.opticalStabilizationMode

Optional - This value may be null on some devices.

Limited capability - Present on all camera devices that report being at least HARDWARE_LEVEL_LIMITED devices in the android.info.supportedHardwareLevel key

See also:

LENS_INFO_FOCUS_DISTANCE_CALIBRATION

added in API level 21
Key<Integer> LENS_INFO_FOCUS_DISTANCE_CALIBRATION

The lens focus distance calibration quality.

The lens focus distance calibration quality determines the reliability of focus related metadata entries, i.e. android.lens.focusDistance, android.lens.focusRange, android.lens.info.hyperfocalDistance, and android.lens.info.minimumFocusDistance.

APPROXIMATE and CALIBRATED devices report the focus metadata in units of diopters (1/meter), so 0.0f represents focusing at infinity, and increasing positive numbers represent focusing closer and closer to the camera device. The focus distance control also uses diopters on these devices.

UNCALIBRATED devices do not use units that are directly comparable to any real physical measurement, but 0.0f still represents farthest focus, and android.lens.info.minimumFocusDistance represents the nearest focus the device can achieve.

Possible values:

Optional - This value may be null on some devices.

Limited capability - Present on all camera devices that report being at least HARDWARE_LEVEL_LIMITED devices in the android.info.supportedHardwareLevel key

See also:

LENS_INFO_HYPERFOCAL_DISTANCE

added in API level 21
Key<Float> LENS_INFO_HYPERFOCAL_DISTANCE

Hyperfocal distance for this lens.

If the lens is not fixed focus, the camera device will report this field when android.lens.info.focusDistanceCalibration is APPROXIMATE or CALIBRATED.

Units: See android.lens.info.focusDistanceCalibration for details

Range of valid values:
If lens is fixed focus, >= 0. If lens has focuser unit, the value is within (0.0f, android.lens.info.minimumFocusDistance]

Optional - This value may be null on some devices.

Limited capability - Present on all camera devices that report being at least HARDWARE_LEVEL_LIMITED devices in the android.info.supportedHardwareLevel key

See also:

LENS_INFO_MINIMUM_FOCUS_DISTANCE

added in API level 21
Key<Float> LENS_INFO_MINIMUM_FOCUS_DISTANCE

Shortest distance from frontmost surface of the lens that can be brought into sharp focus.

If the lens is fixed-focus, this will be 0.

Units: See android.lens.info.focusDistanceCalibration for details

Range of valid values:
>= 0

Optional - This value may be null on some devices.

Limited capability - Present on all camera devices that report being at least HARDWARE_LEVEL_LIMITED devices in the android.info.supportedHardwareLevel key

See also:

LENS_INTRINSIC_CALIBRATION

added in API level 23
Key<float[]> LENS_INTRINSIC_CALIBRATION

The parameters for this camera device's intrinsic calibration.

The five calibration parameters that describe the transform from camera-centric 3D coordinates to sensor pixel coordinates:

[f_x, f_y, c_x, c_y, s]
 

Where f_x and f_y are the horizontal and vertical focal lengths, [c_x, c_y] is the position of the optical axis, and s is a skew parameter for the sensor plane not being aligned with the lens plane.

These are typically used within a transformation matrix K:

K = [ f_x,   s, c_x,
        0, f_y, c_y,
        0    0,   1 ]
 

which can then be combined with the camera pose rotation R and translation t (android.lens.poseRotation and android.lens.poseTranslation, respective) to calculate the complete transform from world coordinates to pixel coordinates:

P = [ K 0   * [ R t
      0 1 ]     0 1 ]
 

and with p_w being a point in the world coordinate system and p_s being a point in the camera active pixel array coordinate system, and with the mapping including the homogeneous division by z:

 p_h = (x_h, y_h, z_h) = P p_w
 p_s = p_h / z_h
 

so [x_s, y_s] is the pixel coordinates of the world point, z_s = 1, and w_s is a measurement of disparity (depth) in pixel coordinates.

Note that the coordinate system for this transform is the android.sensor.info.preCorrectionActiveArraySize system, where (0,0) is the top-left of the preCorrectionActiveArraySize rectangle. Once the pose and intrinsic calibration transforms have been applied to a world point, then the android.lens.radialDistortion transform needs to be applied, and the result adjusted to be in the android.sensor.info.activeArraySize coordinate system (where (0, 0) is the top-left of the activeArraySize rectangle), to determine the final pixel coordinate of the world point for processed (non-RAW) output buffers.

Units: Pixels in the android.sensor.info.preCorrectionActiveArraySize coordinate system.

Optional - This value may be null on some devices.

See also:

LENS_POSE_ROTATION

added in API level 23
Key<float[]> LENS_POSE_ROTATION

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

The four coefficients that describe the quaternion rotation from the Android sensor coordinate system to a camera-aligned coordinate system where the X-axis is aligned with the long side of the image sensor, the Y-axis is aligned with the short side of the image sensor, and the Z-axis is aligned with the optical axis of the sensor.

To convert from the quaternion coefficients (x,y,z,w) to the axis of rotation (a_x, a_y, a_z) and rotation amount theta, the following formulas can be used:

 theta = 2 * acos(w)
 a_x = x / sin(theta/2)
 a_y = y / sin(theta/2)
 a_z = z / sin(theta/2)
 

To create a 3x3 rotation matrix that applies the rotation defined by this quaternion, the following matrix can be used:

R = [ 1 - 2y^2 - 2z^2,       2xy - 2zw,       2xz + 2yw,
            2xy + 2zw, 1 - 2x^2 - 2z^2,       2yz - 2xw,
            2xz - 2yw,       2yz + 2xw, 1 - 2x^2 - 2y^2 ]
 

This matrix can then be used to apply the rotation to a column vector point with

p' = Rp

where p is in the device sensor coordinate system, and p' is in the camera-oriented coordinate system.

Units: Quaternion coefficients

Optional - This value may be null on some devices.

LENS_POSE_TRANSLATION

added in API level 23
Key<float[]> LENS_POSE_TRANSLATION

Position of the camera optical center.

The position of the camera device's lens optical center, as a three-dimensional vector (x,y,z), relative to the optical center of the largest camera device facing in the same direction as this camera, in the Android sensor coordinate axes. Note that only the axis definitions are shared with the sensor coordinate system, but not the origin.

If this device is the largest or only camera device with a given facing, then this position will be (0, 0, 0); a camera device with a lens optical center located 3 cm from the main sensor along the +X axis (to the right from the user's perspective) will report (0.03, 0, 0).

To transform a pixel coordinates between two cameras facing the same direction, first the source camera android.lens.radialDistortion must be corrected for. Then the source camera android.lens.intrinsicCalibration needs to be applied, followed by the android.lens.poseRotation of the source camera, the translation of the source camera relative to the destination camera, the android.lens.poseRotation of the destination camera, and finally the inverse of android.lens.intrinsicCalibration of the destination camera. This obtains a radial-distortion-free coordinate in the destination camera pixel coordinates.

To compare this against a real image from the destination camera, the destination camera image then needs to be corrected for radial distortion before comparison or sampling.

Units: Meters

Optional - This value may be null on some devices.

See also:

LENS_RADIAL_DISTORTION

added in API level 23
Key<float[]> LENS_RADIAL_DISTORTION

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

Four radial distortion coefficients [kappa_0, kappa_1, kappa_2, kappa_3] and two tangential distortion coefficients [kappa_4, kappa_5] that can be used to correct the lens's geometric distortion with the mapping equations:

 x_c = x_i * ( kappa_0 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +
        kappa_4 * (2 * x_i * y_i) + kappa_5 * ( r^2 + 2 * x_i^2 )
  y_c = y_i * ( kappa_0 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +
        kappa_5 * (2 * x_i * y_i) + kappa_4 * ( r^2 + 2 * y_i^2 )
 

Here, [x_c, y_c] are the coordinates to sample in the input image that correspond to the pixel values in the corrected image at the coordinate [x_i, y_i]:

 correctedImage(x_i, y_i) = sample_at(x_c, y_c, inputImage)
 

The pixel coordinates are defined in a normalized coordinate system related to the android.lens.intrinsicCalibration calibration fields. Both [x_i, y_i] and [x_c, y_c] have (0,0) at the lens optical center [c_x, c_y]. The maximum magnitudes of both x and y coordinates are normalized to be 1 at the edge further from the optical center, so the range for both dimensions is -1 <= x <= 1.

Finally, r represents the radial distance from the optical center, r^2 = x_i^2 + y_i^2, and its magnitude is therefore no larger than |r| <= sqrt(2).

The distortion model used is the Brown-Conrady model.

Units: Unitless coefficients.

Optional - This value may be null on some devices.

See also:

NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES

added in API level 21
Key<int[]> NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES

List of noise reduction modes for android.noiseReduction.mode that are supported by this camera device.

Full-capability camera devices will always support OFF and FAST.

Camera devices that support YUV_REPROCESSING or PRIVATE_REPROCESSING will support ZERO_SHUTTER_LAG.

Legacy-capability camera devices will only support FAST mode.

Range of valid values:
Any value listed in android.noiseReduction.mode

Optional - This value may be null on some devices.

Limited capability - Present on all camera devices that report being at least HARDWARE_LEVEL_LIMITED devices in the android.info.supportedHardwareLevel key

See also:

REPROCESS_MAX_CAPTURE_STALL

added in API level 23
Key<Integer> REPROCESS_MAX_CAPTURE_STALL

The maximal camera capture pipeline stall (in unit of frame count) introduced by a reprocess capture request.

The key describes the maximal interference that one reprocess (input) request can introduce to the camera simultaneous streaming of regular (output) capture requests, including repeating requests.

When a reprocessing capture request is submitted while a camera output repeating request (e.g. preview) is being served by the camera device, it may preempt the camera capture pipeline for at least one frame duration so that the camera device is unable to process the following capture request in time for the next sensor start of exposure boundary. When this happens, the application may observe a capture time gap (longer than one frame duration) between adjacent capture output frames, which usually exhibits as preview glitch if the repeating request output targets include a preview surface. This key gives the worst-case number of frame stall introduced by one reprocess request with any kind of formats/sizes combination.

If this key reports 0, it means a reprocess request doesn't introduce any glitch to the ongoing camera repeating request outputs, as if this reprocess request is never issued.

This key is supported if the camera device supports PRIVATE or YUV reprocessing ( i.e. android.request.availableCapabilities contains PRIVATE_REPROCESSING or YUV_REPROCESSING).

Units: Number of frames.

Range of valid values:
<= 4

Optional - This value may be null on some devices.

Limited capability - Present on all camera devices that report being at least HARDWARE_LEVEL_LIMITED devices in the android.info.supportedHardwareLevel key

See also:

REQUEST_AVAILABLE_CAPABILITIES

added in API level 21
Key<int[]> REQUEST_AVAILABLE_CAPABILITIES

List of capabilities that this camera device advertises as fully supporting.

A capability is a contract that the camera device makes in order to be able to satisfy one or more use cases.

Listing a capability guarantees that the whole set of features required to support a common use will all be available.

Using a subset of the functionality provided by an unsupported capability may be possible on a specific camera device implementation; to do this query each of android.request.availableRequestKeys, android.request.availableResultKeys, android.request.availableCharacteristicsKeys.

The following capabilities are guaranteed to be available on android.info.supportedHardwareLevel == FULL devices:

  • MANUAL_SENSOR
  • MANUAL_POST_PROCESSING

Other capabilities may be available on either FULL or LIMITED devices, but the application should query this key to be sure.

Possible values:

This key is available on all devices.

See also:

REQUEST_MAX_NUM_INPUT_STREAMS

added in API level 23
Key<Integer> REQUEST_MAX_NUM_INPUT_STREAMS

The maximum numbers of any type of input streams that can be configured and used simultaneously by a camera device.

When set to 0, it means no input stream is supported.

The image format for a input stream can be any supported format returned by getInputFormats(). When using an input stream, there must be at least one output stream configured to to receive the reprocessed images.

When an input stream and some output streams are used in a reprocessing request, only the input buffer will be used to produce these output stream buffers, and a new sensor image will not be captured.

For example, for Zero Shutter Lag (ZSL) still capture use case, the input stream image format will be PRIVATE, the associated output stream image format should be JPEG.

Range of valid values:

0 or 1.

Optional - This value may be null on some devices.

Full capability - Present on all camera devices that report being HARDWARE_LEVEL_FULL devices in the android.info.supportedHardwareLevel key

See also:

REQUEST_MAX_NUM_OUTPUT_PROC

added in API level 21
Key<Integer> REQUEST_MAX_NUM_OUTPUT_PROC

The maximum numbers of different types of output streams that can be configured and used simultaneously by a camera device for any processed (but not-stalling) formats.

This value contains the max number of output simultaneous streams for any processed (but not-stalling) formats.

This lists the upper bound of the number of output streams supported by the camera device. Using more streams simultaneously may require more hardware and CPU resources that will consume more power. The image format for this kind of an output stream can be any non-RAW and supported format provided by android.scaler.streamConfigurationMap.

Processed (but not-stalling) is defined as any non-RAW format without a stall duration. Typically:

For full guarantees, query getOutputStallDuration(int, Size) with a processed format -- it will return 0 for a non-stalling stream.

LEGACY devices will support at least 2 processing/non-stalling streams.

Range of valid values:

>= 3 for FULL mode devices (android.info.supportedHardwareLevel == FULL); >= 2 for LIMITED mode devices (android.info.supportedHardwareLevel == LIMITED).

This key is available on all devices.

See also:

REQUEST_MAX_NUM_OUTPUT_PROC_STALLING

added in API level 21
Key<Integer> REQUEST_MAX_NUM_OUTPUT_PROC_STALLING

The maximum numbers of different types of output streams that can be configured and used simultaneously by a camera device for any processed (and stalling) formats.

This value contains the max number of output simultaneous streams for any processed (but not-stalling) formats.

This lists the upper bound of the number of output streams supported by the camera device. Using more streams simultaneously may require more hardware and CPU resources that will consume more power. The image format for this kind of an output stream can be any non-RAW and supported format provided by android.scaler.streamConfigurationMap.

A processed and stalling format is defined as any non-RAW format with a stallDurations > 0. Typically only the JPEG format is a stalling format.

For full guarantees, query getOutputStallDuration(int, Size) with a processed format -- it will return a non-0 value for a stalling stream.

LEGACY devices will support up to 1 processing/stalling stream.

Range of valid values:

>= 1

This key is available on all devices.

See also:

REQUEST_MAX_NUM_OUTPUT_RAW

added in API level 21
Key<Integer> REQUEST_MAX_NUM_OUTPUT_RAW

The maximum numbers of different types of output streams that can be configured and used simultaneously by a camera device for any RAW formats.

This value contains the max number of output simultaneous streams from the raw sensor.

This lists the upper bound of the number of output streams supported by the camera device. Using more streams simultaneously may require more hardware and CPU resources that will consume more power. The image format for this kind of an output stream can be any RAW and supported format provided by android.scaler.streamConfigurationMap.

In particular, a RAW format is typically one of:

LEGACY mode devices (android.info.supportedHardwareLevel == LEGACY) never support raw streams.

Range of valid values:

>= 0

This key is available on all devices.

See also:

REQUEST_PARTIAL_RESULT_COUNT

added in API level 21
Key<Integer> REQUEST_PARTIAL_RESULT_COUNT

Defines how many sub-components a result will be composed of.

In order to combat the pipeline latency, partial results may be delivered to the application layer from the camera device as soon as they are available.

Optional; defaults to 1. A value of 1 means that partial results are not supported, and only the final TotalCaptureResult will be produced by the camera device.

A typical use case for this might be: after requesting an auto-focus (AF) lock the new AF state might be available 50% of the way through the pipeline. The camera device could then immediately dispatch this state via a partial result to the application, and the rest of the metadata via later partial results.

Range of valid values:
>= 1

Optional - This value may be null on some devices.

REQUEST_PIPELINE_MAX_DEPTH

added in API level 21
Key<Byte> REQUEST_PIPELINE_MAX_DEPTH

Specifies the number of maximum pipeline stages a frame has to go through from when it's exposed to when it's available to the framework.

A typical minimum value for this is 2 (one stage to expose, one stage to readout) from the sensor. The ISP then usually adds its own stages to do custom HW processing. Further stages may be added by SW processing.

Depending on what settings are used (e.g. YUV, JPEG) and what processing is enabled (e.g. face detection), the actual pipeline depth (specified by android.request.pipelineDepth) may be less than the max pipeline depth.

A pipeline depth of X stages is equivalent to a pipeline latency of X frame intervals.

This value will normally be 8 or less, however, for high speed capture session, the max pipeline depth will be up to 8 x size of high speed capture request list.

This key is available on all devices.

See also:

SCALER_AVAILABLE_MAX_DIGITAL_ZOOM

added in API level 21
Key<Float> SCALER_AVAILABLE_MAX_DIGITAL_ZOOM

The maximum ratio between both active area width and crop region width, and active area height and crop region height, for android.scaler.cropRegion.

This represents the maximum amount of zooming possible by the camera device, or equivalently, the minimum cropping window size.

Crop regions that have a width or height that is smaller than this ratio allows will be rounded up to the minimum allowed size by the camera device.

Units: Zoom scale factor

Range of valid values:
>=1

This key is available on all devices.

See also:

SCALER_CROPPING_TYPE

added in API level 21
Key<Integer> SCALER_CROPPING_TYPE

The crop type that this camera device supports.

When passing a non-centered crop region (android.scaler.cropRegion) to a camera device that only supports CENTER_ONLY cropping, the camera device will move the crop region to the center of the sensor active array (android.sensor.info.activeArraySize) and keep the crop region width and height unchanged. The camera device will return the final used crop region in metadata result android.scaler.cropRegion.

Camera devices that support FREEFORM cropping will support any crop region that is inside of the active array. The camera device will apply the same crop region and return the final used crop region in capture result metadata android.scaler.cropRegion.

LEGACY capability devices will only support CENTER_ONLY cropping.

Possible values:

This key is available on all devices.

See also:

SCALER_STREAM_CONFIGURATION_MAP

added in API level 21
Key<StreamConfigurationMap> SCALER_STREAM_CONFIGURATION_MAP

The available stream configurations that this camera device supports; also includes the minimum frame durations and the stall durations for each format/size combination.

All camera devices will support sensor maximum resolution (defined by android.sensor.info.activeArraySize) for the JPEG format.

For a given use case, the actual maximum supported resolution may be lower than what is listed here, depending on the destination Surface for the image data. For example, for recording video, the video encoder chosen may have a maximum size limit (e.g. 1080p) smaller than what the camera (e.g. maximum resolution is 3264x2448) can provide.

Please reference the documentation for the image data destination to check if it limits the maximum size for image data.

The following table describes the minimum required output stream configurations based on the hardware level (android.info.supportedHardwareLevel):

Format Size Hardware Level Notes
JPEG android.sensor.info.activeArraySize (*1) Any
JPEG 1920x1080 (1080p) Any if 1080p <= activeArraySize
JPEG 1280x720 (720p) Any if 720p <= activeArraySize
JPEG 640x480 (480p) Any if 480p <= activeArraySize
JPEG 320x240 (240p) Any if 240p <= activeArraySize
YUV_420_888 all output sizes available for JPEG FULL
YUV_420_888 all output sizes available for JPEG, up to the maximum video size LIMITED
PRIVATE same as YUV_420_888 Any

Refer to android.request.availableCapabilities and createCaptureSession(List, CameraCaptureSession.StateCallback, Handler) for additional mandatory stream configurations on a per-capability basis.

*1: For JPEG format, the sizes may be restricted by below conditions:

  • The HAL may choose the aspect ratio of each Jpeg size to be one of well known ones (e.g. 4:3, 16:9, 3:2 etc.). If the sensor maximum resolution (defined by android.sensor.info.activeArraySize) has an aspect ratio other than these, it does not have to be included in the supported JPEG sizes.
  • Some hardware JPEG encoders may have pixel boundary alignment requirements, such as the dimensions being a multiple of 16. Therefore, the maximum JPEG size may be smaller than sensor maximum resolution. However, the largest JPEG size will be as close as possible to the sensor maximum resolution given above constraints. It is required that after aspect ratio adjustments, additional size reduction due to other issues must be less than 3% in area. For example, if the sensor maximum resolution is 3280x2464, if the maximum JPEG size has aspect ratio 4:3, and the JPEG encoder alignment requirement is 16, the maximum JPEG size will be 3264x2448.

This key is available on all devices.

See also:

SENSOR_AVAILABLE_TEST_PATTERN_MODES

added in API level 21
Key<int[]> SENSOR_AVAILABLE_TEST_PATTERN_MODES

List of sensor test pattern modes for android.sensor.testPatternMode supported by this camera device.

Defaults to OFF, and always includes OFF if defined.

Range of valid values:
Any value listed in android.sensor.testPatternMode

Optional - This value may be null on some devices.

See also:

SENSOR_BLACK_LEVEL_PATTERN

added in API level 21
Key<BlackLevelPattern> SENSOR_BLACK_LEVEL_PATTERN

A fixed black level offset for each of the color filter arrangement (CFA) mosaic channels.

This key specifies the zero light value for each of the CFA mosaic channels in the camera sensor. The maximal value output by the sensor is represented by the value in android.sensor.info.whiteLevel.

The values are given in the same order as channels listed for the CFA layout key (see android.sensor.info.colorFilterArrangement), i.e. the nth value given corresponds to the black level offset for the nth color channel listed in the CFA.

The black level values of captured images may vary for different capture settings (e.g., android.sensor.sensitivity). This key represents a coarse approximation for such case. It is recommended to use android.sensor.dynamicBlackLevel or use pixels from android.sensor.opticalBlackRegions directly for captures when supported by the camera device, which provides more accurate black level values. For raw capture in particular, it is recommended to use pixels from android.sensor.opticalBlackRegions to calculate black level values for each frame.

Range of valid values:
>= 0 for each.

Optional - This value may be null on some devices.

See also:

SENSOR_CALIBRATION_TRANSFORM1

added in API level 21
Key<ColorSpaceTransform> SENSOR_CALIBRATION_TRANSFORM1

A per-device calibration transform matrix that maps from the reference sensor colorspace to the actual device sensor colorspace.

This matrix is used to correct for per-device variations in the sensor colorspace, and is used for processing raw buffer data.

The matrix is expressed as a 3x3 matrix in row-major-order, and contains a per-device calibration transform that maps colors from reference sensor color space (i.e. the "golden module" colorspace) into this camera device's native sensor color space under the first reference illuminant (android.sensor.referenceIlluminant1).

Optional - This value may be null on some devices.

See also:

SENSOR_CALIBRATION_TRANSFORM2

added in API level 21
Key<ColorSpaceTransform> SENSOR_CALIBRATION_TRANSFORM2

A per-device calibration transform matrix that maps from the reference sensor colorspace to the actual device sensor colorspace (this is the colorspace of the raw buffer data).

This matrix is used to correct for per-device variations in the sensor colorspace, and is used for processing raw buffer data.

The matrix is expressed as a 3x3 matrix in row-major-order, and contains a per-device calibration transform that maps colors from reference sensor color space (i.e. the "golden module" colorspace) into this camera device's native sensor color space under the second reference illuminant (android.sensor.referenceIlluminant2).

This matrix will only be present if the second reference illuminant is present.

Optional - This value may be null on some devices.

See also:

SENSOR_COLOR_TRANSFORM1

added in API level 21
Key<ColorSpaceTransform> SENSOR_COLOR_TRANSFORM1

A matrix that transforms color values from CIE XYZ color space to reference sensor color space.

This matrix is used to convert from the standard CIE XYZ color space to the reference sensor colorspace, and is used when processing raw buffer data.

The matrix is expressed as a 3x3 matrix in row-major-order, and contains a color transform matrix that maps colors from the CIE XYZ color space to the reference sensor color space (i.e. the "golden module" colorspace) under the first reference illuminant (android.sensor.referenceIlluminant1).

The white points chosen in both the reference sensor color space and the CIE XYZ colorspace when calculating this transform will match the standard white point for the first reference illuminant (i.e. no chromatic adaptation will be applied by this transform).

Optional - This value may be null on some devices.

See also:

SENSOR_COLOR_TRANSFORM2

added in API level 21
Key<ColorSpaceTransform> SENSOR_COLOR_TRANSFORM2

A matrix that transforms color values from CIE XYZ color space to reference sensor color space.

This matrix is used to convert from the standard CIE XYZ color space to the reference sensor colorspace, and is used when processing raw buffer data.

The matrix is expressed as a 3x3 matrix in row-major-order, and contains a color transform matrix that maps colors from the CIE XYZ color space to the reference sensor color space (i.e. the "golden module" colorspace) under the second reference illuminant (android.sensor.referenceIlluminant2).

The white points chosen in both the reference sensor color space and the CIE XYZ colorspace when calculating this transform will match the standard white point for the second reference illuminant (i.e. no chromatic adaptation will be applied by this transform).

This matrix will only be present if the second reference illuminant is present.

Optional - This value may be null on some devices.

See also:

SENSOR_FORWARD_MATRIX1

added in API level 21
Key<ColorSpaceTransform> SENSOR_FORWARD_MATRIX1

A matrix that transforms white balanced camera colors from the reference sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.

This matrix is used to convert to the standard CIE XYZ colorspace, and is used when processing raw buffer data.

This matrix is expressed as a 3x3 matrix in row-major-order, and contains a color transform matrix that maps white balanced colors from the reference sensor color space to the CIE XYZ color space with a D50 white point.

Under the first reference illuminant (android.sensor.referenceIlluminant1) this matrix is chosen so that the standard white point for this reference illuminant in the reference sensor colorspace is mapped to D50 in the CIE XYZ colorspace.

Optional - This value may be null on some devices.

See also:

SENSOR_FORWARD_MATRIX2

added in API level 21
Key<ColorSpaceTransform> SENSOR_FORWARD_MATRIX2

A matrix that transforms white balanced camera colors from the reference sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.

This matrix is used to convert to the standard CIE XYZ colorspace, and is used when processing raw buffer data.

This matrix is expressed as a 3x3 matrix in row-major-order, and contains a color transform matrix that maps white balanced colors from the reference sensor color space to the CIE XYZ color space with a D50 white point.

Under the second reference illuminant (android.sensor.referenceIlluminant2) this matrix is chosen so that the standard white point for this reference illuminant in the reference sensor colorspace is mapped to D50 in the CIE XYZ colorspace.

This matrix will only be present if the second reference illuminant is present.

Optional - This value may be null on some devices.

See also:

SENSOR_INFO_ACTIVE_ARRAY_SIZE

added in API level 21
Key<Rect> SENSOR_INFO_ACTIVE_ARRAY_SIZE

The area of the image sensor which corresponds to active pixels after any geometric distortion correction has been applied.

This is the rectangle representing the size of the active region of the sensor (i.e. the region that actually receives light from the scene) after any geometric correction has been applied, and should be treated as the maximum size in pixels of any of the image output formats aside from the raw formats.

This rectangle is defined relative to the full pixel array; (0,0) is the top-left of the full pixel array, and the size of the full pixel array is given by android.sensor.info.pixelArraySize.

The coordinate system for most other keys that list pixel coordinates, including android.scaler.cropRegion, is defined relative to the active array rectangle given in this field, with (0, 0) being the top-left of this rectangle.

The active array may be smaller than the full pixel array, since the full array may include black calibration pixels or other inactive regions, and geometric correction resulting in scaling or cropping may have been applied.

Units: Pixel coordinates on the image sensor

This key is available on all devices.

See also:

SENSOR_INFO_COLOR_FILTER_ARRANGEMENT

added in API level 21
Key<Integer> SENSOR_INFO_COLOR_FILTER_ARRANGEMENT

The arrangement of color filters on sensor; represents the colors in the top-left 2x2 section of the sensor, in reading order.

Possible values:

Optional - This value may be null on some devices.

Full capability - Present on all camera devices that report being HARDWARE_LEVEL_FULL devices in the android.info.supportedHardwareLevel key

See also:

SENSOR_INFO_EXPOSURE_TIME_RANGE

added in API level 21
Key<Range<Long>> SENSOR_INFO_EXPOSURE_TIME_RANGE

The range of image exposure times for android.sensor.exposureTime supported by this camera device.

Units: Nanoseconds

Range of valid values:
The minimum exposure time will be less than 100 us. For FULL capability devices (android.info.supportedHardwareLevel == FULL), the maximum exposure time will be greater than 100ms.

Optional - This value may be null on some devices.

Full capability - Present on all camera devices that report being HARDWARE_LEVEL_FULL devices in the android.info.supportedHardwareLevel key

See also:

SENSOR_INFO_LENS_SHADING_APPLIED

added in API level 23
Key<Boolean> SENSOR_INFO_LENS_SHADING_APPLIED

Whether the RAW images output from this camera device are subject to lens shading correction.

If TRUE, all images produced by the camera device in the RAW image formats will have lens shading correction already applied to it. If FALSE, the images will not be adjusted for lens shading correction. See android.request.maxNumOutputRaw for a list of RAW image formats.

This key will be null for all devices do not report this information. Devices with RAW capability will always report this information in this key.

Optional - This value may be null on some devices.

See also:

SENSOR_INFO_MAX_FRAME_DURATION

added in API level 21
Key<Long> SENSOR_INFO_MAX_FRAME_DURATION

The maximum possible frame duration (minimum frame rate) for android.sensor.frameDuration that is supported this camera device.

Attempting to use frame durations beyond the maximum will result in the frame duration being clipped to the maximum. See that control for a full definition of frame durations.

Refer to getOutputMinFrameDuration(int, Size) for the minimum frame duration values.

Units: Nanoseconds

Range of valid values:
For FULL capability devices (android.info.supportedHardwareLevel == FULL), at least 100ms.

Optional - This value may be null on some devices.

Full capability - Present on all camera devices that report being HARDWARE_LEVEL_FULL devices in the android.info.supportedHardwareLevel key

See also:

SENSOR_INFO_PHYSICAL_SIZE

added in API level 21
Key<SizeF> SENSOR_INFO_PHYSICAL_SIZE

The physical dimensions of the full pixel array.

This is the physical size of the sensor pixel array defined by android.sensor.info.pixelArraySize.

Units: Millimeters

This key is available on all devices.

See also:

SENSOR_INFO_PIXEL_ARRAY_SIZE

added in API level 21
Key<Size> SENSOR_INFO_PIXEL_ARRAY_SIZE

Dimensions of the full pixel array, possibly including black calibration pixels.

The pixel count of the full pixel array of the image sensor, which covers android.sensor.info.physicalSize area. This represents the full pixel dimensions of the raw buffers produced by this sensor.

If a camera device supports raw sensor formats, either this or android.sensor.info.preCorrectionActiveArraySize is the maximum dimensions for the raw output formats listed in android.scaler.streamConfigurationMap (this depends on whether or not the image sensor returns buffers containing pixels that are not part of the active array region for blacklevel calibration or other purposes).

Some parts of the full pixel array may not receive light from the scene, or be otherwise inactive. The android.sensor.info.preCorrectionActiveArraySize key defines the rectangle of active pixels that will be included in processed image formats.

Units: Pixels

This key is available on all devices.

See also:

SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE

added in API level 23
Key<Rect> SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE

The area of the image sensor which corresponds to active pixels prior to the application of any geometric distortion correction.

This is the rectangle representing the size of the active region of the sensor (i.e. the region that actually receives light from the scene) before any geometric correction has been applied, and should be treated as the active region rectangle for any of the raw formats. All metadata associated with raw processing (e.g. the lens shading correction map, and radial distortion fields) treats the top, left of this rectangle as the origin, (0,0).

The size of this region determines the maximum field of view and the maximum number of pixels that an image from this sensor can contain, prior to the application of geometric distortion correction. The effective maximum pixel dimensions of a post-distortion-corrected image is given by the android.sensor.info.activeArraySize field, and the effective maximum field of view for a post-distortion-corrected image can be calculated by applying the geometric distortion correction fields to this rectangle, and cropping to the rectangle given in android.sensor.info.activeArraySize.

E.g. to calculate position of a pixel, (x,y), in a processed YUV output image with the dimensions in android.sensor.info.activeArraySize given the position of a pixel, (x', y'), in the raw pixel array with dimensions give in android.sensor.info.pixelArraySize:

  1. Choose a pixel (x', y') within the active array region of the raw buffer given in android.sensor.info.preCorrectionActiveArraySize, otherwise this pixel is considered to be outside of the FOV, and will not be shown in the processed output image.
  2. Apply geometric distortion correction to get the post-distortion pixel coordinate, (x_i, y_i). When applying geometric correction metadata, note that metadata for raw buffers is defined relative to the top, left of the android.sensor.info.preCorrectionActiveArraySize rectangle.
  3. If the resulting corrected pixel coordinate is within the region given in android.sensor.info.activeArraySize, then the position of this pixel in the processed output image buffer is (x_i - activeArray.left, y_i - activeArray.top), when the top, left coordinate of that buffer is treated as (0, 0).

Thus, for pixel x',y' = (25, 25) on a sensor where android.sensor.info.pixelArraySize is (100,100), android.sensor.info.preCorrectionActiveArraySize is (10, 10, 100, 100), android.sensor.info.activeArraySize is (20, 20, 80, 80), and the geometric distortion correction doesn't change the pixel coordinate, the resulting pixel selected in pixel coordinates would be x,y = (25, 25) relative to the top,left of the raw buffer with dimensions given in android.sensor.info.pixelArraySize, and would be (5, 5) relative to the top,left of post-processed YUV output buffer with dimensions given in android.sensor.info.activeArraySize.

The currently supported fields that correct for geometric distortion are:

  1. android.lens.radialDistortion.

If all of the geometric distortion fields are no-ops, this rectangle will be the same as the post-distortion-corrected rectangle given in android.sensor.info.activeArraySize.

This rectangle is defined relative to the full pixel array; (0,0) is the top-left of the full pixel array, and the size of the full pixel array is given by android.sensor.info.pixelArraySize.

The pre-correction active array may be smaller than the full pixel array, since the full array may include black calibration pixels or other inactive regions.

Units: Pixel coordinates on the image sensor

This key is available on all devices.

See also:

SENSOR_INFO_SENSITIVITY_RANGE

added in API level 21
Key<Range<Integer>> SENSOR_INFO_SENSITIVITY_RANGE

Range of sensitivities for android.sensor.sensitivity supported by this camera device.

The values are the standard ISO sensitivity values, as defined in ISO 12232:2006.

Range of valid values:
Min <= 100, Max >= 800

Optional - This value may be null on some devices.

Full capability - Present on all camera devices that report being HARDWARE_LEVEL_FULL devices in the android.info.supportedHardwareLevel key

See also:

SENSOR_INFO_TIMESTAMP_SOURCE

added in API level 21
Key<Integer> SENSOR_INFO_TIMESTAMP_SOURCE

The time base source for sensor capture start timestamps.

The timestamps provided for captures are always in nanoseconds and monotonic, but may not based on a time source that can be compared to other system time sources.

This characteristic defines the source for the timestamps, and therefore whether they can be compared against other system time sources/timestamps.

Possible values:

This key is available on all devices.

See also:

SENSOR_INFO_WHITE_LEVEL

added in API level 21
Key<Integer> SENSOR_INFO_WHITE_LEVEL

Maximum raw value output by sensor.

This specifies the fully-saturated encoding level for the raw sample values from the sensor. This is typically caused by the sensor becoming highly non-linear or clipping. The minimum for each channel is specified by the offset in the android.sensor.blackLevelPattern key.

The white level is typically determined either by sensor bit depth (8-14 bits is expected), or by the point where the sensor response becomes too non-linear to be useful. The default value for this is maximum representable value for a 16-bit raw sample (2^16 - 1).

The white level values of captured images may vary for different capture settings (e.g., android.sensor.sensitivity). This key represents a coarse approximation for such case. It is recommended to use android.sensor.dynamicWhiteLevel for captures when supported by the camera device, which provides more accurate white level values.

Range of valid values:
> 255 (8-bit output)

Optional - This value may be null on some devices.

See also:

SENSOR_MAX_ANALOG_SENSITIVITY

added in API level 21
Key<Integer> SENSOR_MAX_ANALOG_SENSITIVITY

Maximum sensitivity that is implemented purely through analog gain.

For android.sensor.sensitivity values less than or equal to this, all applied gain must be analog. For values above this, the gain applied can be a mix of analog and digital.

Optional - This value may be null on some devices.

Full capability - Present on all camera devices that report being HARDWARE_LEVEL_FULL devices in the android.info.supportedHardwareLevel key

See also:

SENSOR_OPTICAL_BLACK_REGIONS

added in API level 24
Key<Rect[]> SENSOR_OPTICAL_BLACK_REGIONS

List of disjoint rectangles indicating the sensor optically shielded black pixel regions.

In most camera sensors, the active array is surrounded by some optically shielded pixel areas. By blocking light, these pixels provides a reliable black reference for black level compensation in active array region.

This key provides a list of disjoint rectangles specifying the regions of optically shielded (with metal shield) black pixel regions if the camera device is capable of reading out these black pixels in the output raw images. In comparison to the fixed black level values reported by android.sensor.blackLevelPattern, this key may provide a more accurate way for the application to calculate black level of each captured raw images.

When this key is reported, the android.sensor.dynamicBlackLevel and android.sensor.dynamicWhiteLevel will also be reported.

Optional - This value may be null on some devices.

See also:

SENSOR_ORIENTATION

added in API level 21
Key<Integer> SENSOR_ORIENTATION

Clockwise angle through which the output image needs to be rotated to be upright on the device screen in its native orientation.

Also defines the direction of rolling shutter readout, which is from top to bottom in the sensor's coordinate system.

Units: Degrees of clockwise rotation; always a multiple of 90

Range of valid values:
0, 90, 180, 270

This key is available on all devices.

SENSOR_REFERENCE_ILLUMINANT1

added in API level 21
Key<Integer> SENSOR_REFERENCE_ILLUMINANT1

The standard reference illuminant used as the scene light source when calculating the android.sensor.colorTransform1, android.sensor.calibrationTransform1, and android.sensor.forwardMatrix1 matrices.

The values in this key correspond to the values defined for the EXIF LightSource tag. These illuminants are standard light sources that are often used calibrating camera devices.

If this key is present, then android.sensor.colorTransform1, android.sensor.calibrationTransform1, and android.sensor.forwardMatrix1 will also be present.

Some devices may choose to provide a second set of calibration information for improved quality, including android.sensor.referenceIlluminant2 and its corresponding matrices.

Possible values:

Optional - This value may be null on some devices.

See also:

SENSOR_REFERENCE_ILLUMINANT2

added in API level 21
Key<Byte> SENSOR_REFERENCE_ILLUMINANT2

The standard reference illuminant used as the scene light source when calculating the android.sensor.colorTransform2, android.sensor.calibrationTransform2, and android.sensor.forwardMatrix2 matrices.

See android.sensor.referenceIlluminant1 for more details.

If this key is present, then android.sensor.colorTransform2, android.sensor.calibrationTransform2, and android.sensor.forwardMatrix2 will also be present.

Range of valid values:
Any value listed in android.sensor.referenceIlluminant1

Optional - This value may be null on some devices.

See also:

SHADING_AVAILABLE_MODES

added in API level 23
Key<int[]> SHADING_AVAILABLE_MODES

List of lens shading modes for android.shading.mode that are supported by this camera device.

This list contains lens shading modes that can be set for the camera device. Camera devices that support the MANUAL_POST_PROCESSING capability will always list OFF and FAST mode. This includes all FULL level devices. LEGACY devices will always only support FAST mode.

Range of valid values:
Any value listed in android.shading.mode

This key is available on all devices.

See also:

STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES

added in API level 21
Key<int[]> STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES

List of face detection modes for android.statistics.faceDetectMode that are supported by this camera device.

OFF is always supported.

Range of valid values:
Any value listed in android.statistics.faceDetectMode

This key is available on all devices.

See also:

STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES

added in API level 21
Key<boolean[]> STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES

List of hot pixel map output modes for android.statistics.hotPixelMapMode that are supported by this camera device.

If no hotpixel map output is available for this camera device, this will contain only false.

ON is always supported on devices with the RAW capability.

Range of valid values:
Any value listed in android.statistics.hotPixelMapMode

Optional - This value may be null on some devices.

See also:

STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES

added in API level 23
Key<int[]> STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES

List of lens shading map output modes for android.statistics.lensShadingMapMode that are supported by this camera device.

If no lens shading map output is available for this camera device, this key will contain only OFF.

ON is always supported on devices with the RAW capability. LEGACY mode devices will always only support OFF.

Range of valid values:
Any value listed in android.statistics.lensShadingMapMode

Optional - This value may be null on some devices.

See also:

STATISTICS_INFO_MAX_FACE_COUNT

added in API level 21
Key<Integer> STATISTICS_INFO_MAX_FACE_COUNT

The maximum number of simultaneously detectable faces.

Range of valid values:
0 for cameras without available face detection; otherwise: >=4 for LIMITED or FULL hwlevel devices or >0 for LEGACY devices.

This key is available on all devices.

SYNC_MAX_LATENCY

added in API level 21
Key<Integer> SYNC_MAX_LATENCY

The maximum number of frames that can occur after a request (different than the previous) has been submitted, and before the result's state becomes synchronized.

This defines the maximum distance (in number of metadata results), between the frame number of the request that has new controls to apply and the frame number of the result that has all the controls applied.

In other words this acts as an upper boundary for how many frames must occur before the camera device knows for a fact that the new submitted camera settings have been applied in outgoing frames.

Units: Frame counts

Possible values:

Available values for this device:
A positive value, PER_FRAME_CONTROL, or UNKNOWN.

This key is available on all devices.

See also:

TONEMAP_AVAILABLE_TONE_MAP_MODES

added in API level 21
Key<int[]> TONEMAP_AVAILABLE_TONE_MAP_MODES

List of tonemapping modes for android.tonemap.mode that are supported by this camera device.

Camera devices that support the MANUAL_POST_PROCESSING capability will always contain at least one of below mode combinations:

  • CONTRAST_CURVE, FAST and HIGH_QUALITY
  • GAMMA_VALUE, PRESET_CURVE, FAST and HIGH_QUALITY

This includes all FULL level devices.

Range of valid values:
Any value listed in android.tonemap.mode

Optional - This value may be null on some devices.

Full capability - Present on all camera devices that report being HARDWARE_LEVEL_FULL devices in the android.info.supportedHardwareLevel key

See also:

TONEMAP_MAX_CURVE_POINTS

added in API level 21
Key<Integer> TONEMAP_MAX_CURVE_POINTS

Maximum number of supported points in the tonemap curve that can be used for android.tonemap.curve.

If the actual number of points provided by the application (in android.tonemap.curve*) is less than this maximum, the camera device will resample the curve to its internal representation, using linear interpolation.

The output curves in the result metadata may have a different number of points than the input curves, and will represent the actual hardware curves used as closely as possible when linearly interpolated.

Optional - This value may be null on some devices.

Full capability - Present on all camera devices that report being HARDWARE_LEVEL_FULL devices in the android.info.supportedHardwareLevel key

See also:

Public methods

get

added in API level 21
T get (Key<T> key)

Get a camera characteristics field value.

The field definitions can be found in CameraCharacteristics.

Querying the value for the same key more than once will return a value which is equal to the previous queried value.

Parameters
key Key: The characteristics field to read.

Returns
T The value of that key, or null if the field is not set.

Throws
IllegalArgumentException if the key was not valid

getAvailableCaptureRequestKeys

added in API level 21
List<Key<?>> getAvailableCaptureRequestKeys ()

Returns the list of keys supported by this CameraDevice for querying with a CaptureRequest.

The list returned is not modifiable, so any attempts to modify it will throw a UnsupportedOperationException.

Each key is only listed once in the list. The order of the keys is undefined.

Note that there is no getAvailableCameraCharacteristicsKeys() -- use getKeys() instead.

Returns
List<Key<?>> List of keys supported by this CameraDevice for CaptureRequests.

This value will never be null.

getAvailableCaptureResultKeys

added in API level 21
List<Key<?>> getAvailableCaptureResultKeys ()

Returns the list of keys supported by this CameraDevice for querying with a CaptureResult.

The list returned is not modifiable, so any attempts to modify it will throw a UnsupportedOperationException.

Each key is only listed once in the list. The order of the keys is undefined.

Note that there is no getAvailableCameraCharacteristicsKeys() -- use getKeys() instead.

Returns
List<Key<?>> List of keys supported by this CameraDevice for CaptureResults.

This value will never be null.

getKeys

added in API level 21
List<Key<?>> getKeys ()

Returns a list of the keys contained in this map.

The list returned is not modifiable, so any attempts to modify it will throw a UnsupportedOperationException.

All values retrieved by a key from this list with #get are guaranteed to be non-null. Each key is only listed once in the list. The order of the keys is undefined.

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

This value will never be null.

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

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

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

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

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

This class requires API level or higher

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

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

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)