Camera2CameraControl
@ExperimentalCamera2Interop
public final class Camera2CameraControl
An class that provides ability to interoperate with the android.hardware.camera2 APIs.
Camera2 specific controls, like capture request options, can be applied through this class. A Camera2CameraControl can be created from a general CameraControl which is associated to a camera. Then the controls will affect all use cases that are using that camera.
If any option applied by Camera2CameraControl conflicts with the options required by CameraX internally. The options from Camera2CameraControl will override, which may result in unexpected behavior depends on the options being applied.
Summary
Public methods |
|
|---|---|
@NonNull ListenableFuture<Void> |
Adds a |
@NonNull ListenableFuture<Void> |
Clears all existing capture request options. |
static @NonNull Camera2CameraControl |
from(@NonNull CameraControl cameraControl)Gets the |
@NonNull CaptureRequestOptions |
Gets all existing capture request options. |
@NonNull ListenableFuture<Void> |
Sets a |
Public methods
addCaptureRequestOptions
public @NonNull ListenableFuture<Void> addCaptureRequestOptions(@NonNull CaptureRequestOptions bundle)
Adds a CaptureRequestOptions updates the session with the options it contains.
The options will be merged with the existing options. If one option is set with a different value, it will overwrite the existing value.
Any values which are in conflict with values already set by CameraX, such as by androidx.camera.core.CameraControl, will overwrite the existing values. The values will be submitted with every repeating and single capture requests issued by CameraX, which may result in unexpected behavior depends on the values being applied.
| Parameters | |
|---|---|
@NonNull CaptureRequestOptions bundle |
The |
| Returns | |
|---|---|
@NonNull ListenableFuture<Void> |
a |
clearCaptureRequestOptions
public @NonNull ListenableFuture<Void> clearCaptureRequestOptions()
Clears all existing capture request options.
| Returns | |
|---|---|
@NonNull ListenableFuture<Void> |
a |
from
public static @NonNull Camera2CameraControl from(@NonNull CameraControl cameraControl)
Gets the Camera2CameraControl from a CameraControl.
The CameraControl is still usable after a Camera2CameraControl is obtained from it. Note that the Camera2CameraControl has higher priority than the CameraControl. For example, if FLASH_MODE is set through the Camera2CameraControl. All CameraControl features that required FLASH_MODE internally like torch may not work properly.
| Parameters | |
|---|---|
@NonNull CameraControl cameraControl |
The |
| Returns | |
|---|---|
@NonNull Camera2CameraControl |
The camera control with Camera2 implementation. |
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if the camera control does not contain the camera2 information (e.g., if CameraX was not initialized with a |
getCaptureRequestOptions
public @NonNull CaptureRequestOptions getCaptureRequestOptions()
Gets all existing capture request options.
It doesn't include the capture request options applied by the android.hardware.camera2.CameraDevice templates or by CameraX.
| Returns | |
|---|---|
@NonNull CaptureRequestOptions |
setCaptureRequestOptions
public @NonNull ListenableFuture<Void> setCaptureRequestOptions(@NonNull CaptureRequestOptions bundle)
Sets a CaptureRequestOptions and updates the session with the options it contains.
This will first clear all options that have already been set, then apply the new options.
Any values which are in conflict with values already set by CameraX, such as by androidx.camera.core.CameraControl, will overwrite the existing values. The values will be submitted with every repeating and single capture requests issued by CameraX, which may result in unexpected behavior depending on the values being applied.
| Parameters | |
|---|---|
@NonNull CaptureRequestOptions bundle |
The |
| Returns | |
|---|---|
@NonNull ListenableFuture<Void> |
a |