Added in API level 21

CameraCharacteristics

class CameraCharacteristics : CameraMetadata<CameraCharacteristics.Key<*>!>
kotlin.Any
   ↳ android.hardware.camera2.CameraMetadata<android.hardware.camera2.CameraCharacteristics.Key<*>>
   ↳ android.hardware.camera2.CameraCharacteristics

The properties describing a CameraDevice.

These properties are primarily fixed for a given CameraDevice, and can be queried through the CameraManager interface with CameraManager#getCameraCharacteristics. Beginning with API level 32, some properties such as SENSOR_ORIENTATION may change dynamically based on the state of the device. For information on whether a specific value is fixed, see the documentation for its key.

When obtained by a client that does not hold the CAMERA permission, some metadata values are not included. The list of keys that require the permission is given by getKeysNeedingPermission.

CameraCharacteristics objects are immutable.

Summary

Nested classes

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

Inherited constants
Public methods
T?

Get a camera characteristics field value.

MutableList<CaptureRequest.Key<*>!>

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

MutableList<CaptureResult.Key<*>!>

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

MutableList<CaptureRequest.Key<*>!>!

Returns a subset of getAvailableCaptureRequestKeys keys that can be overridden for physical devices backing a logical multi-camera.

MutableList<CameraCharacteristics.Key<*>!>

Get the keys in Camera Characteristics whose values are capture session specific.

MutableList<CaptureRequest.Key<*>!>!

Returns a subset of getAvailableCaptureRequestKeys keys that the camera device can pass as part of the capture session initialization.

MutableList<CameraCharacteristics.Key<*>!>

Returns a list of the keys contained in this map.

MutableList<CameraCharacteristics.Key<*>!>

Returns a subset of the list returned by getKeys with all keys that require camera clients to obtain the android.Manifest.permission#CAMERA permission.

MutableSet<String!>

Returns the set of physical camera ids that this logical CameraDevice is made up of.

RecommendedStreamConfigurationMap?

Retrieve camera device recommended stream configuration map RecommendedStreamConfigurationMap for a given use case.

Properties
static CameraCharacteristics.Key<IntArray!>

The direction of the camera faces relative to the vehicle body frame and the passenger seats.

static CameraCharacteristics.Key<Int!>

Location of the cameras on the automotive devices.

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<Array<Range<Int!>!>!>

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

static CameraCharacteristics.Key<Range<Int!>!>

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

static CameraCharacteristics.Key<Rational!>

Smallest step by which the exposure compensation can be changed.

static CameraCharacteristics.Key<Boolean!>

Whether the camera device supports android.control.aeLock

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<Boolean!>

Whether the camera device supports android.control.autoframing.

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<Array<Capability!>!>

The list of extended scene modes for android.control.extendedSceneMode that are supported by this camera device, and each extended scene mode's capabilities such as maximum streaming size, and supported zoom ratio ranges.

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<IntArray!>

List of available settings overrides supported by the camera device that can be used to speed up certain controls.

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<Boolean!>

Whether the camera device supports android.control.awbLock

static CameraCharacteristics.Key<Range<Float!>!>

The operating luminance range of low light boost measured in lux (lx).

static CameraCharacteristics.Key<Int!>

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

static CameraCharacteristics.Key<Int!>

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

static CameraCharacteristics.Key<Int!>

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

static CameraCharacteristics.Key<Range<Int!>!>

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

static CameraCharacteristics.Key<Range<Float!>!>

Minimum and maximum zoom ratios supported by this camera device.

static CameraCharacteristics.Key<Boolean!>

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.

static CameraCharacteristics.Key<IntArray!>

List of distortion correction modes for android.distortionCorrection.mode that are supported by this camera device.

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<Boolean!>

Whether this camera device has a flash unit.

static CameraCharacteristics.Key<Int!>

Default flashlight brightness level to be set via android.hardware.camera2.CameraManager#turnOnTorchWithStrengthLevel.

static CameraCharacteristics.Key<Int!>

Maximum flashlight brightness level.

static CameraCharacteristics.Key<Int!>

Default flash brightness level for manual flash control in SINGLE mode.

static CameraCharacteristics.Key<Int!>

Maximum flash brightness level for manual flash control in SINGLE mode.

static CameraCharacteristics.Key<Int!>

Default flash brightness level for manual flash control in TORCH mode

static CameraCharacteristics.Key<Int!>

Maximum flash brightness level for manual flash control in TORCH mode

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<DeviceStateSensorOrientationMap!>

This lists the mapping between a device folding state and specific camera sensor orientation for logical cameras on a foldable device.

static CameraCharacteristics.Key<Int!>

The version of the session configuration query android.hardware.camera2.CameraManager#isSessionConfigurationWithParametersSupported API

static CameraCharacteristics.Key<Int!>

Generally classifies the overall set of the camera device functionality.

static CameraCharacteristics.Key<String!>

A short string for manufacturer version information about the camera device, such as ISP hardware, sensors, etc.

static CameraCharacteristics.Key<Array<Size!>!>

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

static CameraCharacteristics.Key<FloatArray!>

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

static CameraCharacteristics.Key<FloatArray!>

The correction coefficients to correct for this camera device's radial and tangential lens distortion for a CaptureRequest with android.sensor.pixelMode set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION.

static CameraCharacteristics.Key<Int!>

Direction the camera faces relative to device screen.

static CameraCharacteristics.Key<FloatArray!>

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

static CameraCharacteristics.Key<FloatArray!>

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

static CameraCharacteristics.Key<FloatArray!>

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

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<Int!>

The lens focus distance calibration quality.

static CameraCharacteristics.Key<Float!>

Hyperfocal distance for this lens.

static CameraCharacteristics.Key<Float!>

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

static CameraCharacteristics.Key<FloatArray!>

The parameters for this camera device's intrinsic calibration.

static CameraCharacteristics.Key<FloatArray!>

The parameters for this camera device's intrinsic calibration when android.sensor.pixelMode is set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION.

static CameraCharacteristics.Key<Int!>

The origin for android.lens.poseTranslation, and the accuracy of android.lens.poseTranslation and android.lens.poseRotation.

static CameraCharacteristics.Key<FloatArray!>

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

static CameraCharacteristics.Key<FloatArray!>

Position of the camera optical center.

static CameraCharacteristics.Key<FloatArray!>

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

static CameraCharacteristics.Key<Int!>

The accuracy of frame timestamp synchronization between physical cameras

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<Int!>

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

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<ColorSpaceProfiles!>

An interface for querying the color space profiles supported by a camera device.

static CameraCharacteristics.Key<DynamicRangeProfiles!>

Devices supporting the 10-bit output capability android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT must list their supported dynamic range profiles along with capture request constraints for specific profile combinations.

static CameraCharacteristics.Key<Int!>

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

static CameraCharacteristics.Key<Int!>

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.

static CameraCharacteristics.Key<Int!>

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.

static CameraCharacteristics.Key<Int!>

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

static CameraCharacteristics.Key<Int!>

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

static CameraCharacteristics.Key<Byte!>

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.

static CameraCharacteristics.Key<Long!>

Recommended 10-bit dynamic range profile.

static CameraCharacteristics.Key<Float!>

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

static CameraCharacteristics.Key<IntArray!>

List of rotate-and-crop modes for android.scaler.rotateAndCrop that are supported by this camera device.

static CameraCharacteristics.Key<LongArray!>

The stream use cases supported by this camera device.

static CameraCharacteristics.Key<Int!>

The crop type that this camera device supports.

static CameraCharacteristics.Key<Size!>

Default YUV/PRIVATE size to use for requesting secure image buffers.

static CameraCharacteristics.Key<Array<MandatoryStreamCombination!>!>

An array of mandatory concurrent stream combinations.

static CameraCharacteristics.Key<Array<MandatoryStreamCombination!>!>

An array of mandatory stream combinations which are applicable when android.hardware.camera2.CaptureRequest has android.sensor.pixelMode set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION.

static CameraCharacteristics.Key<Array<MandatoryStreamCombination!>!>

An array of mandatory stream combinations which are applicable when device lists PREVIEW_STABILIZATION in android.control.availableVideoStabilizationModes.

static CameraCharacteristics.Key<Array<MandatoryStreamCombination!>!>

An array of mandatory stream combinations generated according to the camera device android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL and android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES.

static CameraCharacteristics.Key<Array<MandatoryStreamCombination!>!>

An array of mandatory stream combinations which are applicable when device support the 10-bit output capability android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT This is an app-readable conversion of the 10 bit output mandatory stream combination tables.

static CameraCharacteristics.Key<Array<MandatoryStreamCombination!>!>

An array of mandatory stream combinations with stream use cases.

static CameraCharacteristics.Key<MultiResolutionStreamConfigurationMap!>

The multi-resolution stream configurations supported by this logical camera or ultra high resolution sensor camera device.

static CameraCharacteristics.Key<StreamConfigurationMap!>

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

static CameraCharacteristics.Key<StreamConfigurationMap!>

The available stream configurations that this camera device supports when given a CaptureRequest with android.sensor.pixelMode set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION; also includes the minimum frame durations and the stall durations for each format/size combination.

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<BlackLevelPattern!>

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

static CameraCharacteristics.Key<ColorSpaceTransform!>

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

static CameraCharacteristics.Key<ColorSpaceTransform!>

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

static CameraCharacteristics.Key<ColorSpaceTransform!>

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

static CameraCharacteristics.Key<ColorSpaceTransform!>

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

static CameraCharacteristics.Key<ColorSpaceTransform!>

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

static CameraCharacteristics.Key<ColorSpaceTransform!>

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

static CameraCharacteristics.Key<Rect!>

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

static CameraCharacteristics.Key<Rect!>

The area of the image sensor which corresponds to active pixels after any geometric distortion correction has been applied, when the sensor runs in maximum resolution mode.

static CameraCharacteristics.Key<Size!>

Dimensions of the group of pixels which are under the same color filter.

static CameraCharacteristics.Key<Int!>

The arrangement of color filters on sensor; represents the colors in the top-left 2x2 section of the sensor, in reading order, for a Bayer camera, or the light spectrum it captures for MONOCHROME camera.

static CameraCharacteristics.Key<Range<Long!>!>

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

static CameraCharacteristics.Key<Boolean!>

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

static CameraCharacteristics.Key<Long!>

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

static CameraCharacteristics.Key<SizeF!>

The physical dimensions of the full pixel array.

static CameraCharacteristics.Key<Size!>

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

static CameraCharacteristics.Key<Size!>

Dimensions of the full pixel array, possibly including black calibration pixels, when the sensor runs in maximum resolution mode.

static CameraCharacteristics.Key<Rect!>

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

static CameraCharacteristics.Key<Rect!>

The area of the image sensor which corresponds to active pixels prior to the application of any geometric distortion correction, when the sensor runs in maximum resolution mode.

static CameraCharacteristics.Key<Range<Int!>!>

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

static CameraCharacteristics.Key<Int!>

The time base source for sensor capture start timestamps.

static CameraCharacteristics.Key<Int!>

Maximum raw value output by sensor.

static CameraCharacteristics.Key<Int!>

Maximum sensitivity that is implemented purely through analog gain.

static CameraCharacteristics.Key<Array<Rect!>!>

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

static CameraCharacteristics.Key<Int!>

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

static CameraCharacteristics.Key<Int!>

Whether or not the camera device supports readout timestamp and onReadoutStarted callback.

static CameraCharacteristics.Key<Int!>

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

static CameraCharacteristics.Key<Byte!>

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

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<BooleanArray!>

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

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<IntArray!>

List of OIS data output modes for android.statistics.oisDataMode that are supported by this camera device.

static CameraCharacteristics.Key<Int!>

The maximum number of simultaneously detectable faces.

static CameraCharacteristics.Key<Int!>

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.

static CameraCharacteristics.Key<IntArray!>

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

static CameraCharacteristics.Key<Int!>

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

Public methods

get

Added in API level 21
fun <T : Any!> get(key: CameraCharacteristics.Key<T>!): T?

Get a camera characteristics field value.

The field definitions can be found in CameraCharacteristics.

Parameters
key CameraCharacteristics.Key<T>!: The characteristics field to read.
Return
T? The value of that key, or null if the field is not set.
Exceptions
java.lang.IllegalArgumentException if the key was not valid

getAvailableCaptureRequestKeys

Added in API level 21
fun getAvailableCaptureRequestKeys(): MutableList<CaptureRequest.Key<*>!>

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.

Return
MutableList<CaptureRequest.Key<*>!> List of keys supported by this CameraDevice for CaptureRequests. This value cannot be null.

getAvailableCaptureResultKeys

Added in API level 21
fun getAvailableCaptureResultKeys(): MutableList<CaptureResult.Key<*>!>

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.

Return
MutableList<CaptureResult.Key<*>!> List of keys supported by this CameraDevice for CaptureResults. This value cannot be null.

getAvailablePhysicalCameraRequestKeys

Added in API level 28
fun getAvailablePhysicalCameraRequestKeys(): MutableList<CaptureRequest.Key<*>!>!

Returns a subset of getAvailableCaptureRequestKeys keys that can be overridden for physical devices backing a logical multi-camera.

This is a subset of android.request.availableRequestKeys which contains a list of keys that can be overridden using CaptureRequest.Builder#setPhysicalCameraKey. The respective value of such request key can be obtained by calling CaptureRequest.Builder#getPhysicalCameraKey. Capture requests that contain individual physical device requests must be built via android.hardware.camera2.CameraDevice#createCaptureRequest(int, Set).

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.

Return
MutableList<CaptureRequest.Key<*>!>! List of keys that can be overridden in individual physical device requests. In case the camera device doesn't support such keys the list can be null.

getAvailableSessionCharacteristicsKeys

fun getAvailableSessionCharacteristicsKeys(): MutableList<CameraCharacteristics.Key<*>!>

Get the keys in Camera Characteristics whose values are capture session specific. The session specific characteristics can be acquired by calling CameraDevice.getSessionCharacteristics().

Note that getAvailableSessionKeys returns the CaptureRequest keys that are difficult to apply per-frame, whereas this function returns CameraCharacteristics keys that are dependent on a particular SessionConfiguration.

Return
MutableList<CameraCharacteristics.Key<*>!> List of CameraCharacteristic keys containing characterisitics specific to a session configuration. For Android 15, this list only contains CONTROL_ZOOM_RATIO_RANGE and SCALER_AVAILABLE_MAX_DIGITAL_ZOOM. This value cannot be null.

getAvailableSessionKeys

Added in API level 28
fun getAvailableSessionKeys(): MutableList<CaptureRequest.Key<*>!>!

Returns a subset of getAvailableCaptureRequestKeys keys that the camera device can pass as part of the capture session initialization.

This list includes keys that are difficult to apply per-frame and can result in unexpected delays when modified during the capture session lifetime. Typical examples include parameters that require a time-consuming hardware re-configuration or internal camera pipeline change. For performance reasons we suggest clients to pass their initial values as part of SessionConfiguration#setSessionParameters. Once the camera capture session is enabled it is also recommended to avoid changing them from their initial values set in SessionConfiguration#setSessionParameters. Control over session parameters can still be exerted in capture requests but clients should be aware and expect delays during their application. An example usage scenario could look like this:

  • The camera client starts by querying the session parameter key list via android.hardware.camera2.CameraCharacteristics#getAvailableSessionKeys.
  • Before triggering the capture session create sequence, a capture request must be built via android.hardware.camera2.CameraDevice#createCaptureRequest using an appropriate template matching the particular use case.
  • The client should go over the list of session parameters and check whether some of the keys listed matches with the parameters that they intend to modify as part of the first capture request.
  • If there is no such match, the capture request can be passed unmodified to SessionConfiguration#setSessionParameters.
  • If matches do exist, the client should update the respective values and pass the request to SessionConfiguration#setSessionParameters.
  • After the capture session initialization completes the session parameter key list can continue to serve as reference when posting or updating further requests. As mentioned above further changes to session parameters should ideally be avoided, if updates are necessary however clients could expect a delay/glitch during the parameter switch.

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.

Return
MutableList<CaptureRequest.Key<*>!>! List of keys that can be passed during capture session initialization. In case the camera device doesn't support such keys the list can be null.

getKeys

Added in API level 21
fun getKeys(): MutableList<CameraCharacteristics.Key<*>!>

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.

Return
MutableList<CameraCharacteristics.Key<*>!> This value cannot be null.

getKeysNeedingPermission

Added in API level 29
fun getKeysNeedingPermission(): MutableList<CameraCharacteristics.Key<*>!>

Returns a subset of the list returned by getKeys with all keys that require camera clients to obtain the android.Manifest.permission#CAMERA permission.

If an application calls CameraManager#getCameraCharacteristics without holding the android.Manifest.permission#CAMERA permission, all keys in this list will not be available, and calling get will return null for those keys. If the application obtains the android.Manifest.permission#CAMERA permission, then the CameraCharacteristics from a call to a subsequent CameraManager#getCameraCharacteristics will have the keys available.

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.

Return
MutableList<CameraCharacteristics.Key<*>!> List of camera characteristic keys that require the android.Manifest.permission#CAMERA permission. The list can be empty in case there are no currently present keys that need additional permission.

getPhysicalCameraIds

Added in API level 28
fun getPhysicalCameraIds(): MutableSet<String!>

Returns the set of physical camera ids that this logical CameraDevice is made up of.

A camera device is a logical camera if it has REQUEST_AVAILABLE_CAPABILITIES_LOGICAL_MULTI_CAMERA capability. If the camera device doesn't have the capability, the return value will be an empty set.

Prior to API level 29, all returned IDs are guaranteed to be returned by android.hardware.camera2.CameraManager#getCameraIdList, and can be opened directly by android.hardware.camera2.CameraManager#openCamera. Starting from API level 29, for each of the returned ID, if it's also returned by CameraManager#getCameraIdList, it can be used as a standalone camera by android.hardware.camera2.CameraManager#openCamera. Otherwise, the camera ID can only be used as part of the current logical camera.

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

Return
MutableSet<String!> Set of physical camera ids for this logical camera device. This value cannot be null.

getRecommendedStreamConfigurationMap

Added in API level 29
fun getRecommendedStreamConfigurationMap(usecase: Int): RecommendedStreamConfigurationMap?

Retrieve camera device recommended stream configuration map RecommendedStreamConfigurationMap for a given use case.

The stream configurations advertised here are efficient in terms of power and performance for common use cases like preview, video, snapshot, etc. The recommended maps are usually only small subsets of the exhaustive list provided in SCALER_STREAM_CONFIGURATION_MAP and suggested for a particular use case by the camera device implementation. For further information about the expected configurations in various scenarios please refer to:

For example on how this can be used by camera clients to find out the maximum recommended preview and snapshot resolution, consider the following pseudo-code:

<code>
  public static Size getMaxSize(Size... sizes) {
      if (sizes == null || sizes.length == 0) {
          throw new IllegalArgumentException("sizes was empty");
      }
 
      Size sz = sizes[0];
      for (Size size : sizes) {
          if (size.getWidth() * size.getHeight() &gt; sz.getWidth() * sz.getHeight()) {
              sz = size;
          }
      }
 
      return sz;
  }
 
  CameraCharacteristics characteristics =
          cameraManager.getCameraCharacteristics(cameraId);
  RecommendedStreamConfigurationMap previewConfig =
          characteristics.getRecommendedStreamConfigurationMap(
                   RecommendedStreamConfigurationMap.USECASE_PREVIEW);
  RecommendedStreamConfigurationMap snapshotConfig =
          characteristics.getRecommendedStreamConfigurationMap(
                   RecommendedStreamConfigurationMap.USECASE_SNAPSHOT);
 
  if ((previewConfig != null) &amp;&amp; (snapshotConfig != null)) {
 
       Set
 <size>
   snapshotSizeSet = snapshotConfig.getOutputSizes( ImageFormat.JPEG); Size[] snapshotSizes = new Size[snapshotSizeSet.size()]; snapshotSizes = snapshotSizeSet.toArray(snapshotSizes); Size suggestedMaxJpegSize = getMaxSize(snapshotSizes); Set
  <size>
    previewSizeSet = snapshotConfig.getOutputSizes( ImageFormat.PRIVATE); Size[] previewSizes = new Size[previewSizeSet.size()]; previewSizes = previewSizeSet.toArray(previewSizes); Size suggestedMaxPreviewSize = getMaxSize(previewSizes); } 
  </size>
 </size></code>

Similar logic can be used for other use cases as well.

Support for recommended stream configurations is optional. In case there a no suggested configurations for the particular use case, please refer to SCALER_STREAM_CONFIGURATION_MAP for the exhaustive available list.

Parameters
usecase Int: Use case id. Value is android.hardware.camera2.params.RecommendedStreamConfigurationMap#USECASE_PREVIEW, android.hardware.camera2.params.RecommendedStreamConfigurationMap#USECASE_RECORD, android.hardware.camera2.params.RecommendedStreamConfigurationMap#USECASE_VIDEO_SNAPSHOT, android.hardware.camera2.params.RecommendedStreamConfigurationMap#USECASE_SNAPSHOT, android.hardware.camera2.params.RecommendedStreamConfigurationMap#USECASE_ZSL, android.hardware.camera2.params.RecommendedStreamConfigurationMap#USECASE_RAW, android.hardware.camera2.params.RecommendedStreamConfigurationMap#USECASE_LOW_LATENCY_SNAPSHOT, or android.hardware.camera2.params.RecommendedStreamConfigurationMap#USECASE_10BIT_OUTPUT
Return
RecommendedStreamConfigurationMap? Valid RecommendedStreamConfigurationMap or null in case the camera device doesn't have any recommendation for this use case or the recommended configurations are invalid.
Exceptions
java.lang.IllegalArgumentException In case the use case argument is invalid.

Properties

AUTOMOTIVE_LENS_FACING

Added in API level 33
static val AUTOMOTIVE_LENS_FACING: CameraCharacteristics.Key<IntArray!>

The direction of the camera faces relative to the vehicle body frame and the passenger seats.

This enum defines the lens facing characteristic of the cameras on the automotive devices with locations android.automotive.location defines. If the system has FEATURE_AUTOMOTIVE, the camera will have this entry in its static metadata.

When android.automotive.location is INTERIOR, this has one or more INTERIOR_* values or a single EXTERIOR_* value. When this has more than one INTERIOR_*, the first value must be the one for the seat closest to the optical axis. If this contains INTERIOR_OTHER, all other values will be ineffective.

When android.automotive.location is EXTERIOR_* or EXTRA, this has a single EXTERIOR_* value.

If a camera has INTERIOR_OTHER or EXTERIOR_OTHER, or more than one camera is at the same location and facing the same direction, their static metadata will list the following entries, so that applications can determine their lenses' exact facing directions:

Possible values:

Optional - The value for this key may be null on some devices.

See Also

AUTOMOTIVE_LOCATION

Added in API level 33
static val AUTOMOTIVE_LOCATION: CameraCharacteristics.Key<Int!>

Location of the cameras on the automotive devices.

This enum defines the locations of the cameras relative to the vehicle body frame on the automotive sensor coordinate system. If the system has FEATURE_AUTOMOTIVE, the camera will have this entry in its static metadata.

  • INTERIOR is the inside of the vehicle body frame (or the passenger cabin).
  • EXTERIOR is the outside of the vehicle body frame.
  • EXTRA is the extra vehicle such as a trailer.

Each side of the vehicle body frame on this coordinate system is defined as below:

  • FRONT is where the Y-axis increases toward.
  • REAR is where the Y-axis decreases toward.
  • LEFT is where the X-axis decreases toward.
  • RIGHT is where the X-axis increases toward.

If the camera has either EXTERIOR_OTHER or EXTRA_OTHER, its static metadata will list the following entries, so that applications can determine the camera's exact location:

Possible values:

Optional - The value for this key may be null on some devices.

COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES

Added in API level 21
static val COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES: CameraCharacteristics.Key<IntArray!>

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.

CONTROL_AE_AVAILABLE_ANTIBANDING_MODES

Added in API level 21
static val CONTROL_AE_AVAILABLE_ANTIBANDING_MODES: CameraCharacteristics.Key<IntArray!>

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.

CONTROL_AE_AVAILABLE_MODES

Added in API level 21
static val CONTROL_AE_AVAILABLE_MODES: CameraCharacteristics.Key<IntArray!>

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.

CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES

Added in API level 21
static val CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES: CameraCharacteristics.Key<Array<Range<Int!>!>!>

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 devices that advertise NIR color filter arrangement in android.sensor.info.colorFilterArrangement, this list will always include (max, max) where max = the maximum output frame rate of the maximum YUV_420_888 output size.
  • For devices advertising any color filter arrangement other than NIR, or devices not advertising color filter arrangement, 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.

CONTROL_AE_COMPENSATION_RANGE

Added in API level 21
static val CONTROL_AE_COMPENSATION_RANGE: CameraCharacteristics.Key<Range<Int!>!>

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.

CONTROL_AE_COMPENSATION_STEP

Added in API level 21
static val CONTROL_AE_COMPENSATION_STEP: CameraCharacteristics.Key<Rational!>

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.

CONTROL_AE_LOCK_AVAILABLE

Added in API level 23
static val CONTROL_AE_LOCK_AVAILABLE: CameraCharacteristics.Key<Boolean!>

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.

CONTROL_AF_AVAILABLE_MODES

Added in API level 21
static val CONTROL_AF_AVAILABLE_MODES: CameraCharacteristics.Key<IntArray!>

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.

CONTROL_AUTOFRAMING_AVAILABLE

Added in API level 34
static val CONTROL_AUTOFRAMING_AVAILABLE: CameraCharacteristics.Key<Boolean!>

Whether the camera device supports android.control.autoframing.

Will be false if auto-framing is not available.

Optional - The value for this key 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

CONTROL_AVAILABLE_EFFECTS

Added in API level 21
static val CONTROL_AVAILABLE_EFFECTS: CameraCharacteristics.Key<IntArray!>

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.

CONTROL_AVAILABLE_EXTENDED_SCENE_MODE_CAPABILITIES

Added in API level 30
static val CONTROL_AVAILABLE_EXTENDED_SCENE_MODE_CAPABILITIES: CameraCharacteristics.Key<Array<Capability!>!>

The list of extended scene modes for android.control.extendedSceneMode that are supported by this camera device, and each extended scene mode's capabilities such as maximum streaming size, and supported zoom ratio ranges.

For DISABLED mode, the camera behaves normally with no extended scene mode enabled.

For BOKEH_STILL_CAPTURE mode, the maximum streaming dimension specifies the limit under which bokeh is effective when capture intent is PREVIEW. Note that when capture intent is PREVIEW, the bokeh effect may not be as high quality compared to STILL_CAPTURE intent in order to maintain reasonable frame rate. The maximum streaming dimension must be one of the YUV_420_888 or PRIVATE resolutions in availableStreamConfigurations, or (0, 0) if preview bokeh is not supported. If the application configures a stream larger than the maximum streaming dimension, bokeh effect may not be applied for this stream for PREVIEW intent.

For BOKEH_CONTINUOUS mode, the maximum streaming dimension specifies the limit under which bokeh is effective. This dimension must be one of the YUV_420_888 or PRIVATE resolutions in availableStreamConfigurations, and if the sensor maximum resolution is larger than or equal to 1080p, the maximum streaming dimension must be at least 1080p. If the application configures a stream with larger dimension, the stream may not have bokeh effect applied.

When extended scene mode is set, the camera device may have limited range of zoom ratios compared to when the mode is DISABLED. availableExtendedSceneModeCapabilities lists the zoom ranges for all supported extended modes. A range of (1.0, 1.0) means that no zoom (optical or digital) is supported.

Optional - The value for this key may be null on some devices.

CONTROL_AVAILABLE_MODES

Added in API level 23
static val CONTROL_AVAILABLE_MODES: CameraCharacteristics.Key<IntArray!>

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.

CONTROL_AVAILABLE_SCENE_MODES

Added in API level 21
static val CONTROL_AVAILABLE_SCENE_MODES: CameraCharacteristics.Key<IntArray!>

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.

CONTROL_AVAILABLE_SETTINGS_OVERRIDES

Added in API level 34
static val CONTROL_AVAILABLE_SETTINGS_OVERRIDES: CameraCharacteristics.Key<IntArray!>

List of available settings overrides supported by the camera device that can be used to speed up certain controls.

When not all controls within a CaptureRequest are required to take effect at the same time on the outputs, the camera device may apply certain request keys sooner to improve latency. This list contains such supported settings overrides. Each settings override corresponds to a set of CaptureRequest keys that can be sped up when applying.

A supported settings override can be passed in via android.hardware.camera2.CaptureRequest#CONTROL_SETTINGS_OVERRIDE, and the CaptureRequest keys corresponding to the override are applied as soon as possible, not bound by per-frame synchronization. See android.control.settingsOverride for the CaptureRequest keys for each override.

OFF is always included in this list.

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

Optional - The value for this key may be null on some devices.

CONTROL_AVAILABLE_VIDEO_STABILIZATION_MODES

Added in API level 21
static val CONTROL_AVAILABLE_VIDEO_STABILIZATION_MODES: CameraCharacteristics.Key<IntArray!>

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.

CONTROL_AWB_AVAILABLE_MODES

Added in API level 21
static val CONTROL_AWB_AVAILABLE_MODES: CameraCharacteristics.Key<IntArray!>

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.

CONTROL_AWB_LOCK_AVAILABLE

Added in API level 23
static val CONTROL_AWB_LOCK_AVAILABLE: CameraCharacteristics.Key<Boolean!>

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.

CONTROL_LOW_LIGHT_BOOST_INFO_LUMINANCE_RANGE

static val CONTROL_LOW_LIGHT_BOOST_INFO_LUMINANCE_RANGE: CameraCharacteristics.Key<Range<Float!>!>

The operating luminance range of low light boost measured in lux (lx).

Range of valid values:

The lower bound indicates the lowest scene luminance value the AE mode 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY' can operate within. Scenes of lower luminance than this may receive less brightening, increased noise, or artifacts.

The upper bound indicates the luminance threshold at the point when the mode is enabled. For example, 'Range[0.3, 30.0]' defines 0.3 lux being the lowest scene luminance the mode can reliably support. 30.0 lux represents the threshold when this mode is activated. Scenes measured at less than or equal to 30 lux will activate low light boost.

If this key is defined, then the AE mode 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY' will also be present.

Optional - The value for this key may be null on some devices.

CONTROL_MAX_REGIONS_AE

Added in API level 21
static val CONTROL_MAX_REGIONS_AE: CameraCharacteristics.Key<Int!>

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

This corresponds to 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.

CONTROL_MAX_REGIONS_AF

Added in API level 21
static val CONTROL_MAX_REGIONS_AF: CameraCharacteristics.Key<Int!>

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

This corresponds to 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.

CONTROL_MAX_REGIONS_AWB

Added in API level 21
static val CONTROL_MAX_REGIONS_AWB: CameraCharacteristics.Key<Int!>

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

This corresponds to 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.

CONTROL_POST_RAW_SENSITIVITY_BOOST_RANGE

Added in API level 24
static val CONTROL_POST_RAW_SENSITIVITY_BOOST_RANGE: CameraCharacteristics.Key<Range<Int!>!>

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 controlling 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 - The value for this key may be null on some devices.

CONTROL_ZOOM_RATIO_RANGE

Added in API level 30
static val CONTROL_ZOOM_RATIO_RANGE: CameraCharacteristics.Key<Range<Float!>!>

Minimum and maximum zoom ratios supported by this camera device.

If the camera device supports zoom-out from 1x zoom, minZoom will be less than 1.0, and setting android.control.zoomRatio to values less than 1.0 increases the camera's field of view.

Units: A pair of zoom ratio in floating-points: (minZoom, maxZoom)

Range of valid values:

maxZoom >= 1.0 >= minZoom

Optional - The value for this key 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

DEPTH_DEPTH_IS_EXCLUSIVE

Added in API level 23
static val DEPTH_DEPTH_IS_EXCLUSIVE: CameraCharacteristics.Key<Boolean!>

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 - The value for this key 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

DISTORTION_CORRECTION_AVAILABLE_MODES

Added in API level 28
static val DISTORTION_CORRECTION_AVAILABLE_MODES: CameraCharacteristics.Key<IntArray!>

List of distortion correction modes for android.distortionCorrection.mode that are supported by this camera device.

No device is required to support this API; such devices will always list only 'OFF'. All devices that support this API will list both FAST and HIGH_QUALITY.

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

Optional - The value for this key may be null on some devices.

EDGE_AVAILABLE_EDGE_MODES

Added in API level 21
static val EDGE_AVAILABLE_EDGE_MODES: CameraCharacteristics.Key<IntArray!>

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 - The value for this key 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

FLASH_INFO_AVAILABLE

Added in API level 21
static val FLASH_INFO_AVAILABLE: CameraCharacteristics.Key<Boolean!>

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.

FLASH_INFO_STRENGTH_DEFAULT_LEVEL

Added in API level 33
static val FLASH_INFO_STRENGTH_DEFAULT_LEVEL: CameraCharacteristics.Key<Int!>

Default flashlight brightness level to be set via android.hardware.camera2.CameraManager#turnOnTorchWithStrengthLevel.

If flash unit is available this will be greater than or equal to 1 and less or equal to android.flash.info.strengthMaximumLevel.

Setting flashlight brightness above the default level (i.e.android.flash.info.strengthDefaultLevel) may make the device more likely to reach thermal throttling conditions and slow down, or drain the battery quicker than normal. To minimize such issues, it is recommended to start the flashlight at this default brightness until a user explicitly requests a brighter level. Note that the value for this key will be null for devices with no flash unit. The default level should always be > 0.

Optional - The value for this key may be null on some devices.

FLASH_INFO_STRENGTH_MAXIMUM_LEVEL

Added in API level 33
static val FLASH_INFO_STRENGTH_MAXIMUM_LEVEL: CameraCharacteristics.Key<Int!>

Maximum flashlight brightness level.

If this value is greater than 1, then the device supports controlling the flashlight brightness level via android.hardware.camera2.CameraManager#turnOnTorchWithStrengthLevel. If this value is equal to 1, flashlight brightness control is not supported. The value for this key will be null for devices with no flash unit.

The maximum value is guaranteed to be safe to use for an indefinite duration in terms of device flashlight lifespan, but may be too bright for comfort for many use cases. Use the default torch brightness value to avoid problems with an over-bright flashlight.

Optional - The value for this key may be null on some devices.

FLASH_SINGLE_STRENGTH_DEFAULT_LEVEL

static val FLASH_SINGLE_STRENGTH_DEFAULT_LEVEL: CameraCharacteristics.Key<Int!>

Default flash brightness level for manual flash control in SINGLE mode.

If flash unit is available this will be greater than or equal to 1 and less or equal to android.flash.info.singleStrengthMaxLevel. Note for devices that do not support the manual flash strength control feature, this level will always be equal to 1.

This key is available on all devices.

FLASH_SINGLE_STRENGTH_MAX_LEVEL

static val FLASH_SINGLE_STRENGTH_MAX_LEVEL: CameraCharacteristics.Key<Int!>

Maximum flash brightness level for manual flash control in SINGLE mode.

Maximum flash brightness level in camera capture mode and android.flash.mode set to SINGLE. Value will be > 1 if the manual flash strength control feature is supported, otherwise the value will be equal to 1. Note that this level is just a number of supported levels (the granularity of control). There is no actual physical power units tied to this level.

This key is available on all devices.

FLASH_TORCH_STRENGTH_DEFAULT_LEVEL

static val FLASH_TORCH_STRENGTH_DEFAULT_LEVEL: CameraCharacteristics.Key<Int!>

Default flash brightness level for manual flash control in TORCH mode

If flash unit is available this will be greater than or equal to 1 and less or equal to android.flash.info.torchStrengthMaxLevel. Note for the devices that do not support the manual flash strength control feature, this level will always be equal to 1.

This key is available on all devices.

FLASH_TORCH_STRENGTH_MAX_LEVEL

static val FLASH_TORCH_STRENGTH_MAX_LEVEL: CameraCharacteristics.Key<Int!>

Maximum flash brightness level for manual flash control in TORCH mode

Maximum flash brightness level in camera capture mode and android.flash.mode set to TORCH. Value will be > 1 if the manual flash strength control feature is supported, otherwise the value will be equal to 1.

Note that this level is just a number of supported levels(the granularity of control). There is no actual physical power units tied to this level. There is no relation between android.flash.info.torchStrengthMaxLevel and android.flash.info.singleStrengthMaxLevel i.e. the ratio of android.flash.info.torchStrengthMaxLevel:android.flash.info.singleStrengthMaxLevel is not guaranteed to be the ratio of actual brightness.

This key is available on all devices.

HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES

Added in API level 21
static val HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES: CameraCharacteristics.Key<IntArray!>

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 - The value for this key may be null on some devices.

INFO_DEVICE_STATE_SENSOR_ORIENTATION_MAP

Added in API level 32
static val INFO_DEVICE_STATE_SENSOR_ORIENTATION_MAP: CameraCharacteristics.Key<DeviceStateSensorOrientationMap!>

This lists the mapping between a device folding state and specific camera sensor orientation for logical cameras on a foldable device.

Logical cameras on foldable devices can support sensors with different orientation values. The orientation value may need to change depending on the specific folding state. Information about the mapping between the device folding state and the sensor orientation can be obtained in android.hardware.camera2.params.DeviceStateSensorOrientationMap. Device state orientation maps are optional and maybe present on devices that support android.scaler.rotateAndCrop.

Optional - The value for this key 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

INFO_SESSION_CONFIGURATION_QUERY_VERSION

static val INFO_SESSION_CONFIGURATION_QUERY_VERSION: CameraCharacteristics.Key<Int!>

The version of the session configuration query android.hardware.camera2.CameraManager#isSessionConfigurationWithParametersSupported API

The possible values in this key correspond to the values defined in android.os.Build.VERSION_CODES. Each version defines a set of feature combinations the camera device must reliably report whether they are supported via android.hardware.camera2.CameraManager#isSessionConfigurationWithParametersSupported API. And the version is always less or equal to android.os.Build.VERSION.SDK_INT.

If set to UPSIDE_DOWN_CAKE, this camera device doesn't support android.hardware.camera2.CameraManager#isSessionConfigurationWithParametersSupported. Calling the method for this camera ID throws an UnsupportedOperationException.

If set to VANILLA_ICE_CREAM, the application can call android.hardware.camera2.CameraManager#isSessionConfigurationWithParametersSupported to check if the combinations of below features are supported.

  • A subset of LIMITED-level device stream combinations.
Target 1 Size Target 2 Size Sample use case(s)
PRIV MAXIMUM Simple preview, GPU video processing, or no-preview video recording.
PRIV PREVIEW
PRIV S1440P
PRIV S1080P
PRIV S720P
YUV MAXIMUM In-application video/image processing.
YUV PREVIEW
YUV S1440P
YUV S1080P
YUV S720P
PRIV PREVIEW JPEG MAXIMUM Standard still imaging.
PRIV S1440P JPEG MAXIMUM
PRIV S1080P JPEG MAXIMUM
PRIV S720P JPEG MAXIMUM
PRIV S1440P JPEG S1440P
PRIV S1080P JPEG S1080P
PRIV S720P JPEG S1080P
YUV PREVIEW JPEG MAXIMUM In-app processing plus still capture.
YUV S1440P JPEG MAXIMUM
YUV S1080P JPEG MAXIMUM
YUV S720P JPEG MAXIMUM
YUV S1440P JPEG S1440P
YUV S1080P JPEG S1080P
YUV S720P JPEG S1080P
PRIV PREVIEW PRIV PREVIEW Standard recording.
PRIV S1440P PRIV S1440P
PRIV S1080P PRIV S1080P
PRIV S720P PRIV S720P
PRIV PREVIEW YUV PREVIEW Preview plus in-app processing.
PRIV S1440P YUV S1440P
PRIV S1080P YUV S1080P
PRIV S720P YUV S720P
<code>- <code>MAXIMUM</code> size refers to the camera device's maximum output resolution for
    that format from <code>StreamConfigurationMap#getOutputSizes</code>. <code>PREVIEW</code> size
    refers to the best size match to the device's screen resolution, or to 1080p
    (@code 1920x1080}, whichever is smaller. Both sizes are guaranteed to be supported.
 
  - <code>S1440P</code> refers to <code>1920x1440 (4:3)</code> and <code>2560x1440 (16:9)</code>.
    <code>S1080P</code> refers to <code>1440x1080 (4:3)</code> and <code>1920x1080 (16:9)</code>.
    And <code>S720P</code> refers to <code>960x720 (4:3)</code> and <code>1280x720 (16:9)</code>.
 
  - If a combination contains a S1440P, S1080P, or S720P stream,
    both 4:3 and 16:9 aspect ratio sizes can be queried. For example, for the
    stream combination of {PRIV, S1440P, JPEG, MAXIMUM}, and if MAXIMUM ==
    4032 x 3024, the application will be able to query both
    {PRIV, 1920 x 1440, JPEG, 4032 x 3024} and {PRIV, 2560 x 1440, JPEG, 4032 x 2268}
    without an exception being thrown.
  </code>
  • VIDEO_STABILIZATION_MODES: {OFF, PREVIEW}
  • AE_TARGET_FPS_RANGE: { {, 30}, {, 60} }
  • DYNAMIC_RANGE_PROFILE: {STANDARD, HLG10}

This key is available on all devices.

INFO_SUPPORTED_HARDWARE_LEVEL

Added in API level 21
static val INFO_SUPPORTED_HARDWARE_LEVEL: CameraCharacteristics.Key<Int!>

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:

<code>// Returns true if the device supports the required hardware level, or better.
  boolean isHardwareLevelSupported(CameraCharacteristics c, int requiredLevel) {
      final int[] sortedHwLevels = {
          CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY,
          CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_EXTERNAL,
          CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED,
          CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_FULL,
          CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_3
      };
      int deviceLevel = c.get(CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL);
      if (requiredLevel == deviceLevel) {
          return true;
      }
 
      for (int sortedlevel : sortedHwLevels) {
          if (sortedlevel == requiredLevel) {
              return true;
          } else if (sortedlevel == deviceLevel) {
              return false;
          }
      }
      return false; // Should never reach here
  }
  </code>

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.
  • EXTERNAL devices are similar to LIMITED devices with exceptions like some sensor or lens information not reported or less stable framerates.

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 entries from android.hardware.camera2.CameraCharacteristics.

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.

INFO_VERSION

Added in API level 28
static val INFO_VERSION: CameraCharacteristics.Key<String!>

A short string for manufacturer version information about the camera device, such as ISP hardware, sensors, etc.

This can be used in TAG_IMAGE_DESCRIPTION in jpeg EXIF. This key may be absent if no version information is available on the device.

Optional - The value for this key may be null on some devices.

JPEG_AVAILABLE_THUMBNAIL_SIZES

Added in API level 21
static val JPEG_AVAILABLE_THUMBNAIL_SIZES: CameraCharacteristics.Key<Array<Size!>!>

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 conditions 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 list is also used as supported thumbnail sizes for HEIC image format capture.

This key is available on all devices.

LENS_DISTORTION

Added in API level 28
static val LENS_DISTORTION: CameraCharacteristics.Key<FloatArray!>

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

Replaces the deprecated android.lens.radialDistortion field, which was inconsistently defined.

Three radial distortion coefficients [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:

<code> x_c = x_i * ( 1 + 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 * ( 1 + 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 )
  </code>

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

<code> correctedImage(x_i, y_i) = sample_at(x_c, y_c, inputImage)
  </code>

The pixel coordinates are defined in a coordinate system related to the android.lens.intrinsicCalibration calibration fields; see that entry for details of the mapping stages. Both [x_i, y_i] and [x_c, y_c] have (0,0) at the lens optical center [c_x, c_y], and the range of the coordinates depends on the focal length terms of the intrinsic calibration.

Finally, r represents the radial distance from the optical center, r^2 = x_i^2 + y_i^2.

The distortion model used is the Brown-Conrady model.

Units: Unitless coefficients.

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

LENS_DISTORTION_MAXIMUM_RESOLUTION

Added in API level 31
static val LENS_DISTORTION_MAXIMUM_RESOLUTION: CameraCharacteristics.Key<FloatArray!>

The correction coefficients to correct for this camera device's radial and tangential lens distortion for a CaptureRequest with android.sensor.pixelMode set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION.

Analogous to android.lens.distortion, when android.sensor.pixelMode is set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION.

Units: Unitless coefficients.

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

LENS_FACING

Added in API level 21
static val LENS_FACING: CameraCharacteristics.Key<Int!>

Direction the camera faces relative to device screen.

Possible values:

This key is available on all devices.

LENS_INFO_AVAILABLE_APERTURES

Added in API level 21
static val LENS_INFO_AVAILABLE_APERTURES: CameraCharacteristics.Key<FloatArray!>

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 - The value for this key 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

LENS_INFO_AVAILABLE_FILTER_DENSITIES

Added in API level 21
static val LENS_INFO_AVAILABLE_FILTER_DENSITIES: CameraCharacteristics.Key<FloatArray!>

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 - The value for this key 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

LENS_INFO_AVAILABLE_FOCAL_LENGTHS

Added in API level 21
static val LENS_INFO_AVAILABLE_FOCAL_LENGTHS: CameraCharacteristics.Key<FloatArray!>

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.

LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION

Added in API level 21
static val LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION: CameraCharacteristics.Key<IntArray!>

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 - The value for this key 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

LENS_INFO_FOCUS_DISTANCE_CALIBRATION

Added in API level 21
static val LENS_INFO_FOCUS_DISTANCE_CALIBRATION: CameraCharacteristics.Key<Int!>

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 - The value for this key 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

LENS_INFO_HYPERFOCAL_DISTANCE

Added in API level 21
static val LENS_INFO_HYPERFOCAL_DISTANCE: CameraCharacteristics.Key<Float!>

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 - The value for this key 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

Permission android.Manifest.permission#CAMERA is needed to access this property

LENS_INFO_MINIMUM_FOCUS_DISTANCE

Added in API level 21
static val LENS_INFO_MINIMUM_FOCUS_DISTANCE: CameraCharacteristics.Key<Float!>

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 - The value for this key 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

Permission android.Manifest.permission#CAMERA is needed to access this property

LENS_INTRINSIC_CALIBRATION

Added in API level 23
static val LENS_INTRINSIC_CALIBRATION: CameraCharacteristics.Key<FloatArray!>

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:

<code>[f_x, f_y, c_x, c_y, s]
  </code>

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:

<code>K = [ f_x,   s, c_x,
         0, f_y, c_y,
         0    0,   1 ]
  </code>

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

<code>P = [ K 0   * [ R -Rt
       0 1 ]      0 1 ]
  </code>

(Note the negation of poseTranslation when mapping from camera to world coordinates, and multiplication by the rotation).

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:

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

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

For camera devices, the center of pixel (x,y) is located at coordinate (x + 0.5, y + 0.5). So on a device with a precorrection active array of size (10,10), the valid pixel indices go from (0,0)-(9,9), and an perfectly-built camera would have an optical center at the exact center of the pixel grid, at coordinates (5.0, 5.0), which is the top-left corner of pixel (5,5).

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

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

LENS_POSE_REFERENCE

Added in API level 28
static val LENS_POSE_REFERENCE: CameraCharacteristics.Key<Int!>

The origin for android.lens.poseTranslation, and the accuracy of android.lens.poseTranslation and android.lens.poseRotation.

Different calibration methods and use cases can produce better or worse results depending on the selected coordinate origin.

Possible values:

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

LENS_POSE_ROTATION

Added in API level 23
static val LENS_POSE_ROTATION: CameraCharacteristics.Key<FloatArray!>

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:

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

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

<code>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 ]
  </code>

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.

If android.lens.poseReference is UNDEFINED, the quaternion rotation cannot be accurately represented by the camera device, and will be represented by default values matching its default facing.

Units: Quaternion coefficients

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

LENS_POSE_TRANSLATION

Added in API level 23
static val LENS_POSE_TRANSLATION: CameraCharacteristics.Key<FloatArray!>

Position of the camera optical center.

The position of the camera device's lens optical center, as a three-dimensional vector (x,y,z).

Prior to Android P, or when android.lens.poseReference is PRIMARY_CAMERA, this position is relative to the optical center of the largest camera device facing in the same direction as this camera, in the Android sensor. 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). Note that this means that, for many computer vision applications, the position needs to be negated to convert it to a translation from the camera to the origin.

To transform a pixel coordinates between two cameras facing the same direction, first the source camera android.lens.distortion 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.

When android.lens.poseReference is GYROSCOPE, then this position is relative to the center of the primary gyroscope on the device. The axis definitions are the same as with PRIMARY_CAMERA.

When android.lens.poseReference is UNDEFINED, this position cannot be accurately represented by the camera device, and will be represented as (0, 0, 0).

When android.lens.poseReference is AUTOMOTIVE, then this position is relative to the origin of the automotive sensor coordinate system, which is at the center of the rear axle.

Units: Meters

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

LENS_RADIAL_DISTORTION

Added in API level 23
Deprecated in API level 28
static val LENS_RADIAL_DISTORTION: CameraCharacteristics.Key<FloatArray!>

Deprecated:

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

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:

<code> 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 )
  </code>

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

<code> correctedImage(x_i, y_i) = sample_at(x_c, y_c, inputImage)
  </code>

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 - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

LOGICAL_MULTI_CAMERA_SENSOR_SYNC_TYPE

Added in API level 28
static val LOGICAL_MULTI_CAMERA_SENSOR_SYNC_TYPE: CameraCharacteristics.Key<Int!>

The accuracy of frame timestamp synchronization between physical cameras

The accuracy of the frame timestamp synchronization determines the physical cameras' ability to start exposure at the same time. If the sensorSyncType is CALIBRATED, the physical camera sensors usually run in leader/follower mode where one sensor generates a timing signal for the other, so that their shutter time is synchronized. For APPROXIMATE sensorSyncType, the camera sensors usually run in leader/leader mode, where both sensors use their own timing generator, and there could be offset between their start of exposure.

In both cases, all images generated for a particular capture request still carry the same timestamps, so that they can be used to look up the matching frame number and onCaptureStarted callback.

This tag is only applicable if the logical camera device supports concurrent physical streams from different physical cameras.

Possible values:

Optional - The value for this key 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

NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES

Added in API level 21
static val NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES: CameraCharacteristics.Key<IntArray!>

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 - The value for this key 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

REPROCESS_MAX_CAPTURE_STALL

Added in API level 23
static val REPROCESS_MAX_CAPTURE_STALL: CameraCharacteristics.Key<Int!>

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 - The value for this key 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

REQUEST_AVAILABLE_CAPABILITIES

Added in API level 21
static val REQUEST_AVAILABLE_CAPABILITIES: CameraCharacteristics.Key<IntArray!>

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_AVAILABLE_COLOR_SPACE_PROFILES

Added in API level 34
static val REQUEST_AVAILABLE_COLOR_SPACE_PROFILES: CameraCharacteristics.Key<ColorSpaceProfiles!>

An interface for querying the color space profiles supported by a camera device.

A color space profile is a combination of a color space, an image format, and a dynamic range profile. Camera clients can retrieve the list of supported color spaces by calling android.hardware.camera2.params.ColorSpaceProfiles#getSupportedColorSpaces or android.hardware.camera2.params.ColorSpaceProfiles#getSupportedColorSpacesForDynamicRange. If a camera does not support the android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT capability, the dynamic range profile will always be android.hardware.camera2.params.DynamicRangeProfiles#STANDARD. Color space capabilities are queried in combination with an android.graphics.ImageFormat. If a camera client wants to know the general color space capabilities of a camera device regardless of image format, it can specify android.graphics.ImageFormat#UNKNOWN. The color space for a session can be configured by setting the SessionConfiguration color space via android.hardware.camera2.params.SessionConfiguration#setColorSpace.

Optional - The value for this key may be null on some devices.

REQUEST_AVAILABLE_DYNAMIC_RANGE_PROFILES

Added in API level 33
static val REQUEST_AVAILABLE_DYNAMIC_RANGE_PROFILES: CameraCharacteristics.Key<DynamicRangeProfiles!>

Devices supporting the 10-bit output capability android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT must list their supported dynamic range profiles along with capture request constraints for specific profile combinations.

Camera clients can retrieve the list of supported 10-bit dynamic range profiles by calling android.hardware.camera2.params.DynamicRangeProfiles#getSupportedProfiles. Any of them can be configured by setting OutputConfiguration dynamic range profile in android.hardware.camera2.params.OutputConfiguration#setDynamicRangeProfile. Clients can also check if there are any constraints that limit the combination of supported profiles that can be referenced within a single capture request by calling android.hardware.camera2.params.DynamicRangeProfiles#getProfileCaptureRequestConstraints.

Optional - The value for this key may be null on some devices.

REQUEST_MAX_NUM_INPUT_STREAMS

Added in API level 23
static val REQUEST_MAX_NUM_INPUT_STREAMS: CameraCharacteristics.Key<Int!>

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 android.hardware.camera2.params.StreamConfigurationMap#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 - The value for this key 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

REQUEST_MAX_NUM_OUTPUT_PROC

Added in API level 21
static val REQUEST_MAX_NUM_OUTPUT_PROC: CameraCharacteristics.Key<Int!>

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 android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration 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.

REQUEST_MAX_NUM_OUTPUT_PROC_STALLING

Added in API level 21
static val REQUEST_MAX_NUM_OUTPUT_PROC_STALLING: CameraCharacteristics.Key<Int!>

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 android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration 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.

REQUEST_MAX_NUM_OUTPUT_RAW

Added in API level 21
static val REQUEST_MAX_NUM_OUTPUT_RAW: CameraCharacteristics.Key<Int!>

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.

REQUEST_PARTIAL_RESULT_COUNT

Added in API level 21
static val REQUEST_PARTIAL_RESULT_COUNT: CameraCharacteristics.Key<Int!>

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 - The value for this key may be null on some devices.

REQUEST_PIPELINE_MAX_DEPTH

Added in API level 21
static val REQUEST_PIPELINE_MAX_DEPTH: CameraCharacteristics.Key<Byte!>

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.

Added in API level 33
static val REQUEST_RECOMMENDED_TEN_BIT_DYNAMIC_RANGE_PROFILE: CameraCharacteristics.Key<Long!>

Recommended 10-bit dynamic range profile.

Devices supporting the 10-bit output capability android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT must list a 10-bit supported dynamic range profile that is expected to perform optimally in terms of image quality, power and performance. The value advertised can be used as a hint by camera clients when configuring the dynamic range profile when calling android.hardware.camera2.params.OutputConfiguration#setDynamicRangeProfile.

Optional - The value for this key may be null on some devices.

SCALER_AVAILABLE_MAX_DIGITAL_ZOOM

Added in API level 21
static val SCALER_AVAILABLE_MAX_DIGITAL_ZOOM: CameraCharacteristics.Key<Float!>

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.

Starting from API level 30, when using android.control.zoomRatio to zoom in or out, the application must use android.control.zoomRatioRange to query both the minimum and maximum zoom ratio.

Units: Zoom scale factor

Range of valid values:
>=1

This key is available on all devices.

SCALER_AVAILABLE_ROTATE_AND_CROP_MODES

Added in API level 31
static val SCALER_AVAILABLE_ROTATE_AND_CROP_MODES: CameraCharacteristics.Key<IntArray!>

List of rotate-and-crop modes for android.scaler.rotateAndCrop that are supported by this camera device.

This entry lists the valid modes for android.scaler.rotateAndCrop for this camera device.

Starting with API level 30, all devices will list at least ROTATE_AND_CROP_NONE. Devices with support for rotate-and-crop will additionally list at least ROTATE_AND_CROP_AUTO and ROTATE_AND_CROP_90.

Range of valid values:
Any value listed in android.scaler.rotateAndCrop

Optional - The value for this key may be null on some devices.

SCALER_AVAILABLE_STREAM_USE_CASES

Added in API level 33
static val SCALER_AVAILABLE_STREAM_USE_CASES: CameraCharacteristics.Key<LongArray!>

The stream use cases supported by this camera device.

The stream use case indicates the purpose of a particular camera stream from the end-user perspective. Some examples of camera use cases are: preview stream for live viewfinder shown to the user, still capture for generating high quality photo capture, video record for encoding the camera output for the purpose of future playback, and video call for live realtime video conferencing.

With this flag, the camera device can optimize the image processing pipeline parameters, such as tuning, sensor mode, and ISP settings, independent of the properties of the immediate camera output surface. For example, if the output surface is a SurfaceTexture, the stream use case flag can be used to indicate whether the camera frames eventually go to display, video encoder, still image capture, or all of them combined.

The application sets the use case of a camera stream by calling android.hardware.camera2.params.OutputConfiguration#setStreamUseCase.

A camera device with android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE capability must support the following stream use cases:

  • DEFAULT
  • PREVIEW
  • STILL_CAPTURE
  • VIDEO_RECORD
  • PREVIEW_VIDEO_STILL
  • VIDEO_CALL

The guaranteed stream combinations related to stream use case for a camera device with android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE capability is documented in the camera device guideline. The application is strongly recommended to use one of the guaranteed stream combinations. If the application creates a session with a stream combination not in the guaranteed list, or with mixed DEFAULT and non-DEFAULT use cases within the same session, the camera device may ignore some stream use cases due to hardware constraints and implementation details.

For stream combinations not covered by the stream use case mandatory lists, such as reprocessable session, constrained high speed session, or RAW stream combinations, the application should leave stream use cases within the session as DEFAULT.

Possible values:

Optional - The value for this key may be null on some devices.

SCALER_CROPPING_TYPE

Added in API level 21
static val SCALER_CROPPING_TYPE: CameraCharacteristics.Key<Int!>

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.

Starting from API level 30,

LEGACY capability devices will only support CENTER_ONLY cropping.

Possible values:

This key is available on all devices.

SCALER_DEFAULT_SECURE_IMAGE_SIZE

Added in API level 31
static val SCALER_DEFAULT_SECURE_IMAGE_SIZE: CameraCharacteristics.Key<Size!>

Default YUV/PRIVATE size to use for requesting secure image buffers.

This entry lists the default size supported in the secure camera mode. This entry is optional on devices support the SECURE_IMAGE_DATA capability. This entry will be null if the camera device does not list SECURE_IMAGE_DATA capability.

When the key is present, only a PRIVATE/YUV output of the specified size is guaranteed to be supported by the camera HAL in the secure camera mode. Any other format or resolutions might not be supported. Use CameraManager#isSessionConfigurationWithParametersSupported API to query if a secure session configuration is supported if the device supports this API.

If this key returns null on a device with SECURE_IMAGE_DATA capability, the application can assume all output sizes listed in the android.hardware.camera2.params.StreamConfigurationMap are supported.

Units: Pixels

Optional - The value for this key may be null on some devices.

SCALER_MANDATORY_CONCURRENT_STREAM_COMBINATIONS

Added in API level 30
static val SCALER_MANDATORY_CONCURRENT_STREAM_COMBINATIONS: CameraCharacteristics.Key<Array<MandatoryStreamCombination!>!>

An array of mandatory concurrent stream combinations. This is an app-readable conversion of the concurrent mandatory stream combination tables.

The array of combinations is generated according to the documented guideline for each device which has its Id present in the set returned by android.hardware.camera2.CameraManager#getConcurrentCameraIds. Clients can use the array as a quick reference to find an appropriate camera stream combination. The mandatory stream combination array will be null in case the device is not a part of at least one set of combinations returned by android.hardware.camera2.CameraManager#getConcurrentCameraIds.

Optional - The value for this key may be null on some devices.

SCALER_MANDATORY_MAXIMUM_RESOLUTION_STREAM_COMBINATIONS

Added in API level 31
static val SCALER_MANDATORY_MAXIMUM_RESOLUTION_STREAM_COMBINATIONS: CameraCharacteristics.Key<Array<MandatoryStreamCombination!>!>

An array of mandatory stream combinations which are applicable when android.hardware.camera2.CaptureRequest has android.sensor.pixelMode set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION. This is an app-readable conversion of the maximum resolution mandatory stream combination tables.

The array of combinations is generated according to the documented guideline for each device which has the android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR capability. Clients can use the array as a quick reference to find an appropriate camera stream combination. The mandatory stream combination array will be null in case the device is not an android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR device.

Optional - The value for this key may be null on some devices.

SCALER_MANDATORY_PREVIEW_STABILIZATION_OUTPUT_STREAM_COMBINATIONS

Added in API level 33
static val SCALER_MANDATORY_PREVIEW_STABILIZATION_OUTPUT_STREAM_COMBINATIONS: CameraCharacteristics.Key<Array<MandatoryStreamCombination!>!>

An array of mandatory stream combinations which are applicable when device lists PREVIEW_STABILIZATION in android.control.availableVideoStabilizationModes. This is an app-readable conversion of the preview stabilization mandatory stream combination tables.

The array of combinations is generated according to the documented guideline for each device which supports PREVIEW_STABILIZATION Clients can use the array as a quick reference to find an appropriate camera stream combination. The mandatory stream combination array will be null in case the device does not list PREVIEW_STABILIZATION in android.control.availableVideoStabilizationModes.

Optional - The value for this key may be null on some devices.

SCALER_MANDATORY_STREAM_COMBINATIONS

Added in API level 29
static val SCALER_MANDATORY_STREAM_COMBINATIONS: CameraCharacteristics.Key<Array<MandatoryStreamCombination!>!>

An array of mandatory stream combinations generated according to the camera device android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL and android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES. This is an app-readable conversion of the mandatory stream combination tables.

The array of combinations is generated according to the documented guideline. based on specific device level and capabilities. Clients can use the array as a quick reference to find an appropriate camera stream combination. As per documentation, the stream combinations with given PREVIEW, RECORD and MAXIMUM resolutions and anything smaller from the list given by android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes are guaranteed to work. For a physical camera not independently exposed in android.hardware.camera2.CameraManager#getCameraIdList, the mandatory stream combinations for that physical camera Id are also generated, so that the application can configure them as physical streams via the logical camera. The mandatory stream combination array will be null in case the device is not backward compatible.

Optional - The value for this key 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

SCALER_MANDATORY_TEN_BIT_OUTPUT_STREAM_COMBINATIONS

Added in API level 33
static val SCALER_MANDATORY_TEN_BIT_OUTPUT_STREAM_COMBINATIONS: CameraCharacteristics.Key<Array<MandatoryStreamCombination!>!>

An array of mandatory stream combinations which are applicable when device support the 10-bit output capability android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT This is an app-readable conversion of the 10 bit output mandatory stream combination tables.

The array of combinations is generated according to the documented guideline for each device which has the android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT capability. Clients can use the array as a quick reference to find an appropriate camera stream combination. The mandatory stream combination array will be null in case the device is not an android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT device.

Optional - The value for this key may be null on some devices.

SCALER_MANDATORY_USE_CASE_STREAM_COMBINATIONS

Added in API level 33
static val SCALER_MANDATORY_USE_CASE_STREAM_COMBINATIONS: CameraCharacteristics.Key<Array<MandatoryStreamCombination!>!>

An array of mandatory stream combinations with stream use cases. This is an app-readable conversion of the mandatory stream combination tables with each stream's use case being set.

The array of combinations is generated according to the documented guildeline for a camera device with android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE capability. The mandatory stream combination array will be null in case the device doesn't have android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE capability.

Optional - The value for this key may be null on some devices.

SCALER_MULTI_RESOLUTION_STREAM_CONFIGURATION_MAP

Added in API level 31
static val SCALER_MULTI_RESOLUTION_STREAM_CONFIGURATION_MAP: CameraCharacteristics.Key<MultiResolutionStreamConfigurationMap!>

The multi-resolution stream configurations supported by this logical camera or ultra high resolution sensor camera device.

Multi-resolution streams can be used by a LOGICAL_MULTI_CAMERA or an ULTRA_HIGH_RESOLUTION_SENSOR camera where the images sent or received can vary in resolution per frame. This is useful in cases where the camera device's effective full resolution changes depending on factors such as the current zoom level, lighting condition, focus distance, or pixel mode.

  • For a logical multi-camera implementing optical zoom, at different zoom level, a different physical camera may be active, resulting in different full-resolution image sizes.
  • For an ultra high resolution camera, depending on whether the camera operates in default mode, or maximum resolution mode, the output full-size images may be of either binned resolution or maximum resolution.

To use multi-resolution output streams, the supported formats can be queried by android.hardware.camera2.params.MultiResolutionStreamConfigurationMap#getOutputFormats. A android.hardware.camera2.MultiResolutionImageReader can then be created for a supported format with the MultiResolutionStreamInfo group queried by android.hardware.camera2.params.MultiResolutionStreamConfigurationMap#getOutputInfo.

If a camera device supports multi-resolution output streams for a particular format, for each of its mandatory stream combinations, the camera device will support using a MultiResolutionImageReader for the MAXIMUM stream of supported formats. Refer to the table for additional details.

To use multi-resolution input streams, the supported formats can be queried by android.hardware.camera2.params.MultiResolutionStreamConfigurationMap#getInputFormats. A reprocessable CameraCaptureSession can then be created using an InputConfiguration constructed with the input MultiResolutionStreamInfo group, queried by android.hardware.camera2.params.MultiResolutionStreamConfigurationMap#getInputInfo.

If a camera device supports multi-resolution YUV input and multi-resolution YUV output, or multi-resolution PRIVATE input and multi-resolution PRIVATE output, JPEG and YUV are guaranteed to be supported multi-resolution output stream formats. Refer to the table for details about the additional mandatory stream combinations in this case.

Optional - The value for this key may be null on some devices.

SCALER_STREAM_CONFIGURATION_MAP

Added in API level 21
static val SCALER_STREAM_CONFIGURATION_MAP: CameraCharacteristics.Key<StreamConfigurationMap!>

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.

For applications targeting SDK version older than 31, the following table describes the minimum required output stream configurations based on the hardware level (android.info.supportedHardwareLevel):

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

For applications targeting SDK version 31 or newer, if the mobile device declares to be media performance class 12 or higher by setting android.os.Build.VERSION#MEDIA_PERFORMANCE_CLASS to be 31 or larger, the primary camera devices (first rear/front camera in the camera ID list) will not support JPEG sizes smaller than 1080p. If the application configures a JPEG stream smaller than 1080p, the camera device will round up the JPEG image size to at least 1080p. The requirements for IMPLEMENTATION_DEFINED and YUV_420_888 stay the same. This new minimum required output stream configurations are illustrated by the table below:

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

For applications targeting SDK version 31 or newer, if the mobile device doesn't declare to be media performance class 12 or better by setting android.os.Build.VERSION#MEDIA_PERFORMANCE_CLASS to be 31 or larger, or if the camera device isn't a primary rear/front camera, the minimum required output stream configurations are the same as for applications targeting SDK version older than 31.

Refer to android.request.availableCapabilities and the table 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.

Exception on 176x144 (QCIF) resolution: camera devices usually have a fixed capability on downscaling from larger resolution to smaller ones, and the QCIF resolution can sometimes not be fully supported due to this limitation on devices with high-resolution image sensors. Therefore, trying to configure a QCIF resolution stream together with any other stream larger than 1920x1080 resolution (either width or height) might not be supported, and capture session creation will fail if it is not.

This key is available on all devices.

SCALER_STREAM_CONFIGURATION_MAP_MAXIMUM_RESOLUTION

Added in API level 31
static val SCALER_STREAM_CONFIGURATION_MAP_MAXIMUM_RESOLUTION: CameraCharacteristics.Key<StreamConfigurationMap!>

The available stream configurations that this camera device supports when given a CaptureRequest with android.sensor.pixelMode set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION; also includes the minimum frame durations and the stall durations for each format/size combination.

Analogous to android.scaler.streamConfigurationMap for CaptureRequests where android.sensor.pixelMode is android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION.

Optional - The value for this key may be null on some devices.

SENSOR_AVAILABLE_TEST_PATTERN_MODES

Added in API level 21
static val SENSOR_AVAILABLE_TEST_PATTERN_MODES: CameraCharacteristics.Key<IntArray!>

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 - The value for this key may be null on some devices.

SENSOR_BLACK_LEVEL_PATTERN

Added in API level 21
static val SENSOR_BLACK_LEVEL_PATTERN: CameraCharacteristics.Key<BlackLevelPattern!>

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.

For a MONOCHROME camera device, all of the 2x2 channels must have the same values.

Range of valid values:
>= 0 for each.

Optional - The value for this key may be null on some devices.

SENSOR_CALIBRATION_TRANSFORM1

Added in API level 21
static val SENSOR_CALIBRATION_TRANSFORM1: CameraCharacteristics.Key<ColorSpaceTransform!>

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

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if the camera device has RAW capability.

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

SENSOR_CALIBRATION_TRANSFORM2

Added in API level 21
static val SENSOR_CALIBRATION_TRANSFORM2: CameraCharacteristics.Key<ColorSpaceTransform!>

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.

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if the camera device has RAW capability.

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

SENSOR_COLOR_TRANSFORM1

Added in API level 21
static val SENSOR_COLOR_TRANSFORM1: CameraCharacteristics.Key<ColorSpaceTransform!>

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

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if the camera device has RAW capability.

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

SENSOR_COLOR_TRANSFORM2

Added in API level 21
static val SENSOR_COLOR_TRANSFORM2: CameraCharacteristics.Key<ColorSpaceTransform!>

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.

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if the camera device has RAW capability.

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

SENSOR_FORWARD_MATRIX1

Added in API level 21
static val SENSOR_FORWARD_MATRIX1: CameraCharacteristics.Key<ColorSpaceTransform!>

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.

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if the camera device has RAW capability.

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

SENSOR_FORWARD_MATRIX2

Added in API level 21
static val SENSOR_FORWARD_MATRIX2: CameraCharacteristics.Key<ColorSpaceTransform!>

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.

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if the camera device has RAW capability.

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

SENSOR_INFO_ACTIVE_ARRAY_SIZE

Added in API level 21
static val SENSOR_INFO_ACTIVE_ARRAY_SIZE: CameraCharacteristics.Key<Rect!>

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.

For devices that do not support android.distortionCorrection.mode control, the active array must be the same as android.sensor.info.preCorrectionActiveArraySize.

For devices that support android.distortionCorrection.mode control, the active array must be enclosed by android.sensor.info.preCorrectionActiveArraySize. The difference between pre-correction active array and active array accounts for scaling or cropping caused by lens geometric distortion correction.

In general, application should always refer to active array size for controls like metering regions or crop region. Two exceptions are when the application is dealing with RAW image buffers (RAW_SENSOR, RAW10, RAW12 etc), or when application explicitly set android.distortionCorrection.mode to OFF. In these cases, application should refer to android.sensor.info.preCorrectionActiveArraySize.

Units: Pixel coordinates on the image sensor

This key is available on all devices.

SENSOR_INFO_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION

Added in API level 31
static val SENSOR_INFO_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION: CameraCharacteristics.Key<Rect!>

The area of the image sensor which corresponds to active pixels after any geometric distortion correction has been applied, when the sensor runs in maximum resolution mode.

Analogous to android.sensor.info.activeArraySize, when android.sensor.pixelMode is set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION. Refer to android.sensor.info.activeArraySize for details, with sensor array related keys replaced with their android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION counterparts. This key will only be present for devices which advertise the android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR capability or devices where CameraCharacteristics#getAvailableCaptureRequestKeys lists android.hardware.camera2.CaptureRequest#SENSOR_PIXEL_MODE}

Units: Pixel coordinates on the image sensor

Optional - The value for this key may be null on some devices.

SENSOR_INFO_BINNING_FACTOR

Added in API level 31
static val SENSOR_INFO_BINNING_FACTOR: CameraCharacteristics.Key<Size!>

Dimensions of the group of pixels which are under the same color filter. This specifies the width and height (pair of integers) of the group of pixels which fall under the same color filter for ULTRA_HIGH_RESOLUTION sensors.

Sensors can have pixels grouped together under the same color filter in order to improve various aspects of imaging such as noise reduction, low light performance etc. These groups can be of various sizes such as 2X2 (quad bayer), 3X3 (nona-bayer). This key specifies the length and width of the pixels grouped under the same color filter. In case the device has the CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR capability :

  • This key will not be present if REMOSAIC_REPROCESSING is not supported, since RAW images will have a regular bayer pattern.

In case the device does not have the CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR capability :

Units: Pixels

Optional - The value for this key may be null on some devices.

SENSOR_INFO_COLOR_FILTER_ARRANGEMENT

Added in API level 21
static val SENSOR_INFO_COLOR_FILTER_ARRANGEMENT: CameraCharacteristics.Key<Int!>

The arrangement of color filters on sensor; represents the colors in the top-left 2x2 section of the sensor, in reading order, for a Bayer camera, or the light spectrum it captures for MONOCHROME camera.

Possible values:

Optional - The value for this key 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

SENSOR_INFO_EXPOSURE_TIME_RANGE

Added in API level 21
static val SENSOR_INFO_EXPOSURE_TIME_RANGE: CameraCharacteristics.Key<Range<Long!>!>

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 - The value for this key 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

SENSOR_INFO_LENS_SHADING_APPLIED

Added in API level 23
static val SENSOR_INFO_LENS_SHADING_APPLIED: CameraCharacteristics.Key<Boolean!>

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 - The value for this key may be null on some devices.

SENSOR_INFO_MAX_FRAME_DURATION

Added in API level 21
static val SENSOR_INFO_MAX_FRAME_DURATION: CameraCharacteristics.Key<Long!>

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 android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration for the minimum frame duration values.

Units: Nanoseconds

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

Optional - The value for this key 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

SENSOR_INFO_PHYSICAL_SIZE

Added in API level 21
static val SENSOR_INFO_PHYSICAL_SIZE: CameraCharacteristics.Key<SizeF!>

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.

SENSOR_INFO_PIXEL_ARRAY_SIZE

Added in API level 21
static val SENSOR_INFO_PIXEL_ARRAY_SIZE: CameraCharacteristics.Key<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.hardware.camera2.params.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.

SENSOR_INFO_PIXEL_ARRAY_SIZE_MAXIMUM_RESOLUTION

Added in API level 31
static val SENSOR_INFO_PIXEL_ARRAY_SIZE_MAXIMUM_RESOLUTION: CameraCharacteristics.Key<Size!>

Dimensions of the full pixel array, possibly including black calibration pixels, when the sensor runs in maximum resolution mode. Analogous to android.sensor.info.pixelArraySize, when android.sensor.pixelMode is set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION.

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, when it runs in maximum resolution mode. That is, when android.sensor.pixelMode is set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION. This key will only be present for devices which advertise the android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR capability or devices where CameraCharacteristics#getAvailableCaptureRequestKeys lists android.hardware.camera2.CaptureRequest#SENSOR_PIXEL_MODE}

Units: Pixels

Optional - The value for this key may be null on some devices.

SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE

Added in API level 23
static val SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE: CameraCharacteristics.Key<Rect!>

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

If the camera device doesn't support geometric distortion correction, or 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.

SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION

Added in API level 31
static val SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE_MAXIMUM_RESOLUTION: CameraCharacteristics.Key<Rect!>

The area of the image sensor which corresponds to active pixels prior to the application of any geometric distortion correction, when the sensor runs in maximum resolution mode. This key must be used for crop / metering regions, only when android.sensor.pixelMode is set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION.

Analogous to android.sensor.info.preCorrectionActiveArraySize, when android.sensor.pixelMode is set to android.hardware.camera2.CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION. This key will only be present for devices which advertise the android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR capability or devices where CameraCharacteristics#getAvailableCaptureRequestKeys lists android.hardware.camera2.CaptureRequest#SENSOR_PIXEL_MODE}

Units: Pixel coordinates on the image sensor

Optional - The value for this key may be null on some devices.

SENSOR_INFO_SENSITIVITY_RANGE

Added in API level 21
static val SENSOR_INFO_SENSITIVITY_RANGE: CameraCharacteristics.Key<Range<Int!>!>

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 - The value for this key 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

SENSOR_INFO_TIMESTAMP_SOURCE

Added in API level 21
static val SENSOR_INFO_TIMESTAMP_SOURCE: CameraCharacteristics.Key<Int!>

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.

SENSOR_INFO_WHITE_LEVEL

Added in API level 21
static val SENSOR_INFO_WHITE_LEVEL: CameraCharacteristics.Key<Int!>

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 - The value for this key may be null on some devices.

SENSOR_MAX_ANALOG_SENSITIVITY

Added in API level 21
static val SENSOR_MAX_ANALOG_SENSITIVITY: CameraCharacteristics.Key<Int!>

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 - The value for this key 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

SENSOR_OPTICAL_BLACK_REGIONS

Added in API level 24
static val SENSOR_OPTICAL_BLACK_REGIONS: CameraCharacteristics.Key<Array<Rect!>!>

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 - The value for this key may be null on some devices.

SENSOR_ORIENTATION

Added in API level 21
static val SENSOR_ORIENTATION: CameraCharacteristics.Key<Int!>

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.

Starting with Android API level 32, camera clients that query the orientation via android.hardware.camera2.CameraCharacteristics#get on foldable devices which include logical cameras can receive a value that can dynamically change depending on the device/fold state. Clients are advised to not cache or store the orientation value of such logical sensors. In case repeated queries to CameraCharacteristics are not preferred, then clients can also access the entire mapping from device state to sensor orientation in android.hardware.camera2.params.DeviceStateSensorOrientationMap. Do note that a dynamically changing sensor orientation value in camera characteristics will not be the best way to establish the orientation per frame. Clients that want to know the sensor orientation of a particular captured frame should query the android.logicalMultiCamera.activePhysicalId from the corresponding capture result and check the respective physical camera orientation.

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_READOUT_TIMESTAMP

Added in API level 34
static val SENSOR_READOUT_TIMESTAMP: CameraCharacteristics.Key<Int!>

Whether or not the camera device supports readout timestamp and onReadoutStarted callback.

If this tag is HARDWARE, the camera device calls CameraCaptureSession.CaptureCallback#onReadoutStarted in addition to the CameraCaptureSession.CaptureCallback#onCaptureStarted callback for each capture. The timestamp passed into the callback is the start of camera image readout rather than the start of the exposure. The timestamp source of CameraCaptureSession.CaptureCallback#onReadoutStarted is the same as that of CameraCaptureSession.CaptureCallback#onCaptureStarted.

In addition, the application can switch an output surface's timestamp from start of exposure to start of readout by calling android.hardware.camera2.params.OutputConfiguration#setReadoutTimestampEnabled.

The readout timestamp is beneficial for video recording, because the encoder favors uniform timestamps, and the readout timestamps better reflect the cadence camera sensors output data.

Note that the camera device produces the start-of-exposure and start-of-readout callbacks together. As a result, the CameraCaptureSession.CaptureCallback#onReadoutStarted is called right after CameraCaptureSession.CaptureCallback#onCaptureStarted. The difference in start-of-readout and start-of-exposure is the sensor exposure time, plus certain constant offset. The offset is usually due to camera sensor level crop, and it is generally constant over time for the same set of output resolutions and capture settings.

Possible values:

This key is available on all devices.

SENSOR_REFERENCE_ILLUMINANT1

Added in API level 21
static val SENSOR_REFERENCE_ILLUMINANT1: CameraCharacteristics.Key<Int!>

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.

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if the camera device has RAW capability.

Possible values:

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

See Also

SENSOR_REFERENCE_ILLUMINANT2

Added in API level 21
static val SENSOR_REFERENCE_ILLUMINANT2: CameraCharacteristics.Key<Byte!>

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.

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if the camera device has RAW capability.

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

Optional - The value for this key may be null on some devices.

Permission android.Manifest.permission#CAMERA is needed to access this property

SHADING_AVAILABLE_MODES

Added in API level 23
static val SHADING_AVAILABLE_MODES: CameraCharacteristics.Key<IntArray!>

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.

STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES

Added in API level 21
static val STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES: CameraCharacteristics.Key<IntArray!>

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.

STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES

Added in API level 21
static val STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES: CameraCharacteristics.Key<BooleanArray!>

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 - The value for this key may be null on some devices.

STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES

Added in API level 23
static val STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES: CameraCharacteristics.Key<IntArray!>

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 - The value for this key may be null on some devices.

STATISTICS_INFO_AVAILABLE_OIS_DATA_MODES

Added in API level 28
static val STATISTICS_INFO_AVAILABLE_OIS_DATA_MODES: CameraCharacteristics.Key<IntArray!>

List of OIS data output modes for android.statistics.oisDataMode that are supported by this camera device.

If no OIS data output is available for this camera device, this key will contain only OFF.

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

Optional - The value for this key may be null on some devices.

STATISTICS_INFO_MAX_FACE_COUNT

Added in API level 21
static val STATISTICS_INFO_MAX_FACE_COUNT: CameraCharacteristics.Key<Int!>

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
static val SYNC_MAX_LATENCY: CameraCharacteristics.Key<Int!>

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.

TONEMAP_AVAILABLE_TONE_MAP_MODES

Added in API level 21
static val TONEMAP_AVAILABLE_TONE_MAP_MODES: CameraCharacteristics.Key<IntArray!>

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 - The value for this key 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

TONEMAP_MAX_CURVE_POINTS

Added in API level 21
static val TONEMAP_MAX_CURVE_POINTS: CameraCharacteristics.Key<Int!>

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 - The value for this key 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