Camera2CameraControl
public
final
class
Camera2CameraControl
extends Object
java.lang.Object | |
↳ | androidx.camera.camera2.interop.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 | |
---|---|
ListenableFuture<Void>
|
addCaptureRequestOptions(CaptureRequestOptions bundle)
Adds a |
static
Camera2CameraControl
|
from(CameraControl cameraControl)
Gets the |
CaptureRequestOptions
|
getCaptureRequestOptions()
Gets all the capture request options that is currently applied by the
|
ListenableFuture<Void>
|
setCaptureRequestOptions(CaptureRequestOptions bundle)
Sets a |
Inherited methods | |
---|---|
Public methods
addCaptureRequestOptions
public ListenableFuture<Void> addCaptureRequestOptions (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
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 | |
---|---|
bundle |
CaptureRequestOptions : The CaptureRequestOptions which will be set. |
Returns | |
---|---|
ListenableFuture<Void> |
a ListenableFuture which completes when the repeating
CaptureResult shows the options have be submitted
completely. The future fails with CameraControl.OperationCanceledException if newer
options are set or camera is closed before the current request completes.
|
from
public static Camera2CameraControl from (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
CaptureRequest.FLASH_MODE
is set through the
Camera2CameraControl
. All CameraControl
features that required
CaptureRequest.FLASH_MODE
internally like torch may not
work properly.
Parameters | |
---|---|
cameraControl |
CameraControl : The CameraControl to get from. |
Returns | |
---|---|
Camera2CameraControl |
The camera control with Camera2 implementation. |
Throws | |
---|---|
IllegalArgumentException |
if the camera control does not contain the camera2
information (e.g., if CameraX was not initialized with a
Camera2Config ).
|
getCaptureRequestOptions
public CaptureRequestOptions getCaptureRequestOptions ()
Gets all the capture request options that is currently applied by the
Camera2CameraControl
.
It doesn't include the capture request options applied by
the CameraDevice
templates or by CameraX.
Returns | |
---|---|
CaptureRequestOptions |
The CaptureRequestOptions .
|
setCaptureRequestOptions
public ListenableFuture<Void> setCaptureRequestOptions (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
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 | |
---|---|
bundle |
CaptureRequestOptions : The CaptureRequestOptions which will be set. |
Returns | |
---|---|
ListenableFuture<Void> |
a ListenableFuture which completes when the repeating
CaptureResult shows the options have be submitted
completely. The future fails with CameraControl.OperationCanceledException if newer
options are set or camera is closed before the current request completes.
Cancelling the ListenableFuture is a no-op.
|