CameraControl

fun cancelFocusAndMetering(): ListenableFuture<Void!>

Cancels current FocusMeteringAction and clears AF/AE/AWB regions.

Clear the AF/AE/AWB regions and update current AF mode to continuous AF (if supported). If current FocusMeteringAction has not completed, the returned ListenableFuture in startFocusAndMetering will fail with OperationCanceledException.

fun enableLowLightBoostAsync(lowLightBoost: Boolean): ListenableFuture<Void!>

Enables low-light boost mode.

Devices running Android 15 or higher can provide support for low-light boost. This feature can automatically adjust the brightness of the preview, video or image analysis streams in low-light conditions. This is different from how the night mode camera extension creates still images, because night mode combines a burst of photos to create a single, enhanced image. While night mode works very well for creating a still image, it can't create a continuous stream of frames, but Low Light Boost can. Thus, Low Light Boost enables new camera capabilities, such as the following:

• Providing an enhanced image preview, so users can better frame their low-light pictures.
• Recording brighter videos in low-light conditions.
• Scanning QR codes in low-light conditions.

Applications can query the low-light boost availability via isLowLightBoostSupported. If you enable Low Light Boost, it automatically turns on when there's a low light level, and turns off when there's more light.

If the camera device does not support low-light boost, the value obtained via getLowLightBoostState will always be OFF.

Note that this mode may interact with other configurations:

• When low-light boost is on, the flash or torch functionality may be unavailable.
• When frame rate configuration results in an FPS exceeding 30, low-light boost will be disabled and the state will always be (OFF).
• Low-light boost is not currently supported for HDR 10-bit capture sessions. If the dynamic range configuration results in a 10-bit capture session, low-light boost will be disabled and the state will always be (OFF).

Therefore, to use flash or torch functionality, low-light boost mode must be disabled. To ensure low-light boost mode functions correctly, the following conditions must be met:

• The frame rate must not exceed 30 FPS.
• The dynamic range setting must not be 10-bit.

fun enableTorch(torch: Boolean): ListenableFuture<Void!>

Enable the torch or disable the torch.

getTorchState can be used to query the torch state. If the camera doesn't have a flash unit (see hasFlashUnit), then the call will do nothing, the returned ListenableFuture will complete immediately with a failed result and the torch state will be OFF.

When the torch is enabled, the torch will remain enabled during photo capture regardless of the flashMode setting. When the torch is disabled, flash will function as the flash mode set by either setFlashMode or setFlashMode.

fun setExposureCompensationIndex(value: Int): ListenableFuture<Int!>

Set the exposure compensation value for the camera.

Only one setExposureCompensationIndex is allowed to run at the same time. If multiple setExposureCompensationIndex are executed in a row, only the latest one setting will be kept in the camera. The other actions will be cancelled and the ListenableFuture will fail with the OperationCanceledException. After all the previous actions is cancelled, the camera device will adjust the brightness according to the latest setting.

fun setLinearZoom(linearZoom: @FloatRange(from = 0.0, to = 1.0) Float): ListenableFuture<Void!>

Sets current zoom by a linear zoom value ranging from 0f to 1.0f. LinearZoom 0f represents the minimum zoom while linearZoom 1.0f represents the maximum zoom. The advantage of linearZoom is that it ensures the field of view (FOV) varies linearly with the linearZoom value, for use with slider UI elements (while setZoomRatio works well for pinch-zoom gestures).

It modifies both current zoomRatio and linearZoom so if apps are observing zoomRatio or linearZoom, they will get the update as well. If the linearZoom is not in the range [0..1], the returned ListenableFuture will fail with IllegalArgumentException and it won't modify current linearZoom and zoomRatio. It is application's duty to clamp the linearZoom within [0..1].

fun setTorchStrengthLevel(torchStrengthLevel: @IntRange(from = 1) Int): ListenableFuture<Void!>

Sets torch strength level.

The torch strength level only applies on the case that torch is turned on by enableTorch and doesn't affect other usages of the flash unit.

Use the value returned by getMaxTorchStrengthLevel to set the maximum level the device can provide and use 1 to set the minimum level. If a level greater than the maximum value or less than 1 is set, the returned ListenableFuture will fail with an IllegalArgumentException and it won't modify the torch strength.

If the device doesn't have a flash unit or doesn't support configuring torch strength level, the returned ListenableFuture will fail with an UnsupportedOperationException.

fun setZoomRatio(ratio: Float): ListenableFuture<Void!>

Sets current zoom by ratio.

It modifies both current zoomRatio and linearZoom so if apps are observing zoomRatio or linearZoom, they will get the update as well. If the ratio is smaller than getMinZoomRatio or larger than getMaxZoomRatio, the returned ListenableFuture will fail with IllegalArgumentException and it won't modify current zoom ratio. It is the applications' duty to clamp the ratio.

fun startFocusAndMetering(action: FocusMeteringAction): ListenableFuture<FocusMeteringResult!>

Starts a focus and metering action configured by the FocusMeteringAction.

It will trigger an auto focus action and enable AF/AE/AWB metering regions. The action is configured by a FocusMeteringAction which contains the configuration of multiple AF/AE/AWB MeteringPoints and an auto-cancel duration. See FocusMeteringAction for more details.

Only one FocusMeteringAction is allowed to run at a time. If multiple FocusMeteringAction are executed in a row, only the latest one will work and other actions will be cancelled.

If the FocusMeteringAction specifies more AF/AE/AWB points than what is supported on the current device, only the first point and then in order up to the number of points supported by the device will be enabled.

If none of the points with either AF/AE/AWB can be supported on the device or none of the points generates valid metering rectangles, the returned ListenableFuture in startFocusAndMetering will fail immediately.