AmbientModeSupport.AmbientCallback

Added in 1.1.0
Deprecated in 1.3.0

abstract class AmbientModeSupport.AmbientCallback

Callback to receive ambient mode state changes. It must be used by all users of AmbientModeSupport.

Summary

Public constructors

Public functions
Unit

Called to inform an activity that whatever decomposition it has sent to Sidekick is no longer valid and should be re-sent before enabling ambient offload.
Unit
onEnterAmbient(ambientDetails: Bundle!)

Called when an activity is entering ambient mode.
Unit

Called when an activity should exit ambient mode.
Unit

Called when the system is updating the display for ambient mode.

Public constructors

AmbientCallback

Added in 1.1.0
Deprecated in 1.3.0
AmbientCallback()

Public functions

onAmbientOffloadInvalidated

Added in 1.1.0
Deprecated in 1.3.0
fun onAmbientOffloadInvalidated(): Unit

Called to inform an activity that whatever decomposition it has sent to Sidekick is no longer valid and should be re-sent before enabling ambient offload.

onEnterAmbient

Added in 1.1.0
Deprecated in 1.3.0
fun onEnterAmbient(ambientDetails: Bundle!): Unit

Called when an activity is entering ambient mode. This event is sent while an activity is running (after onResume, before onPause). All drawing should complete by the conclusion of this method. Note that invalidate() calls will be executed before resuming lower-power mode.

Parameters
ambientDetails: Bundle!

bundle containing information about the display being used. It includes information about low-bit color and burn-in protection.

onExitAmbient

Added in 1.1.0
Deprecated in 1.3.0
fun onExitAmbient(): Unit

Called when an activity should exit ambient mode. This event is sent while an activity is running (after onResume, before onPause).

onUpdateAmbient

Added in 1.1.0
Deprecated in 1.3.0
fun onUpdateAmbient(): Unit

Called when the system is updating the display for ambient mode. Activities may use this opportunity to update or invalidate views.