ImageCapture

public static final int CAPTURE_MODE_MAXIMIZE_QUALITY = 0

Optimizes capture pipeline to prioritize image quality over latency. When the capture mode is set to MAX_QUALITY, images may take longer to capture.

public static final int CAPTURE_MODE_MINIMIZE_LATENCY = 1

Optimizes capture pipeline to prioritize latency over image quality. When the capture mode is set to MIN_LATENCY, images may capture faster but the image quality may be reduced.

@ExperimentalZeroShutterLag
public static final int CAPTURE_MODE_ZERO_SHUTTER_LAG = 2

Optimizes capture pipeline to have better latency while keeping good image quality. When the capture mode is set to ZERO_SHUTTER_LAG, the latency between the shutter button is clicked and the picture is taken is expected to be minimized, compared with other capture modes.

ZERO_SHUTTER_LAG mode is aiming to provide the minimum latency for instant capture. It caches intermediate results and deliver the one with the closest timestamp when takePicture is invoked.

isZslSupported can be used to query the device capability to support this mode or not. However, this mode also depends on use cases configuration and flash mode settings. If VideoCapture is bound or flash mode is not OFF or OEM Extension is ON, this mode will be disabled automatically.

public static final int ERROR_CAMERA_CLOSED = 3

An error indicating the request cannot be done due to camera is closed.

public static final int ERROR_CAPTURE_FAILED = 2

An error reported by camera framework indicating the capture request is failed.

public static final int ERROR_FILE_IO = 1

An error occurred while attempting to read or write a file, such as when saving an image to a File.

public static final int ERROR_INVALID_CAMERA = 4

An error indicating this ImageCapture is not bound to a valid camera.

public static final int ERROR_UNKNOWN = 0

An unknown error occurred.

See message parameter in onError callback or log for more details.

public static final int FLASH_MODE_AUTO = 0

Auto flash. The flash will be used according to the camera system's determination when taking a picture.

public static final int FLASH_MODE_OFF = 2

No flash. The flash will never be used when taking a picture.

public static final int FLASH_MODE_ON = 1

Always flash. The flash will always be used when taking a picture.

public static final int FLASH_MODE_SCREEN = 3

Screen flash. Display screen brightness will be used as alternative to flash when taking a picture with front camera.

This flash mode can be set via setFlashMode after setting a non-null ScreenFlash instance with setScreenFlash. This mode will always invoke all the necessary operations for a screen flash image capture, i.e. it is similar to FLASH_MODE_ON, not FLASH_MODE_AUTO.

The following code snippet shows an example implementation of how this flash mode can be set to an ImageCapture instance.

imageCapture.setScreenFlash(new ImageCapture.ScreenFlash() {
    
    public void apply(long expirationTimeMillis,
            ScreenFlashListener screenFlashListener) {
        whiteColorOverlayView.setVisibility(View.VISIBLE);
        maximizeScreenBrightness();
        screenFlashListener.onCompleted();
    }

    
    public void clear() {
        restoreScreenBrightness();
        whiteColorOverlayView.setVisibility(View.INVISIBLE);
    }
});

imageCapture.setFlashMode(ImageCapture.FLASH_MODE_SCREEN);

public static final int OUTPUT_FORMAT_JPEG = 0

Captures 8-bit standard dynamic range (SDR) images using the JPEG image format.

public static final int OUTPUT_FORMAT_JPEG_ULTRA_HDR = 1

Captures Ultra HDR compressed images using the JPEG_R image format.

This format is backward compatible with SDR JPEG images and supports HDR rendering of content. This means that on older apps or devices, images appear seamlessly as regular JPEG; on apps and devices that have been updated to fully support the format, images appear as HDR.

For more information see Support Ultra HDR.

public static final int OUTPUT_FORMAT_RAW = 2

Captures raw images in the RAW_SENSOR image format.

public static final int OUTPUT_FORMAT_RAW_JPEG = 3

Captures raw images in the RAW_SENSOR and JPEG image formats.

public int getCaptureMode()

Returns the set capture mode.

This is set when constructing an ImageCapture using setCaptureMode. This is static for an instance of ImageCapture.

public int getFlashMode()

Get the flash mode.

public static @NonNull ImageCaptureCapabilities getImageCaptureCapabilities(@NonNull CameraInfo cameraInfo)

Returns ImageCaptureCapabilities to query ImageCapture capability of the given CameraInfo.

Some capabilities are only exposed on Extensions-enabled cameras. To get the correct capabilities when Extensions are enabled, you need to pass the CameraInfo from the Extensions-enabled Camera instance. To do this, use the CameraSelector instance retrieved from getExtensionEnabledCameraSelector to invoke bindToLifecycle where you can skip use cases arguments if you'd like to query it before opening the camera. Then, use the returned Camera to get the CameraInfo instance.

>The following code snippet demonstrates how to enable postview:

          
CameraSelector extensionCameraSelector =
    extensionsManager.getExtensionEnabledCameraSelector(cameraSelector, ExtensionMode.NIGHT);
Camera camera = cameraProvider.bindToLifecycle(activity, extensionCameraSelector);
ImageCaptureCapabilities capabilities =
    ImageCapture.getImageCaptureCapabilities(camera.getCameraInfo());
ImageCapture imageCapture = new ImageCapture.Builder()
    .setPostviewEnabled(capabilities.isPostviewSupported())
    .build();
}

public @IntRange(from = 1, to = 100) int getJpegQuality()

Returns the JPEG quality setting.

This is set when constructing an ImageCapture using setJpegQuality. If not set, a default value will be set according to the capture mode setting. JPEG compression quality 95 is set for CAPTURE_MODE_MINIMIZE_LATENCY and 100 is set for CAPTURE_MODE_MAXIMIZE_QUALITY. This is static for an instance of ImageCapture.

public int getOutputFormat()

Returns the output format setting.

If the output format was not provided to setOutputFormat, this will return the default of OUTPUT_FORMAT_JPEG.

public @Nullable ResolutionSelector getPostviewResolutionSelector()

Returns the ResolutionSelector used to select the postview size.