added in version 27.1.0
belongs to Maven artifact com.android.support:wear:28.0.0-alpha1
Deprecated since version 27.1.0

AmbientMode

public final class AmbientMode
extends Fragment

java.lang.Object
↳	android.app.Fragment
	↳	android.support.wear.ambient.AmbientMode

This class was deprecated in API level 27.1.0.
please use AmbientModeSupport instead.

Use this as a headless Fragment to add ambient support to an Activity on Wearable devices.

The application that uses this should add the 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 AmbientMode.AmbientCallback. The Activity will also receive a AmbientMode.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 AmbientMode.AmbientController can be found below:

AmbientMode.AmbientController controller = AmbientMode.attachAmbientSupport(this);
     boolean isAmbient =  controller.isAmbient();

Summary

Nested classes
`class`	`AmbientMode.AmbientCallback` Callback to receive ambient mode state changes.
`interface`	`AmbientMode.AmbientCallbackProvider` Interface for any `Activity` that wishes to implement Ambient Mode.
`class`	`AmbientMode.AmbientController` A class for interacting with the ambient mode on a wearable device.

Constants
`String`	`EXTRA_BURN_IN_PROTECTION` Property in bundle passed to `AmbientCallback#onEnterAmbient(Bundle)` to indicate whether burn-in protection is required.
`String`	`EXTRA_LOWBIT_AMBIENT` Property in bundle passed to `AmbientCallback#onEnterAmbient(Bundle)` to indicate whether the device has low-bit ambient mode.
`String`	`FRAGMENT_TAG` Fragment tag used by default when adding `AmbientMode` to add ambient support to an `Activity`.

Inherited constants

From interface


    android.content.ComponentCallbacks2

Public constructors
`AmbientMode()` Constructor

Public methods
`static <T extends Activity> AmbientMode.AmbientController`	`attachAmbientSupport(T activity)` Attach ambient support to the given activity.
`void`	`dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)`
`void`	`onAttach(Context context)`
`void`	`onCreate(Bundle savedInstanceState)`
`void`	`onDestroy()`
`void`	`onDetach()`
`void`	`onPause()`
`void`	`onResume()`
`void`	`onStop()`

Inherited methods

From class


  
    android.app.Fragment

`void`	`dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3)`
`final boolean`	`equals(Object arg0)`
`final Activity`	`getActivity()`
`boolean`	`getAllowEnterTransitionOverlap()`
`boolean`	`getAllowReturnTransitionOverlap()`
`final Bundle`	`getArguments()`
`final FragmentManager`	`getChildFragmentManager()`
`Context`	`getContext()`
`Transition`	`getEnterTransition()`
`Transition`	`getExitTransition()`
`final FragmentManager`	`getFragmentManager()`
`final Object`	`getHost()`
`final int`	`getId()`
`final LayoutInflater`	`getLayoutInflater()`
`LoaderManager`	`getLoaderManager()`
`final Fragment`	`getParentFragment()`
`Transition`	`getReenterTransition()`
`final Resources`	`getResources()`
`final boolean`	`getRetainInstance()`
`Transition`	`getReturnTransition()`
`Transition`	`getSharedElementEnterTransition()`
`Transition`	`getSharedElementReturnTransition()`
`final String`	`getString(int arg0, Object... arg1)`
`final String`	`getString(int arg0)`
`final String`	`getTag()`
`final Fragment`	`getTargetFragment()`
`final int`	`getTargetRequestCode()`
`final CharSequence`	`getText(int arg0)`
`boolean`	`getUserVisibleHint()`
`View`	`getView()`
`final int`	`hashCode()`
`static Fragment`	`instantiate(Context arg0, String arg1)`
`static Fragment`	`instantiate(Context arg0, String arg1, Bundle arg2)`
`final boolean`	`isAdded()`
`final boolean`	`isDetached()`
`final boolean`	`isHidden()`
`final boolean`	`isInLayout()`
`final boolean`	`isRemoving()`
`final boolean`	`isResumed()`
`final boolean`	`isStateSaved()`
`final boolean`	`isVisible()`
`void`	`onActivityCreated(Bundle arg0)`
`void`	`onActivityResult(int arg0, int arg1, Intent arg2)`
`void`	`onAttach(Activity arg0)`
`void`	`onAttach(Context arg0)`
`void`	`onAttachFragment(Fragment arg0)`
`void`	`onConfigurationChanged(Configuration arg0)`
`boolean`	`onContextItemSelected(MenuItem arg0)`
`void`	`onCreate(Bundle arg0)`
`Animator`	`onCreateAnimator(int arg0, boolean arg1, int arg2)`
`void`	`onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)`
`void`	`onCreateOptionsMenu(Menu arg0, MenuInflater arg1)`
`View`	`onCreateView(LayoutInflater arg0, ViewGroup arg1, Bundle arg2)`
`void`	`onDestroy()`
`void`	`onDestroyOptionsMenu()`
`void`	`onDestroyView()`
`void`	`onDetach()`
`LayoutInflater`	`onGetLayoutInflater(Bundle arg0)`
`void`	`onHiddenChanged(boolean arg0)`
`void`	`onInflate(AttributeSet arg0, Bundle arg1)`
`void`	`onInflate(Activity arg0, AttributeSet arg1, Bundle arg2)`
`void`	`onInflate(Context arg0, AttributeSet arg1, Bundle arg2)`
`void`	`onLowMemory()`
`void`	`onMultiWindowModeChanged(boolean arg0)`
`void`	`onMultiWindowModeChanged(boolean arg0, Configuration arg1)`
`boolean`	`onOptionsItemSelected(MenuItem arg0)`
`void`	`onOptionsMenuClosed(Menu arg0)`
`void`	`onPause()`
`void`	`onPictureInPictureModeChanged(boolean arg0, Configuration arg1)`
`void`	`onPictureInPictureModeChanged(boolean arg0)`
`void`	`onPrepareOptionsMenu(Menu arg0)`
`void`	`onRequestPermissionsResult(int arg0, String[] arg1, int[] arg2)`
`void`	`onResume()`
`void`	`onSaveInstanceState(Bundle arg0)`
`void`	`onStart()`
`void`	`onStop()`
`void`	`onTrimMemory(int arg0)`
`void`	`onViewCreated(View arg0, Bundle arg1)`
`void`	`onViewStateRestored(Bundle arg0)`
`void`	`postponeEnterTransition()`
`void`	`registerForContextMenu(View arg0)`
`final void`	`requestPermissions(String[] arg0, int arg1)`
`void`	`setAllowEnterTransitionOverlap(boolean arg0)`
`void`	`setAllowReturnTransitionOverlap(boolean arg0)`
`void`	`setArguments(Bundle arg0)`
`void`	`setEnterSharedElementCallback(SharedElementCallback arg0)`
`void`	`setEnterTransition(Transition arg0)`
`void`	`setExitSharedElementCallback(SharedElementCallback arg0)`
`void`	`setExitTransition(Transition arg0)`
`void`	`setHasOptionsMenu(boolean arg0)`
`void`	`setInitialSavedState(Fragment.SavedState arg0)`
`void`	`setMenuVisibility(boolean arg0)`
`void`	`setReenterTransition(Transition arg0)`
`void`	`setRetainInstance(boolean arg0)`
`void`	`setReturnTransition(Transition arg0)`
`void`	`setSharedElementEnterTransition(Transition arg0)`
`void`	`setSharedElementReturnTransition(Transition arg0)`
`void`	`setTargetFragment(Fragment arg0, int arg1)`
`void`	`setUserVisibleHint(boolean arg0)`
`boolean`	`shouldShowRequestPermissionRationale(String arg0)`
`void`	`startActivity(Intent arg0)`
`void`	`startActivity(Intent arg0, Bundle arg1)`
`void`	`startActivityForResult(Intent arg0, int arg1)`
`void`	`startActivityForResult(Intent arg0, int arg1, Bundle arg2)`
`void`	`startIntentSenderForResult(IntentSender arg0, int arg1, Intent arg2, int arg3, int arg4, int arg5, Bundle arg6)`
`void`	`startPostponedEnterTransition()`
`String`	`toString()`
`void`	`unregisterForContextMenu(View arg0)`

From class


  
    java.lang.Object

From interface


  
    android.content.ComponentCallbacks2

From interface


  
    android.view.View.OnCreateContextMenuListener

From interface


  
    android.content.ComponentCallbacks

Constants

EXTRA_BURN_IN_PROTECTION

added in version 27.1.0

String EXTRA_BURN_IN_PROTECTION

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.

Constant Value: "com.google.android.wearable.compat.extra.BURN_IN_PROTECTION"

EXTRA_LOWBIT_AMBIENT

added in version 27.1.0

String EXTRA_LOWBIT_AMBIENT

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.

Constant Value: "com.google.android.wearable.compat.extra.LOWBIT_AMBIENT"

FRAGMENT_TAG

added in version 27.1.0

String FRAGMENT_TAG

Fragment tag used by default when adding AmbientMode to add ambient support to an Activity.

Constant Value: "android.support.wearable.ambient.AmbientMode"

Public constructors

AmbientMode

added in version 27.1.0

AmbientMode ()

Constructor

Public methods

attachAmbientSupport

added in version 27.1.0

AmbientMode.AmbientController attachAmbientSupport (T activity)

Attach ambient support to the given activity. Calling this method with an Activity implementing the AmbientMode.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 AmbientMode.AmbientCallbackProvider interface and that will only enable the auto-resume functionality. This is equivalent to providing (@code null} from the AmbientMode.AmbientCallbackProvider.

Parameters
`activity`	`T`: the activity to attach ambient support to.

Returns
`AmbientMode.AmbientController`	the associated `AmbientMode.AmbientController` which can be used to query the state of ambient mode.

dump

void dump (String prefix, 
                FileDescriptor fd, 
                PrintWriter writer, 
                String[] args)

Parameters
`prefix`	`String`
`fd`	`FileDescriptor`
`writer`	`PrintWriter`
`args`	`String`

onAttach

void onAttach (Context context)

Parameters
`context`	`Context`

onCreate

void onCreate (Bundle savedInstanceState)

Parameters
`savedInstanceState`	`Bundle`

onDestroy

void onDestroy ()

onDetach

void onDetach ()

onPause

void onPause ()

onResume

void onResume ()

onStop

void onStop ()

AmbientMode

Summary

Nested classes

Constants

Inherited constants

Public constructors

Public methods

Inherited methods

Constants

EXTRA_BURN_IN_PROTECTION

EXTRA_LOWBIT_AMBIENT

FRAGMENT_TAG

Public constructors

AmbientMode

Public methods

attachAmbientSupport

dump

onAttach

onCreate

onDestroy

onDetach

onPause

onResume

onStop

Interfaces

Classes