Added in [version 33.1](https://developer.android.com/topic/libraries/support-library/revisions) Summary: [Constants](https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions#constants) \| [Methods](https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions#inhmethods)

# AmbientOptions


`
public

final

class
AmbientOptions
`


`

extends Object


`

`


`

|---|---|
| java.lang.Object ||
| ↳ | com.google.wear.services.ambient.AmbientOptions |

<br />

*** ** * ** ***

`https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions` provide components a way to convey their specific ambient mode support
configuration requirements for use with `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager#createController(android.content.Context,%20com.google.wear.services.ambient.AmbientOptions)`.

Options are specific to component type and components should use the creator methods provided
to instantiate suitable base options.

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions#AMBIENT_SUPPORT_AUTORESUME_ONLY` Used with `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.Controller#setAmbientSupportLevel(int)` indicating that this component does not provide an ambient-specific UI. |
| `int` | `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions#AMBIENT_SUPPORT_NONE` Used with `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.Controller#setAmbientSupportLevel(int)` indicates that the component does not support ambient mode at all. |
| `int` | `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions#AMBIENT_SUPPORT_TAKEOVER_DISPLAY` Used with `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.Controller#setAmbientSupportLevel(int)` indicating that this component implements full ambient mode support. |

| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions#equals(java.lang.Object)(Object o) ` |
| ` int` | ` https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions#hashCode()() ` |
| ` static https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions` | ` https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions#makeActivityOptions(android.app.Activity,%20com.google.wear.services.ambient.AmbientComponentState.ActivityStateRegistry,%20com.google.wear.services.ambient.AmbientManager.AmbientComponentListener,%20com.google.wear.services.ambient.AmbientManager.AmbientTransitionListener)(Activity activity, https://developer.android.com/reference/com/google/wear/services/ambient/AmbientComponentState.ActivityStateRegistry stateRegistry, https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.AmbientComponentListener lifecycleListener, https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.AmbientTransitionListener transitionListener) ` Make `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions` suitable for use with an Activity based app component. |
| ` static https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions` | ` https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions#makeWatchFaceOptions(android.content.ComponentName,%20com.google.wear.services.ambient.AmbientComponentState.WatchFaceStateRegistry,%20com.google.wear.services.ambient.AmbientManager.AmbientComponentListener,%20com.google.wear.services.ambient.AmbientManager.AmbientTransitionListener)(ComponentName component, https://developer.android.com/reference/com/google/wear/services/ambient/AmbientComponentState.WatchFaceStateRegistry stateRegistry, https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.AmbientComponentListener lifecycleListener, https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.AmbientTransitionListener transitionListener) ` Make `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions` suitable for use with a watch face component. |
| ` String` | ` https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions#toString()() ` |

| ### Inherited methods |
|---|---|
| From class ` java.lang.Object ` |---|---| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class<?>` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` String` | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | ||

## Constants

### AMBIENT_SUPPORT_AUTORESUME_ONLY

Added in [version 33.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public static final int AMBIENT_SUPPORT_AUTORESUME_ONLY
```

Used with `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.Controller#setAmbientSupportLevel(int)` indicating that this
component does not provide an ambient-specific UI. When entering ambient mode, this component
will be moved to the background to make way for the system's ambient UI. However, if the
system exits ambient mode early enough, this component will be automatically brought back to
the foreground.

<br />

Constant Value:

1
(0x00000001)


### AMBIENT_SUPPORT_NONE

Added in [version 33.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public static final int AMBIENT_SUPPORT_NONE
```

Used with `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.Controller#setAmbientSupportLevel(int)` indicates that the
component does not support ambient mode at all. When entering ambient mode, this component
will be moved to the background to make way for the system's ambient UI.

<br />

Constant Value:

0
(0x00000000)


### AMBIENT_SUPPORT_TAKEOVER_DISPLAY

Added in [version 33.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public static final int AMBIENT_SUPPORT_TAKEOVER_DISPLAY
```

Used with `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.Controller#setAmbientSupportLevel(int)` indicating that this
component implements full ambient mode support. That is, when entering ambient mode, this
component will take over the display and provide a UI that is suitable for low power mode.

<br />

Constant Value:

2
(0x00000002)


## Public methods

### equals

Added in [version 33.2](https://developer.android.com/topic/libraries/support-library/revisions)

```
public boolean equals (Object o)
```

<br />

<br />

| Parameters ||
|---|---|
| `o` | `Object` <br /> |

| Returns ||
|---|---|
| `boolean` | <br /> |

### hashCode

Added in [version 33.2](https://developer.android.com/topic/libraries/support-library/revisions)

```
public int hashCode ()
```

<br />

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### makeActivityOptions

Added in [version 33.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public static AmbientOptions makeActivityOptions (Activity activity, 
                AmbientComponentState.ActivityStateRegistry stateRegistry, 
                AmbientManager.AmbientComponentListener lifecycleListener, 
                AmbientManager.AmbientTransitionListener transitionListener)
```

Make `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions` suitable for use with an Activity based app component.

<br />

| Parameters ||
|---|---|
| `activity` | `Activity`: the `https://developer.android.com/reference/android/app/Activity` that will support Ambient. <br /> |
| `stateRegistry` | `AmbientComponentState.ActivityStateRegistry`: the `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientComponentState.ActivityStateRegistry` that is used to track the app lifecycle so as to enable ambient support. <br /> |
| `lifecycleListener` | `AmbientManager.AmbientComponentListener`: the `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.AmbientComponentListener` implementation provided by the component that will be used to handle ambient state changes. <br /> |
| `transitionListener` | `AmbientManager.AmbientTransitionListener`: the `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.AmbientComponentListener` implementation provided by the component that will be used to handle visual transitions associated with ambient state changes. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions` | the options for use in registering the component via `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager#createController(android.content.Context,%20com.google.wear.services.ambient.AmbientOptions)` <br /> |

### makeWatchFaceOptions

Added in [version 33.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public static AmbientOptions makeWatchFaceOptions (ComponentName component, 
                AmbientComponentState.WatchFaceStateRegistry stateRegistry, 
                AmbientManager.AmbientComponentListener lifecycleListener, 
                AmbientManager.AmbientTransitionListener transitionListener)
```

Make `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions` suitable for use with a watch face component.

<br />

| Parameters ||
|---|---|
| `component` | `ComponentName`: the `https://developer.android.com/reference/android/content/ComponentName` of the watch face. <br /> |
| `stateRegistry` | `AmbientComponentState.WatchFaceStateRegistry`: the `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientComponentState.WatchFaceStateRegistry` that is used to track the watch face state so as to enable ambient support. <br /> |
| `lifecycleListener` | `AmbientManager.AmbientComponentListener`: the `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.AmbientComponentListener` implementation provided by the component that will be used to handle ambient state changes. <br /> |
| `transitionListener` | `AmbientManager.AmbientTransitionListener`: the `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager.AmbientTransitionListener` implementation provided by the component that will be used to handle visual transitions associated with ambient state changes. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientOptions` | the options for use in registering the component via `https://developer.android.com/reference/com/google/wear/services/ambient/AmbientManager#createController(android.content.Context,%20com.google.wear.services.ambient.AmbientOptions)` <br /> |

### toString

Added in [version 33.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public String toString ()
```

<br />

<br />

| Returns ||
|---|---|
| `String` | <br /> |