public abstract class

ImageCapture.OnImageCapturedCallback

extends java.lang.Object

 java.lang.Object

↳androidx.camera.core.ImageCapture.OnImageCapturedCallback

Overview

Callback for when an image capture has completed.

Summary

Constructors
publicOnImageCapturedCallback()

Methods
public voidonCaptureSuccess(ImageProxy image)

Callback for when the image has been captured.

public voidonError(ImageCaptureException exception)

Callback for when an error occurred during image capture.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public OnImageCapturedCallback()

Methods

public void onCaptureSuccess(ImageProxy image)

Callback for when the image has been captured.

The application is responsible for calling ImageProxy.close() to close the image.

The image is of format , queryable via ImageProxy.getFormat().

The image is provided as captured by the underlying without rotation applied. The value in image.getImageInfo().getRotationDegrees() describes the magnitude of clockwise rotation, which if applied to the image will make it match the currently configured target rotation.

For example, if the current target rotation is set to the display rotation, rotationDegrees is the rotation to apply to the image to match the display orientation. A rotation of 90 degrees would mean rotating the image 90 degrees clockwise produces an image that will match the display orientation.

See also ImageCapture.setTargetRotation(int) and ImageCapture.setTargetRotation(int).

Timestamps are in nanoseconds and monotonic and can be compared to timestamps from images produced from UseCases bound to the same camera instance. More detail is available depending on the implementation. For example with CameraX using a androidx.camera.camera2 implementation additional detail can be found in android.hardware.camera2.CameraDevice documentation.

Parameters:

image: The captured image

public void onError(ImageCaptureException exception)

Callback for when an error occurred during image capture.

Parameters:

exception: An ImageCaptureException that contains the type of error, the error message and the throwable that caused it.