CameraCharacteristics

The set of auto-exposure antibanding modes 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; they must include AUTO.

The set of auto-exposure modes 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.

List of frame rate ranges supported by the auto-exposure (AE) algorithm/hardware

Maximum and minimum exposure compensation setting, in counts of android.control.aeCompensationStep.

Smallest step by which exposure compensation can be changed

List of auto-focus (AF) modes that can be selected with android.control.afMode.

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 camera devices will support OFF mode, and all camera devices with adjustable focuser units (android.lens.info.minimumFocusDistance > 0) will support AUTO mode.

List containing the subset of color effects specified in android.control.effectMode that is supported by this device.

This list contains the color effect modes that can be applied to images produced by the camera device. Only modes that have been fully implemented for the current device may be included here. Implementations are not expected to be consistent across all devices. If no color effect modes are available for a device, this should simply be set to OFF.

A color effect will only be applied if android.control.mode != OFF.

List containing a subset of scene modes specified in android.control.sceneMode.

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

List of video stabilization modes that can be supported

The set of auto-white-balance modes (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.

FULL mode camera devices 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).

List of the maximum number of regions that can be used for metering in auto-exposure (AE); this corresponds to the the maximum number of elements in android.control.aeRegions.

List of the maximum number of regions that can be used for metering in auto-focus (AF); this corresponds to the the maximum number of elements in android.control.afRegions.

List of the maximum number of regions that can be used for metering in auto-white balance (AWB); this corresponds to the the maximum number of elements in android.control.awbRegions.

The set of edge enhancement modes supported by this camera device.

This tag lists the valid modes for android.edge.mode.

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

Whether this camera device has a flash.

If no flash, none of the flash controls do anything. All other metadata should return 0.

The set of hot pixel correction modes that are supported by this camera device.

This tag lists valid modes for android.hotPixel.mode.

FULL mode camera devices will always support FAST.

Generally classifies the overall set of the camera device functionality.

Camera devices will come in two flavors: LIMITED and FULL.

A FULL device has the most support possible and will enable the widest range of use cases such as:

• 30fps at maximum resolution (== sensor resolution) is preferred, more than 20fps is required.
• Per frame control (android.sync.maxLatency == PER_FRAME_CONTROL)
• Manual sensor control (android.request.availableCapabilities contains MANUAL_SENSOR)
• Manual post-processing control (android.request.availableCapabilities contains MANUAL_POST_PROCESSING)

A LIMITED device may have some or none of the above characteristics. To find out more refer to android.request.availableCapabilities.

Supported resolutions for the JPEG thumbnail.

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.

Direction the camera faces relative to device screen.

List of supported aperture values.

If the camera device doesn't support variable apertures, listed value will be the fixed aperture.

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

List of supported neutral density filter values for android.lens.filterDensity.

If changing android.lens.filterDensity is not supported, availableFilterDensities must contain only 0. Otherwise, this list contains only the exact filter density values available on this camera device.

The available focal lengths for this device for use with android.lens.focalLength.

If optical zoom is not supported, this will only report a single value corresponding to the static focal length of the device. Otherwise, this will report every focal length supported by the device.

List containing a subset of the optical image stabilization (OIS) modes specified in android.lens.opticalStabilizationMode.

If OIS is not implemented for a given camera device, this will contain only OFF.

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.

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

Optional - This value may be null on some devices.

Shortest distance from frontmost surface of the lens that can be focused correctly.

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

The set of noise reduction modes supported by this camera device.

This tag lists the valid modes for android.noiseReduction.mode.

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

List of capabilities that the 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 field to be sure.

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:

• ImageFormat#YUV_420_888
• ImageFormat#NV21
• ImageFormat#YV12
• Implementation-defined formats, i.e. StreamConfiguration#isOutputSupportedFor(Class)

For full guarantees, query StreamConfigurationMap#getOutputStallDuration with a processed format -- it will return 0 for a non-stalling stream.

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 (ImageFormat#JPEG)

For full guarantees, query StreamConfigurationMap#getOutputStallDuration with a processed format -- it will return a non-0 value for a stalling stream.

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:

• ImageFormat#RAW_SENSOR
• Opaque RAW

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.

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 be 8 or less.

The maximum ratio between both active area width and crop region width, and active area height and crop region height.

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.

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.

FULL capability devices (android.info.supportedHardwareLevel == FULL) will support FREEFORM cropping.

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):

Refer to android.request.availableCapabilities for additional mandatory stream configurations on a per-capability basis.

Lists the supported sensor test pattern modes for android.sensor.testPatternMode.

Optional. Defaults to [OFF].

Optional - This value may be null on some devices.

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

This tag 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 row-column scan order, with the first value corresponding to the element of the CFA in row=0, column=0.

Optional - This value may be null on some devices.

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.

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.

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.

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.

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.

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.

Area of raw data which corresponds to only active pixels.

It is smaller or equal to sensor full pixel array, which could include the black calibration pixels.

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

Range of valid exposure times used by android.sensor.exposureTime.

Maximum possible frame duration (minimum frame rate).

The largest possible android.sensor.frameDuration that will be accepted by the 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 StreamConfigurationMap#getOutputMinFrameDuration(int,Size) for the minimum frame duration values.

The physical dimensions of the full pixel array.

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

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

The pixel count of the full pixel array, which covers android.sensor.info.physicalSize area.

If a camera device supports raw sensor formats, either this or android.sensor.info.activeArraySize is the maximum output raw size listed in android.scaler.streamConfigurationMap. If a size corresponding to pixelArraySize is listed, the resulting raw sensor image will include black pixels.

Range of valid sensitivities.

The minimum and maximum valid values for the android.sensor.sensitivity control.

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

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

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

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

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

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

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. Valid values for this are the same as those given for the first reference illuminant.

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

The face detection modes that are available for this camera device.

OFF is always supported.

SIMPLE means the device supports the android.statistics.faceRectangles and android.statistics.faceScores outputs.

FULL means the device additionally supports the android.statistics.faceIds and android.statistics.faceLandmarks outputs.

The set of hot pixel map output modes supported by this camera device.

This tag lists valid output modes for android.statistics.hotPixelMapMode.

If no hotpixel map is available for this camera device, this will contain only OFF. If the hotpixel map is available, this will include both the ON and OFF options.

The maximum number of simultaneously detectable faces.

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 (by setting android.sync.frameNumber to a non-negative value).

This defines the maximum distance (in number of metadata results), between android.sync.frameNumber and the equivalent android.request.frameCount.

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.

For example if the distance was 2,

initial request = X (repeating)
 request1 = X
 request2 = Y
 request3 = Y
 request4 = Y

 where requestN has frameNumber N, and the first of the repeating
 initial request's has frameNumber F (and F < 1).

 initial result = X' + { android.sync.frameNumber == F }
 result1 = X' + { android.sync.frameNumber == F }
 result2 = X' + { android.sync.frameNumber == CONVERGING }
 result3 = X' + { android.sync.frameNumber == CONVERGING }
 result4 = X' + { android.sync.frameNumber == 2 }

 where resultN has frameNumber N.
 

Since result4 has a frameNumber == 4 and android.sync.frameNumber == 2, the distance is clearly 4 - 2 = 2.

The set of tonemapping modes supported by this camera device.

This tag lists the valid modes for android.tonemap.mode.

Full-capability camera devices must always support CONTRAST_CURVE and FAST.

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 max, 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.

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.

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