AmbientTickEffect

Functions summary

Unit	@Composable AmbientModeManager.AmbientTickEffect(block: () -> Unit) A convenience extension that performs recurrent, battery-efficient UI updates when the device is in AmbientMode.Ambient.

Functions

AmbientModeManager.AmbientTickEffect

Artifact: androidx.wear.compose:compose-foundation

View Source

Added in 1.6.0

@Composable
fun AmbientModeManager.AmbientTickEffect(block: () -> Unit): Unit

A convenience extension that performs recurrent, battery-efficient UI updates when the device is in AmbientMode.Ambient.

This extension handles the boilerplate for ambient tick synchronization: it automatically launches and manages a LaunchedEffect that repeatedly suspends using AmbientModeManager.withAmbientTick to align state updates with the system's infrequent ambient tick schedule.

The internal loop automatically terminates when the device returns to AmbientMode.Interactive.

Efficiency Note: The block lambda should only update the minimal androidx.compose.runtime.State required to prevent excessive recomposition and maximize battery life.

Example of using AmbientTickEffect:

import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.runtime.CompositionLocalProvider
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.mutableIntStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.wear.compose.foundation.AmbientMode
import androidx.wear.compose.foundation.AmbientTickEffect
import androidx.wear.compose.foundation.LocalAmbientModeManager
import androidx.wear.compose.foundation.rememberAmbientModeManager
import androidx.wear.compose.material.Text

// **Best Practice Note:** In a production application, the AmbientModeManager should be
// instantiated and provided at the highest level of the Compose hierarchy (typically in
// the host Activity's setContent block) using a CompositionLocalProvider. This ensures
// proper lifecycle management and broad accessibility.

// For this self-contained demo, AmbientModeManager is created and provided locally:
val activityAmbientModeManager = rememberAmbientModeManager()
CompositionLocalProvider(LocalAmbientModeManager provides activityAmbientModeManager) {
    var counter by remember { mutableIntStateOf(0) }

    val ambientModeManager = LocalAmbientModeManager.current
    ambientModeManager?.AmbientTickEffect {
        // While device is in ambient mode, update counter in onAmbientTick approx. every minute
        counter++
    }

    val ambientMode = ambientModeManager?.currentAmbientMode
    if (ambientMode is AmbientMode.Interactive) {
        // While device is not in ambient mode, update counter approx. every second
        LaunchedEffect(Unit) {
            while (true) {
                delay(1000L)
                counter++
            }
        }
    }

    Column(
        verticalArrangement = Arrangement.Center,
        horizontalAlignment = Alignment.CenterHorizontally,
        modifier = Modifier.fillMaxSize(),
    ) {
        val ambientModeName =
            when (ambientMode) {
                is AmbientMode.Interactive -> "Interactive"
                is AmbientMode.Ambient -> "Ambient"
                else -> "Unknown"
            }

        val updateInterval = if (ambientMode is AmbientMode.Ambient) "minute" else "second"
        val color = if (ambientMode is AmbientMode.Ambient) Color.Gray else Color.Yellow

        Text(text = "$ambientModeName Mode", color = color)
        Text(text = "Updates every $updateInterval")
        Text(text = "$counter")
    }
}

Parameters
block: () -> Unit	The state update logic to execute once per ambient tick.