ImageCaptureControl.java

/*
 * Copyright 2022 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.imagecapture;

import android.os.Build;

import androidx.annotation.MainThread;
import androidx.annotation.NonNull;
import androidx.annotation.RequiresApi;
import androidx.camera.core.ImageCapture;
import androidx.camera.core.impl.CaptureConfig;

import com.google.common.util.concurrent.ListenableFuture;

import java.util.List;

/**
 * Interface for controlling {@link ImageCapture}.
 */
@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
public interface ImageCaptureControl {

    /**
     * Invokes {@link ImageCapture#lockFlashMode()}.
     */
    @MainThread
    void lockFlashMode();

    /**
     * Invokes {@link ImageCapture#unlockFlashMode()}.
     */
    @MainThread
    void unlockFlashMode();

    /**
     * Invokes {@link ImageCapture#submitStillCaptureRequest(List)}}
     */
    @MainThread
    @NonNull
    ListenableFuture<Void> submitStillCaptureRequests(@NonNull List<CaptureConfig> captureConfigs);
}