public final class

CameraCaptureMetaData

extends java.lang.Object

 java.lang.Object

↳androidx.camera.core.CameraCaptureMetaData

Overview

This class defines the enumeration constants used for querying the camera capture mode and results.

Summary

Constructors
publicCameraCaptureMetaData()

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

Constructors

public CameraCaptureMetaData()

Source

/*
 * Copyright (C) 2019 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.RestrictTo;
import androidx.annotation.RestrictTo.Scope;

/**
 * This class defines the enumeration constants used for querying the camera capture mode and
 * results.
 *
 * @hide
 */
@RestrictTo(Scope.LIBRARY_GROUP)
public final class CameraCaptureMetaData {

    /** Auto focus (AF) mode. */
    public enum AfMode {

        /** AF mode is currently unknown. */
        UNKNOWN,

        /** The AF routine does not control the lens. */
        OFF,

        /**
         * AF is triggered on demand.
         *
         * <p>In this mode, the lens does not move unless the auto focus trigger action is called.
         */
        ON_MANUAL_AUTO,

        /**
         * AF is continually scanning.
         *
         * <p>In this mode, the AF algorithm modifies the lens position continually to attempt to
         * provide a constantly-in-focus stream.
         */
        ON_CONTINUOUS_AUTO
    }

    /** Auto focus (AF) state. */
    public enum AfState {

        /** AF state is currently unknown. */
        UNKNOWN,

        /** AF is off or not yet has been triggered. */
        INACTIVE,

        /** AF is performing an AF scan. */
        SCANNING,

        /** AF currently believes it is in focus. */
        FOCUSED,

        /** AF believes it is focused correctly and has locked focus. */
        LOCKED_FOCUSED,

        /** AF has failed to focus and has locked focus. */
        LOCKED_NOT_FOCUSED
    }

    /** Auto exposure (AE) state. */
    public enum AeState {

        /** AE state is currently unknown. */
        UNKNOWN,

        /** AE is off or has not yet been triggered. */
        INACTIVE,

        /** AE is performing an AE search. */
        SEARCHING,

        /**
         * AE has a good set of control values, but flash needs to be fired for good quality still
         * capture.
         */
        FLASH_REQUIRED,

        /** AE has a good set of control values for the current scene. */
        CONVERGED,

        /** AE has been locked. */
        LOCKED
    }

    /** Auto white balance (AWB) state. */
    public enum AwbState {

        /** AWB state is currently unknown. */
        UNKNOWN,

        /** AWB is not in auto mode, or has not yet started metering. */
        INACTIVE,

        /** AWB is performing AWB metering. */
        METERING,

        /** AWB has a good set of control values for the current scene. */
        CONVERGED,

        /** AWB has been locked. */
        LOCKED
    }

    /** Flash state. */
    public enum FlashState {

        /** Flash state is unknown. */
        UNKNOWN,

        /** Flash is unavailable or not ready to fire. */
        NONE,

        /** Flash is ready to fire. */
        READY,

        /** Flash has been fired. */
        FIRED
    }
}