public class

ImageCaptureException

extends java.lang.Exception

 java.lang.Object

↳java.lang.Throwable

↳java.lang.Exception

↳androidx.camera.core.ImageCaptureException

Gradle dependencies

compile group: 'androidx.camera', name: 'camera-core', version: '1.5.0-alpha01'

  • groupId: androidx.camera
  • artifactId: camera-core
  • version: 1.5.0-alpha01

Artifact androidx.camera:camera-core:1.5.0-alpha01 it located at Google repository (https://maven.google.com/)

Overview

An exception thrown to indicate an error has occurred during image capture or while saving the captured image. See ImageCapture.OnImageCapturedCallback and ImageCapture.OnImageSavedCallback.

Summary

Constructors
publicImageCaptureException(int imageCaptureError, java.lang.String message, java.lang.Throwable cause)

Methods
public intgetImageCaptureError()

Returns the type of the image capture error.

from java.lang.ThrowableaddSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructors

public ImageCaptureException(int imageCaptureError, java.lang.String message, java.lang.Throwable cause)

Methods

public int getImageCaptureError()

Returns the type of the image capture error.

Returns:

The image capture error type, can have one of the following values: ImageCapture.ERROR_UNKNOWN, ImageCapture.ERROR_FILE_IO, ImageCapture.ERROR_CAPTURE_FAILED, ImageCapture.ERROR_CAMERA_CLOSED, ImageCapture.ERROR_INVALID_CAMERA.

Source

/*
 * Copyright 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.camera.core;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

/**
 * An exception thrown to indicate an error has occurred during image capture or while saving the
 * captured image. See {@link ImageCapture.OnImageCapturedCallback} and
 * {@link ImageCapture.OnImageSavedCallback}.
 */
public class ImageCaptureException extends Exception {

    @ImageCapture.ImageCaptureError
    private final int mImageCaptureError;

    public ImageCaptureException(@ImageCapture.ImageCaptureError final int imageCaptureError,
            @NonNull final String message, @Nullable final Throwable cause) {
        super(message, cause);
        mImageCaptureError = imageCaptureError;
    }

    /**
     * Returns the type of the image capture error.
     *
     * @return The image capture error type, can have one of the following values:
     * {@link ImageCapture#ERROR_UNKNOWN}, {@link ImageCapture#ERROR_FILE_IO},
     * {@link ImageCapture#ERROR_CAPTURE_FAILED}, {@link ImageCapture#ERROR_CAMERA_CLOSED},
     * {@link ImageCapture#ERROR_INVALID_CAMERA}.
     */
    @ImageCapture.ImageCaptureError
    public int getImageCaptureError() {
        return mImageCaptureError;
    }
}