Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#nestedclasses) \| [Constants](https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#constants) \| [Inherited Constants](https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#inhconstants) \| [Fields](https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#lfields) \| [Methods](https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#inhmethods)

# AdvertiseSettings

*** ** * ** ***

` public final class AdvertiseSettings `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.bluetooth.le.AdvertiseSettings |

<br />

*** ** * ** ***

The `https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings` provide a way to adjust advertising preferences for each Bluetooth LE advertisement instance. Use `https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings.Builder` to create an instance of this class.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings.Builder` Builder class for `https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings`. |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#ADVERTISE_MODE_BALANCED` Perform Bluetooth LE advertising in balanced power mode. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#ADVERTISE_MODE_LOW_LATENCY` Perform Bluetooth LE advertising in low latency, high power mode. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#ADVERTISE_MODE_LOW_POWER` Perform Bluetooth LE advertising in low power mode. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#ADVERTISE_TX_POWER_HIGH` Advertise using high TX power level. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#ADVERTISE_TX_POWER_LOW` Advertise using low TX power level. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#ADVERTISE_TX_POWER_MEDIUM` Advertise using medium TX power level. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#ADVERTISE_TX_POWER_ULTRA_LOW` Advertise using the lowest transmission (TX) power level. |

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings>` | `https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#CREATOR` <br /> |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#getMode()() ` Returns the advertise mode. |
| ` int` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#getTimeout()() ` Returns the advertising time limit in milliseconds. |
| ` int` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#getTxPowerLevel()() ` Returns the TX power level for advertising. |
| ` boolean` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#isConnectable()() ` Returns whether the advertisement will indicate connectable. |
| ` boolean` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#isDiscoverable()() ` Returns whether the advertisement will be discoverable. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertiseSettings#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Constants

### ADVERTISE_MODE_BALANCED

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int ADVERTISE_MODE_BALANCED
```

Perform Bluetooth LE advertising in balanced power mode. This is balanced between advertising frequency and power consumption.

<br />

Constant Value: 1 (0x00000001)

### ADVERTISE_MODE_LOW_LATENCY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int ADVERTISE_MODE_LOW_LATENCY
```

Perform Bluetooth LE advertising in low latency, high power mode. This has the highest power consumption and should not be used for continuous background advertising.

<br />

Constant Value: 2 (0x00000002)

### ADVERTISE_MODE_LOW_POWER

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int ADVERTISE_MODE_LOW_POWER
```

Perform Bluetooth LE advertising in low power mode. This is the default and preferred advertising mode as it consumes the least power.

<br />

Constant Value: 0 (0x00000000)

### ADVERTISE_TX_POWER_HIGH

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int ADVERTISE_TX_POWER_HIGH
```

Advertise using high TX power level. This corresponds to largest visibility range of the advertising packet.

<br />

Constant Value: 3 (0x00000003)

### ADVERTISE_TX_POWER_LOW

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int ADVERTISE_TX_POWER_LOW
```

Advertise using low TX power level.

<br />

Constant Value: 1 (0x00000001)

### ADVERTISE_TX_POWER_MEDIUM

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int ADVERTISE_TX_POWER_MEDIUM
```

Advertise using medium TX power level.

<br />

Constant Value: 2 (0x00000002)

### ADVERTISE_TX_POWER_ULTRA_LOW

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int ADVERTISE_TX_POWER_ULTRA_LOW
```

Advertise using the lowest transmission (TX) power level. Low transmission power can be used to restrict the visibility range of advertising packets.

<br />

Constant Value: 0 (0x00000000)

## Fields

### CREATOR

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<AdvertiseSettings> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getMode

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getMode ()
```

Returns the advertise mode.

<br />

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

### getTimeout

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getTimeout ()
```

Returns the advertising time limit in milliseconds.

<br />

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

### getTxPowerLevel

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getTxPowerLevel ()
```

Returns the TX power level for advertising.

<br />

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

### isConnectable

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isConnectable ()
```

Returns whether the advertisement will indicate connectable.

<br />

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

### isDiscoverable

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isDiscoverable ()
```

Returns whether the advertisement will be discoverable.

<br />

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

### toString

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |