Google is committed to advancing racial equity for Black communities. See how.

ImageCaptureExtender

public abstract class ImageCaptureExtender
extends Object

java.lang.Object
   ↳ androidx.camera.extensions.ImageCaptureExtender


Class for using an OEM provided extension on image capture.

Summary

Public constructors

ImageCaptureExtender()

Public methods

void enableExtension(CameraSelector cameraSelector)

Enables the derived image capture extension feature.

boolean isExtensionAvailable(CameraSelector cameraSelector)

Indicates whether extension function can support with the given CameraSelector.

Inherited methods

Public constructors

ImageCaptureExtender

public ImageCaptureExtender ()

Public methods

enableExtension

public void enableExtension (CameraSelector cameraSelector)

Enables the derived image capture extension feature. If the extension can't be applied on any of the cameras specified with the given CameraSelector, it will be no-ops.

Enabling extensions on ImageCapture may limit the number of cameras which can be selected when the ImageCapture is used as a parameter to bindToLifecycle. BindToLifecycle will throw an exception if no cameras are found that support the extension.

Image capture extension has dependence on preview extension. A PREVIEW_EXTENSION_REQUIRED error will be thrown if corresponding preview extension is not enabled together.

Parameters
cameraSelector CameraSelector: The selector used to determine the camera for which to enable extensions.

isExtensionAvailable

public boolean isExtensionAvailable (CameraSelector cameraSelector)

Indicates whether extension function can support with the given CameraSelector.

Parameters
cameraSelector CameraSelector: The selector that determines a camera that will be checked for the availability of extensions.

Returns
boolean True if the specific extension function is supported for the camera device.