Ambient

All Implemented Interfaces:

com.google.android.horologist.compose.ambient.AmbientState
```
public final class AmbientState.Ambient
 implements AmbientState
                    
```
Represents the state of a device, that the app is in ambient mode and not actively updating the display.
This class holds information about the ambient display properties, such as whether burn-in protection is required, if the device has low bit ambient display, and the last time the ambient state was updated.

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`displayName`
`private final Boolean`	`burnInProtectionRequired`
`private final Boolean`	`deviceHasLowBitAmbient`
`private final Long`	`updateTimeMillis`
`private final Boolean`	`isInteractive`
`private final Boolean`	`isAmbient`

Constructor Summary

Constructors
Constructor	Description
`AmbientState.Ambient(Boolean burnInProtectionRequired, Boolean deviceHasLowBitAmbient, Long updateTimeMillis)`

Method Summary

Modifier and Type	Method	Description
`String`	`getDisplayName()`
`final Boolean`	`getBurnInProtectionRequired()`
`final Boolean`	`getDeviceHasLowBitAmbient()`
`final Long`	`getUpdateTimeMillis()`
`Boolean`	`getIsInteractive()`
`Boolean`	`getIsAmbient()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AmbientState.Ambient

AmbientState.Ambient(Boolean burnInProtectionRequired, Boolean deviceHasLowBitAmbient, Long updateTimeMillis)

Method Detail

getDisplayName
```
 String getDisplayName()
```

getBurnInProtectionRequired

 final Boolean getBurnInProtectionRequired()

getDeviceHasLowBitAmbient

 final Boolean getDeviceHasLowBitAmbient()

getUpdateTimeMillis
```
 final Long getUpdateTimeMillis()
```

getIsInteractive
```
 Boolean getIsInteractive()
```

getIsAmbient
```
 Boolean getIsAmbient()
```