# LowLightBoostState

Artifact: [androidx.camera:camera-core](https://developer.android.com/jetpack/androidx/releases/camera) [View Source](https://cs.android.com/search?q=file:androidx/camera/core/LowLightBoostState.java+class:androidx.camera.core.LowLightBoostState) Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/camera#1.5.0)

*** ** * ** ***


```
class LowLightBoostState
```

<br />

*** ** * ** ***

Defines the valid states for Low Light Boost, as returned by `https://developer.android.com/reference/kotlin/androidx/camera/core/CameraInfo#getLowLightBoostState()`.

These states indicate whether the camera device supports low light boost and if it is currently active.

| See also |
|---|---|
| `https://developer.android.com/reference/android/hardware/camera2/CaptureResult.html#CONTROL_LOW_LIGHT_BOOST_STATE` |   |

## Summary

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/camera/core/LowLightBoostState#ACTIVE() = 1` Low-light boost is on and active. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/camera/core/LowLightBoostState#INACTIVE() = 0` Low-light boost is on but inactive. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/camera/core/LowLightBoostState#OFF() = -1` Low-light boost is off. |

## Constants

### ACTIVE

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/camera#1.5.0)

```
const val ACTIVE = 1: Int
```

Low-light boost is on and active.

This state indicates that the camera device is currently applying low-light boost to the image stream.

| See also |
|---|---|
| `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#CONTROL_LOW_LIGHT_BOOST_STATE_ACTIVE` |   |

### INACTIVE

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/camera#1.5.0)

```
const val INACTIVE = 0: Int
```

Low-light boost is on but inactive.

This state indicates that the camera device supports low-light boost but it is not currently active. This can happen if the camera device is not in low-light conditions.

| See also |
|---|---|
| `https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#CONTROL_LOW_LIGHT_BOOST_STATE_INACTIVE` |   |

### OFF

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/camera#1.5.0)

```
const val OFF = -1: Int
```

Low-light boost is off.

This is the default state if low-light boost is unavailable. This may be because your camera doesn't support it or there's a settings conflict.