CameraExtensionCharacteristics

EXTENSION_AUTOMATIC

static val EXTENSION_AUTOMATIC: Int

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

Value: 0

EXTENSION_BEAUTY

static val EXTENSION_BEAUTY: Int

Deprecated: Use EXTENSION_FACE_RETOUCH instead.

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

Value: 1

EXTENSION_BOKEH

static val EXTENSION_BOKEH: Int

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

Value: 2

EXTENSION_FACE_RETOUCH

static val EXTENSION_FACE_RETOUCH: Int

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

Value: 1

EXTENSION_HDR

static val EXTENSION_HDR: Int

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

Value: 3

EXTENSION_NIGHT

static val EXTENSION_NIGHT: Int

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

Value: 4

get

fun <T : Any!> get(
    extension: Int, 
    key: CameraCharacteristics.Key<T>
): T

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’s 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

fun getAvailableCaptureRequestKeys(extension: Int): MutableSet<CaptureRequest.Key<Any!>!>

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

fun getAvailableCaptureResultKeys(extension: Int): MutableSet<CaptureResult.Key<Any!>!>

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

fun getEstimatedCaptureLatencyRangeMillis(
    extension: Int, 
    captureOutputSize: Size, 
    format: Int
): Range<Long!>?

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

fun getExtensionSupportedSizes(
    extension: Int, 
    format: Int
): MutableList<Size!>

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

fun <T : Any!> getExtensionSupportedSizes(
    extension: Int, 
    klass: Class<T>
): MutableList<Size!>

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 android.graphics.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 android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE android.view.SurfaceView classes are also guaranteed to be supported and include the same resolutions as android.graphics.SurfaceTexture. Clients must set the desired SurfaceView resolution by calling android.view.SurfaceHolder#setFixedSize.

getKeys

fun getKeys(extension: Int): MutableSet<CameraCharacteristics.Key<Any!>!>

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

fun getPostviewSupportedSizes(
    extension: Int, 
    captureSize: Size, 
    format: Int
): MutableList<Size!>

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

getSupportedExtensions

fun getSupportedExtensions(): MutableList<Int!>

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

isCaptureProcessProgressAvailable

fun isCaptureProcessProgressAvailable(extension: Int): Boolean

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

isPostviewAvailable

fun isPostviewAvailable(extension: Int): Boolean

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 android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM, the formats of the still capture and postview are not required to be equivalent upon capture request.