CameraExtensionCharacteristics

See also:

• CameraManager.getCameraExtensionCharacteristics(String)

EXTENSION_AUTOMATIC

public static final int EXTENSION_AUTOMATIC

Device-specific extension implementation for automatic selection of particular extension such as HDR or NIGHT depending on the current lighting and environment conditions.

Constant Value: 0 (0x00000000)

EXTENSION_BEAUTY

public static final int EXTENSION_BEAUTY

This constant was deprecated in API level 33.
Use EXTENSION_FACE_RETOUCH instead.

Device-specific extension implementation which tends to smooth the skin and apply other cosmetic effects to people's faces.

Constant Value: 1 (0x00000001)

EXTENSION_BOKEH

public static final int EXTENSION_BOKEH

Device-specific extension implementation which can blur certain regions of the final image thereby "enhancing" focus for all remaining non-blurred parts.

Constant Value: 2 (0x00000002)

EXTENSION_FACE_RETOUCH

public static final int EXTENSION_FACE_RETOUCH

Device-specific extension implementation which tends to smooth the skin and apply other cosmetic effects to people's faces.

Constant Value: 1 (0x00000001)

EXTENSION_HDR

public static final int EXTENSION_HDR

Device-specific extension implementation for enhancing the dynamic range of the final image.

Constant Value: 3 (0x00000003)

EXTENSION_NIGHT

public static final int EXTENSION_NIGHT

Device-specific extension implementation that aims to suppress noise and improve the overall image quality under low light conditions.

Constant Value: 4 (0x00000004)

get

public T get (int extension, 
                Key<T> key)

Gets an extension specific camera characteristics field value.

An extension can have a reduced set of camera capabilities (such as limited zoom ratio range, available video stabilization modes, etc). This API enables applications to query for an extension\u2019s specific camera characteristics. Applications are recommended to prioritize obtaining camera characteristics using this API when using an extension. A null result indicates that the extension specific characteristic is not defined or available.

getAvailableCaptureRequestKeys

public Set<CaptureRequest.Key<T>> getAvailableCaptureRequestKeys (int extension)

Returns the set of keys supported by a CaptureRequest submitted in a CameraExtensionSession with a given extension type.

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

Devices launching on Android Build.VERSION_CODES.VANILLA_ICE_CREAM or newer versions are required to support CaptureRequest#CONTROL_AF_MODE, CaptureRequest#CONTROL_AF_REGIONS, CaptureRequest#CONTROL_AF_TRIGGER, CaptureRequest#CONTROL_ZOOM_RATIO for CameraExtensionCharacteristics#EXTENSION_NIGHT.

getAvailableCaptureResultKeys

public Set<CaptureResult.Key<T>> getAvailableCaptureResultKeys (int extension)

Returns the set of keys supported by a CaptureResult passed as an argument to CameraExtensionSession.ExtensionCaptureCallback#onCaptureResultAvailable.

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

In case the set is empty, then the extension is not able to support any capture results and the CameraExtensionSession.ExtensionCaptureCallback#onCaptureResultAvailable callback will not be fired.

Devices launching on Android Build.VERSION_CODES.VANILLA_ICE_CREAM or newer versions are required to support CaptureResult#CONTROL_AF_MODE, CaptureResult#CONTROL_AF_REGIONS, CaptureResult#CONTROL_AF_TRIGGER, CaptureResult#CONTROL_AF_STATE, CaptureResult#CONTROL_ZOOM_RATIO for CameraExtensionCharacteristics#EXTENSION_NIGHT.

getEstimatedCaptureLatencyRangeMillis

public Range<Long> getEstimatedCaptureLatencyRangeMillis (int extension, 
                Size captureOutputSize, 
                int format)

Returns the estimated capture latency range in milliseconds for the target capture resolution during the calls to CameraExtensionSession#capture. This includes the time spent processing the multi-frame capture request along with any additional time for encoding of the processed buffer if necessary.

getExtensionSupportedSizes

public List<Size> getExtensionSupportedSizes (int extension, 
                int format)

Check whether a given extension is available and return the supported output surface resolutions that can be used for high-quality capture requests via CameraExtensionSession#capture.

Note that device-specific extensions are allowed to support only a subset of the camera resolutions advertised by StreamConfigurationMap#getOutputSizes.

Device-specific extensions currently support at most three multi-frame capture surface formats. ImageFormat.JPEG will be supported by all extensions while ImageFormat.YUV_420_888, ImageFormat.JPEG_R, or ImageFormat.YCBCR_P010 may or may not be supported.

getExtensionSupportedSizes

public List<Size> getExtensionSupportedSizes (int extension, 
                Class<T> klass)

Get a list of sizes compatible with klass to use as an output for the repeating request CameraExtensionSession#setRepeatingRequest.

Note that device-specific extensions are allowed to support only a subset of the camera output surfaces and resolutions. The SurfaceTexture class is guaranteed at least one size for backward compatible cameras whereas other output classes are not guaranteed to be supported.

Starting with Android Build.VERSION_CODES.UPSIDE_DOWN_CAKE SurfaceView classes are also guaranteed to be supported and include the same resolutions as SurfaceTexture. Clients must set the desired SurfaceView resolution by calling SurfaceHolder.setFixedSize(int, int).

getKeys

public Set<CameraCharacteristics.Key<T>> getKeys (int extension)

Returns the CameraCharacteristics keys that have extension-specific values.

An application can query the value from the key using get(int, android.hardware.camera2.CameraCharacteristics.Key) API.

getPostviewSupportedSizes

public List<Size> getPostviewSupportedSizes (int extension, 
                Size captureSize, 
                int format)

Get a list of the postview sizes supported for a still capture, using its capture size captureSize, to use as an output for the postview request.

Available postview sizes will always be either equal to or less than the still capture size. When choosing the most applicable postview size for a usecase, it should be noted that lower resolution postviews will generally be available more quickly than larger resolution postviews. For example, when choosing a size for an optimized postview that will be displayed as a placeholder while the final image is processed, the resolution closest to the preview size may be most suitable.

Note that device-specific extensions are allowed to support only a subset of the camera resolutions advertised by StreamConfigurationMap#getOutputSizes.

getSupportedExtensions

public List<Integer> getSupportedExtensions ()

Return a list of supported device-specific extensions for a given camera device.

isCaptureProcessProgressAvailable

public boolean isCaptureProcessProgressAvailable (int extension)

Retrieve support for capture progress callbacks via CameraExtensionSession.ExtensionCaptureCallback#onCaptureProcessProgressed.

isPostviewAvailable

public boolean isPostviewAvailable (int extension)

Checks for postview support of still capture.

A postview is a preview version of the still capture that is available before the final image. For example, it can be used as a temporary placeholder for the requested capture while the final image is being processed. The supported sizes for a still capture's postview can be retrieved using CameraExtensionCharacteristics#getPostviewSupportedSizes(int, Size, int).

Starting with Android Build.VERSION_CODES.VANILLA_ICE_CREAM, the formats of the still capture and postview are not required to be equivalent upon capture request.