Added in API level 21

AdvertiseSettings

Kotlin |Java

public final class AdvertiseSettings
extends Object implements Parcelable

java.lang.Object
↳	android.bluetooth.le.AdvertiseSettings

The AdvertiseSettings provide a way to adjust advertising preferences for each Bluetooth LE advertisement instance. Use AdvertiseSettings.Builder to create an instance of this class.

Summary

Nested classes
`class`	`AdvertiseSettings.Builder` Builder class for `AdvertiseSettings`.

Constants
`int`	`ADVERTISE_MODE_BALANCED` Perform Bluetooth LE advertising in balanced power mode.
`int`	`ADVERTISE_MODE_LOW_LATENCY` Perform Bluetooth LE advertising in low latency, high power mode.
`int`	`ADVERTISE_MODE_LOW_POWER` Perform Bluetooth LE advertising in low power mode.
`int`	`ADVERTISE_TX_POWER_HIGH` Advertise using high TX power level.
`int`	`ADVERTISE_TX_POWER_LOW` Advertise using low TX power level.
`int`	`ADVERTISE_TX_POWER_MEDIUM` Advertise using medium TX power level.
`int`	`ADVERTISE_TX_POWER_ULTRA_LOW` Advertise using the lowest transmission (TX) power level.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: 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 Creator<AdvertiseSettings>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getMode()` Returns the advertise mode.
`int`	`getTimeout()` Returns the advertising time limit in milliseconds.
`int`	`getTxPowerLevel()` Returns the TX power level for advertising.
`boolean`	`isConnectable()` Returns whether the advertisement will indicate connectable.
`boolean`	`isDiscoverable()` Returns whether the advertisement will be discoverable.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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`	`wait(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`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

ADVERTISE_MODE_BALANCED

Added in API level 21

public static final int ADVERTISE_MODE_BALANCED

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

Constant Value: 1 (0x00000001)

ADVERTISE_MODE_LOW_LATENCY

Added in API level 21

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.

Constant Value: 2 (0x00000002)

ADVERTISE_MODE_LOW_POWER

Added in API level 21

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.

Constant Value: 0 (0x00000000)

ADVERTISE_TX_POWER_HIGH

Added in API level 21

public static final int ADVERTISE_TX_POWER_HIGH

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

Constant Value: 3 (0x00000003)

ADVERTISE_TX_POWER_LOW

Added in API level 21

public static final int ADVERTISE_TX_POWER_LOW

Advertise using low TX power level.

Constant Value: 1 (0x00000001)

ADVERTISE_TX_POWER_MEDIUM

Added in API level 21

public static final int ADVERTISE_TX_POWER_MEDIUM

Advertise using medium TX power level.

Constant Value: 2 (0x00000002)

ADVERTISE_TX_POWER_ULTRA_LOW

Added in API level 21

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.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 21

public static final Creator<AdvertiseSettings> CREATOR

Public methods

describeContents

Added in API level 21

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 writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getMode

Added in API level 21

public int getMode ()

Returns the advertise mode.

Returns
`int`

getTimeout

Added in API level 21

public int getTimeout ()

Returns the advertising time limit in milliseconds.

Returns
`int`

getTxPowerLevel

Added in API level 21

public int getTxPowerLevel ()

Returns the TX power level for advertising.

Returns
`int`

isConnectable

Added in API level 21

public boolean isConnectable ()

Returns whether the advertisement will indicate connectable.

Returns
`boolean`

isDiscoverable

Added in API level 34

public boolean isDiscoverable ()

Returns whether the advertisement will be discoverable.

Returns
`boolean`

toString

Added in API level 21

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 21

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

AdvertiseSettings

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

ADVERTISE_MODE_BALANCED

ADVERTISE_MODE_LOW_LATENCY

ADVERTISE_MODE_LOW_POWER

ADVERTISE_TX_POWER_HIGH

ADVERTISE_TX_POWER_LOW

ADVERTISE_TX_POWER_MEDIUM

ADVERTISE_TX_POWER_ULTRA_LOW

Fields

CREATOR

Public methods

describeContents

getMode

getTimeout

getTxPowerLevel

isConnectable

isDiscoverable

toString

writeToParcel