public final class

FocusMeteringResult

extends java.lang.Object

 java.lang.Object

↳androidx.camera.core.FocusMeteringResult

Gradle dependencies

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

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

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

Overview

Result of the CameraControl.startFocusAndMetering(FocusMeteringAction).

Summary

Methods
public static FocusMeteringResultcreate(boolean isFocusSuccess)

public static FocusMeteringResultemptyInstance()

public booleanisFocusSuccessful()

Returns if auto focus is successful.

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

Methods

public static FocusMeteringResult emptyInstance()

public static FocusMeteringResult create(boolean isFocusSuccess)

public boolean isFocusSuccessful()

Returns if auto focus is successful.

If AF is requested in FocusMeteringAction but current camera does not support AF, it will return true. If AF is not requested, it will return false.

Source

/*
 * Copyright 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.NonNull;
import androidx.annotation.RequiresApi;
import androidx.annotation.RestrictTo;

/**
 * Result of the {@link CameraControl#startFocusAndMetering(FocusMeteringAction)}.
 */
@RequiresApi(21) // TODO(b/200306659): Remove and replace with annotation on package-info.java
public final class FocusMeteringResult {
    private boolean mIsFocusSuccessful;

    /** @hide */
    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
    @NonNull
    public static FocusMeteringResult emptyInstance() {
        return new FocusMeteringResult(false);
    }

    /** @hide */
    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
    @NonNull
    public static FocusMeteringResult create(boolean isFocusSuccess) {
        return new FocusMeteringResult(isFocusSuccess);
    }

    private FocusMeteringResult(boolean isFocusSuccess) {
        mIsFocusSuccessful = isFocusSuccess;
    }

    /**
     * Returns if auto focus is successful.
     *
     * <p>If AF is requested in {@link FocusMeteringAction} but current camera does not support
     * AF, it will return true. If AF is not requested, it will return false.
     */
    public boolean isFocusSuccessful() {
        return mIsFocusSuccessful;
    }
}