# AmbientLifecycleObserver.AmbientDetails

Artifact: [androidx.wear:wear](https://developer.android.com/jetpack/androidx/releases/wear) [View Source](https://cs.android.com/search?q=file:androidx/wear/ambient/AmbientLifecycleObserver.kt+class:androidx.wear.ambient.AmbientLifecycleObserver.AmbientDetails) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear#1.3.0)

*** ** * ** ***


```
public final class AmbientLifecycleObserver.AmbientDetails
```

<br />

*** ** * ** ***

Details about ambient mode support on the current device, passed to `https://developer.android.com/reference/androidx/wear/ambient/AmbientLifecycleObserver.AmbientLifecycleCallback#onEnterAmbient(androidx.wear.ambient.AmbientLifecycleObserver.AmbientDetails)`.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/wear/ambient/AmbientLifecycleObserver.AmbientDetails#AmbientDetails(kotlin.Boolean,kotlin.Boolean)( boolean burnInProtectionRequired, boolean deviceHasLowBitAmbient )` |

| ### Public methods |
|---|---|
| `final boolean` | `https://developer.android.com/reference/androidx/wear/ambient/AmbientLifecycleObserver.AmbientDetails#getBurnInProtectionRequired()()` whether the ambient layout must implement burn-in protection. |
| `final boolean` | `https://developer.android.com/reference/androidx/wear/ambient/AmbientLifecycleObserver.AmbientDetails#getDeviceHasLowBitAmbient()()` whether this device has low-bit ambient mode. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/ambient/AmbientLifecycleObserver.AmbientDetails#toString()()` |

## Public constructors

### AmbientDetails

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

```
public AmbientDetails(
    boolean burnInProtectionRequired,
    boolean deviceHasLowBitAmbient
)
```

| Parameters |
|---|---|
| `boolean burnInProtectionRequired` | whether the ambient layout must implement burn-in protection. When this property is set to true, views must be shifted around periodically in ambient mode. To ensure that content isn't shifted off the screen, avoid placing content within 10 pixels of the edge of the screen. Activities should also avoid solid white areas to prevent pixel burn-in. Both of these requirements only apply in ambient mode, and only when this property is set to true. |
| `boolean deviceHasLowBitAmbient` | whether this device has low-bit ambient mode. When this property is set to true, the screen supports fewer bits for each color in ambient mode. In this case, activities should disable anti-aliasing in ambient mode. |

## Public methods

### getBurnInProtectionRequired

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

```
public final boolean getBurnInProtectionRequired()
```

whether the ambient layout must implement burn-in protection. When this property is set to true, views must be shifted around periodically in ambient mode. To ensure that content isn't shifted off the screen, avoid placing content within 10 pixels of the edge of the screen. Activities should also avoid solid white areas to prevent pixel burn-in. Both of these requirements only apply in ambient mode, and only when this property is set to true.

### getDeviceHasLowBitAmbient

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

```
public final boolean getDeviceHasLowBitAmbient()
```

whether this device has low-bit ambient mode. When this property is set to true, the screen supports fewer bits for each color in ambient mode. In this case, activities should disable anti-aliasing in ambient mode.

### toString

```
public @NonNull String toString()
```