compose-layout/com.google.android.horologist.compose.ambient/AmbientState/Ambient

Ambient

data class Ambient(val burnInProtectionRequired: Boolean = false, val deviceHasLowBitAmbient: Boolean = false, val updateTimeMillis: Long = System.currentTimeMillis()) : 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.

See also

AmbientLifecycleObserver.AmbientDetails

Constructors

constructor(burnInProtectionRequired: Boolean = false, deviceHasLowBitAmbient: Boolean = false, updateTimeMillis: Long = System.currentTimeMillis())

Properties

burnInProtectionRequired

val burnInProtectionRequired: Boolean = false

Indicates if burn-in protection is necessary for the device. Defaults to false.

deviceHasLowBitAmbient

val deviceHasLowBitAmbient: Boolean = false

Specifies if the device has a low bit ambient display. Defaults to false.

open override val displayName: String

open val isAmbient: Boolean

open val isInteractive: Boolean

updateTimeMillis

val updateTimeMillis: Long

The timestamp in milliseconds when the ambient state was last updated. Defaults to the current system time.