AmbientModeSupport.AmbientController

Added in 1.1.0
Deprecated in 1.3.0

class AmbientModeSupport.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 AmbientModeSupport.

Summary

Public functions

Boolean
Unit

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

Unit

Sets whether this activity's task should be moved to the front when the system exits ambient mode.

Public functions

isAmbient

Added in 1.1.0
Deprecated in 1.3.0
fun isAmbient(): Boolean
Returns
Boolean

true if the activity is currently in ambient.

setAmbientOffloadEnabled

Added in 1.1.0
Deprecated in 1.3.0
fun setAmbientOffloadEnabled(enabled: Boolean): Unit

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

setAutoResumeEnabled

Added in 1.2.0
Deprecated in 1.3.0
fun setAutoResumeEnabled(enabled: Boolean): Unit

Sets whether this activity's task should be moved to the front when the system exits ambient mode. If true, the activity's task may be moved to the front if it was the last activity to be running when ambient started, depending on how much time the system spent in ambient mode.