ImageCapture.OnImageCapturedCallback

public static abstract class ImageCapture.OnImageCapturedCallback
extends Object

java.lang.Object
   ↳ androidx.camera.core.ImageCapture.OnImageCapturedCallback


Callback for when an image capture has completed.

Summary

Public constructors

ImageCapture.OnImageCapturedCallback()

Public methods

void onCaptureSuccess(ImageProxy image)

Callback for when the image has been captured.

void onError(int imageCaptureError, String message, Throwable cause)

Callback for when an error occurred during image capture.

Inherited methods

Public constructors

ImageCapture.OnImageCapturedCallback

public ImageCapture.OnImageCapturedCallback ()

Public methods

onCaptureSuccess

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 ImageFormat.JPEG, queryable via ImageProxy.getFormat().

The image is provided as captured by the underlying ImageReader without rotation applied. rotationDegrees 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.Builder.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 CameraDevice documentation.

Parameters
image ImageProxy: The captured image

onError

public void onError (int imageCaptureError, 
                String message, 
                Throwable cause)

Callback for when an error occurred during image capture.

Parameters
imageCaptureError int: The type of error composed by CameraX

message String: The error message composed by CameraX

cause Throwable: The throwable from lower-layer error