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

# AdvertisingSetParameters

*** ** * ** ***


`
public

final

class
AdvertisingSetParameters
`


`

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.AdvertisingSetParameters |

<br />

*** ** * ** ***

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

## Summary

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

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#INTERVAL_HIGH` Advertise on low frequency, around every 1000ms. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#INTERVAL_LOW` Perform high frequency, low latency advertising, around every 100ms. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#INTERVAL_MAX` Maximum value for advertising interval. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#INTERVAL_MEDIUM` Advertise on medium frequency, around every 250ms. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#INTERVAL_MIN` Minimum value for advertising interval. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#TX_POWER_HIGH` Advertise using high TX power level. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#TX_POWER_LOW` Advertise using low TX power level. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#TX_POWER_MAX` *This constant was deprecated in API level 37. Use `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#TX_POWER_MAX_AVAILABLE`* |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#TX_POWER_MAX_AVAILABLE` Use the maximum available power for TX. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#TX_POWER_MEDIUM` Advertise using medium TX power level. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#TX_POWER_MIN` Minimum value for TX power. |
| `int` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#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/AdvertisingSetParameters>` | `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#getInterval()() ` Returns the advertising interval. |
| ` int` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#getPrimaryPhy()() ` Returns the primary advertising phy. |
| ` int` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#getSecondaryPhy()() ` Returns the secondary advertising phy. |
| ` int` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#getTxPowerLevel()() ` Returns the TX power level for advertising. |
| ` boolean` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#includeTxPower()() ` Returns whether the TX Power will be included. |
| ` boolean` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#isAnonymous()() ` Returns whether the advertisement will be anonymous. |
| ` boolean` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#isConnectable()() ` Returns whether the advertisement will be connectable. |
| ` boolean` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#isDiscoverable()() ` Returns whether the advertisement will be discoverable. |
| ` boolean` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#isLegacy()() ` Returns whether the legacy advertisement will be used. |
| ` boolean` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#isScannable()() ` Returns whether the advertisement will be scannable. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#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

### INTERVAL_HIGH

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

```
public static final int INTERVAL_HIGH
```

Advertise on low frequency, around every 1000ms. This is the default and preferred
advertising mode as it consumes the least power.

<br />

Constant Value:

1600
(0x00000640)


### INTERVAL_LOW

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

```
public static final int INTERVAL_LOW
```

Perform high frequency, low latency advertising, around every 100ms. This has the highest
power consumption and should not be used for continuous background advertising.

<br />

Constant Value:

160
(0x000000a0)


### INTERVAL_MAX

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

```
public static final int INTERVAL_MAX
```

Maximum value for advertising interval.

<br />

Constant Value:

16777215
(0x00ffffff)


### INTERVAL_MEDIUM

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

```
public static final int INTERVAL_MEDIUM
```

Advertise on medium frequency, around every 250ms. This is balanced between advertising
frequency and power consumption.

<br />

Constant Value:

400
(0x00000190)


### INTERVAL_MIN

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

```
public static final int INTERVAL_MIN
```

Minimum value for advertising interval.

<br />

Constant Value:

160
(0x000000a0)


### TX_POWER_HIGH

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

```
public static final int TX_POWER_HIGH
```

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

<br />

Constant Value:

1
(0x00000001)


### TX_POWER_LOW

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

```
public static final int TX_POWER_LOW
```

Advertise using low TX power level.

<br />

Constant Value:

-15
(0xfffffff1)


### TX_POWER_MAX

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

```
public static final int TX_POWER_MAX
```


**This constant was deprecated
in API level 37.**   

Use `https://developer.android.com/reference/android/bluetooth/le/AdvertisingSetParameters#TX_POWER_MAX_AVAILABLE`

Maximum value for TX power.

<br />

Constant Value:

1
(0x00000001)


### TX_POWER_MAX_AVAILABLE

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

```
public static final int TX_POWER_MAX_AVAILABLE
```

Use the maximum available power for TX.

<br />

Constant Value:

20
(0x00000014)


### TX_POWER_MEDIUM

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

```
public static final int TX_POWER_MEDIUM
```

Advertise using medium TX power level.

<br />

Constant Value:

-7
(0xfffffff9)


### TX_POWER_MIN

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

```
public static final int TX_POWER_MIN
```

Minimum value for TX power.

<br />

Constant Value:

-127
(0xffffff81)


### TX_POWER_ULTRA_LOW

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

```
public static final int 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:

-21
(0xffffffeb)


## Fields

### CREATOR

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

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

<br />

<br />

## Public methods

### describeContents

Added in [API level 26](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` |

### getInterval

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

```
public int getInterval ()
```

Returns the advertising interval.

<br />

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

### getPrimaryPhy

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

```
public int getPrimaryPhy ()
```

Returns the primary advertising phy.

<br />

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

### getSecondaryPhy

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

```
public int getSecondaryPhy ()
```

Returns the secondary advertising phy.

<br />

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

### getTxPowerLevel

Added in [API level 26](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 /> |

### includeTxPower

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

```
public boolean includeTxPower ()
```

Returns whether the TX Power will be included.

<br />

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

### isAnonymous

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

```
public boolean isAnonymous ()
```

Returns whether the advertisement will be anonymous.

<br />

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

### isConnectable

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

```
public boolean isConnectable ()
```

Returns whether the advertisement will be 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 /> |

### isLegacy

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

```
public boolean isLegacy ()
```

Returns whether the legacy advertisement will be used.

<br />

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

### isScannable

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

```
public boolean isScannable ()
```

Returns whether the advertisement will be scannable.

<br />

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

### toString

Added in [API level 26](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 26](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` |