AmbientMode
classAmbientMode: Fragment
kotlin.Any | ||
↳ | android.app.Fragment | |
↳ | androidx.wear.ambient.AmbientMode |
Use this as a headless Fragment to add ambient support to an Activity on Wearable devices.
The application that uses this should add the android.Manifest.permission#WAKE_LOCK
permission to its manifest.
The primary entry point for this code is the attachAmbientSupport(Activity)
method. It should be called with an Activity
as an argument and that Activity
will then be able to receive ambient lifecycle events through an AmbientCallback
. The Activity
will also receive a AmbientController
object from the attachment which can be used to query the current status of the ambient mode. An example of how to attach AmbientMode
to your Activity
and use the AmbientController
can be found below:
<code>AmbientMode.AmbientController controller = AmbientMode.attachAmbientSupport(this); boolean isAmbient = controller.isAmbient(); </code>
Summary
Nested classes | |
---|---|
abstract |
Callback to receive ambient mode state changes. |
abstract |
Interface for any |
A class for interacting with the ambient mode on a wearable device. |
Constants | |
---|---|
static String |
Property in bundle passed to |
static String |
Property in bundle passed to |
static String |
Fragment tag used by default when adding |
Public constructors | |
---|---|
<init>() Constructor |
Public methods | |
---|---|
static AmbientMode.AmbientController! |
attachAmbientSupport(activity: T) Attach ambient support to the given activity. |
Unit |
dump(prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!) |
Unit | |
Unit | |
Unit | |
Unit |
onDetach() |
Unit |
onPause() |
Unit |
onResume() |
Unit |
onStop() |
Constants
EXTRA_BURN_IN_PROTECTION
static val EXTRA_BURN_IN_PROTECTION: String
Property in bundle passed to AmbientCallback#onEnterAmbient(Bundle)
to indicate whether burn-in protection is required. When this property is set to true, views must be shifted around periodically in ambient mode. To ensure that content isn't shifted off the screen, avoid placing content within 10 pixels of the edge of the screen. Activities should also avoid solid white areas to prevent pixel burn-in. Both of these requirements only apply in ambient mode, and only when this property is set to true.
Value: WearableActivityController.EXTRA_BURN_IN_PROTECTION
EXTRA_LOWBIT_AMBIENT
static val EXTRA_LOWBIT_AMBIENT: String
Property in bundle passed to AmbientCallback#onEnterAmbient(Bundle)
to indicate whether the device has low-bit ambient mode. When this property is set to true, the screen supports fewer bits for each color in ambient mode. In this case, activities should disable anti-aliasing in ambient mode.
Value: WearableActivityController.EXTRA_LOWBIT_AMBIENT
FRAGMENT_TAG
static val FRAGMENT_TAG: String
Fragment tag used by default when adding AmbientMode
to add ambient support to an Activity
.
Value: "android.support.wearable.ambient.AmbientMode"
Public constructors
<init>
AmbientMode()
Constructor
Public methods
attachAmbientSupport
static fun <T : Activity!> attachAmbientSupport(activity: T): AmbientMode.AmbientController!
Attach ambient support to the given activity. Calling this method with an Activity implementing the AmbientCallbackProvider
interface will provide you with an opportunity to react to ambient events such as onEnterAmbient
. Alternatively, you can call this method with an Activity which does not implement the AmbientCallbackProvider
interface and that will only enable the auto-resume functionality. This is equivalent to providing (@code null} from the AmbientCallbackProvider
.
Parameters | |
---|---|
activity |
T: the activity to attach ambient support to. |
Return | |
---|---|
AmbientMode.AmbientController! |
the associated AmbientController which can be used to query the state of ambient mode. |
dump
fun dump(
prefix: String!,
fd: FileDescriptor!,
writer: PrintWriter!,
args: Array<String!>!
): Unit