[go: nahoru, domu]

blob: 79e1c4a6035f6d8a6603101467baa3318b17f1eb [file] [log] [blame]
/*
* Copyright 2021 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;
import java.util.List;
/**
* A {@link CameraProvider} provides basic access to a set of cameras such as querying for camera
* existence or information.
*
* <p>A device might have multiple cameras. According to the applications' design, they might
* need to search for a suitable camera which supports their functions. A {@link CameraProvider}
* allows the applications to check whether any camera exists to fulfill the requirements or to
* get {@link CameraInfo} instances of all cameras to retrieve the camera information.
*/
@RequiresApi(21) // TODO(b/200306659): Remove and replace with annotation on package-info.java
public interface CameraProvider {
/**
* Checks whether this provider supports at least one camera that meets the requirements from a
* {@link CameraSelector}.
*
* <p>If this method returns {@code true}, then the camera selector can be used to bind
* use cases and retrieve a {@link Camera} instance.
*
* @param cameraSelector the {@link CameraSelector} that filters available cameras.
* @return true if the device has at least one available camera, otherwise false.
* @throws CameraInfoUnavailableException if unable to access cameras, perhaps due to
* insufficient permissions.
*/
boolean hasCamera(@NonNull CameraSelector cameraSelector) throws CameraInfoUnavailableException;
/**
* Returns {@link CameraInfo} instances of the available cameras.
*
* <p>While iterating through all the available {@link CameraInfo}, if one of them meets some
* predefined requirements, a {@link CameraSelector} that uniquely identifies its camera
* can be retrieved using {@link CameraInfo#getCameraSelector()}, which can then be used to bind
* {@linkplain UseCase use cases} to that camera.
*
* @return A list of {@link CameraInfo} instances for the available cameras.
*/
@NonNull
List<CameraInfo> getAvailableCameraInfos();
/**
* Returns list of {@link CameraInfo} instances of the available concurrent cameras.
*
* <p>The available concurrent cameras include all combinations of cameras which could
* operate concurrently on the device. Each list maps to one combination of these camera's
* {@link CameraInfo}.
*
* @return list of combinations of {@link CameraInfo}.
*
* @hide
*/
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
@NonNull
List<List<CameraInfo>> getAvailableConcurrentCameraInfos();
/**
* Returns concurrent camera mode.
*
* @return true if concurrent mode is enabled, otherwise false.
*
* @hide
*/
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
boolean isConcurrentCameraModeOn();
}