AmbientMode.AmbientController

Artifact: androidx.wear:wear

View Source

Added in 1.1.0

Deprecated in 1.1.0

---

Kotlin |Java

inner class AmbientMode.AmbientController

---

A class for interacting with the ambient mode on a wearable device. This class can be used to query the current state of ambient mode. An instance of this class is returned to the user when they attach their Activity to AmbientMode.

Summary

Public functions
Boolean	isAmbient()
Unit	setAmbientOffloadEnabled(enabled: Boolean) Sets whether this activity is currently in a state that supports ambient offload mode.

Public functions

isAmbient

Added in 1.1.0

Deprecated in 1.1.0

fun isAmbient(): Boolean

Returns
Boolean	true if the activity is currently in ambient.

setAmbientOffloadEnabled

Added in 1.1.0

Deprecated in 1.1.0

fun setAmbientOffloadEnabled(enabled: Boolean): Unit

Sets whether this activity is currently in a state that supports ambient offload mode.