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

Package-level declarations

Types

data class AmbientStateUpdate(val ambientState: AmbientState, val changeTimeMillis: Long = System.currentTimeMillis())

Represent Ambient as updates, with the state and time of change. This is necessary to ensure that when the system provides a (typically) 1min-frequency callback to onUpdateAmbient, the developer may wish to update composables, but the state hasn't changed.

Functions

AmbientAware

@Composable

fun AmbientAware(isAlwaysOnScreen: Boolean = true, block: @Composable (AmbientStateUpdate) -> Unit)

Composable for general handling of changes and updates to ambient status. A new AmbientStateUpdate is generated with any change of ambient state, as well as with any periodic update generated whilst the screen is in ambient mode.

AmbientAwareTime

@RequiresApi(value = 26)

@Composable

fun AmbientAwareTime(stateUpdate: AmbientStateUpdate, updatePeriodMillis: Long = 1000, block: @Composable (dateTime: ZonedDateTime, isAmbient: Boolean) -> Unit)

An example of using AmbientAware: Provides the time, at the specified update frequency, whilst in interactive mode, or when ambient-generated updates occur (typically every 1 min).