Android APIs
public final class

AdvertiseSettings

extends Object
implements Parcelable
java.lang.Object
   ↳ android.bluetooth.le.AdvertiseSettings

Class Overview

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.
[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<AdvertiseSettings> CREATOR
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled 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.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Constants

public static final int ADVERTISE_MODE_BALANCED

Added in API level 21

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

Constant Value: 1 (0x00000001)

public static final int ADVERTISE_MODE_LOW_LATENCY

Added in API level 21

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)

public static final int ADVERTISE_MODE_LOW_POWER

Added in API level 21

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)

public static final int ADVERTISE_TX_POWER_HIGH

Added in API level 21

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

Constant Value: 3 (0x00000003)

public static final int ADVERTISE_TX_POWER_LOW

Added in API level 21

Advertise using low TX power level.

Constant Value: 1 (0x00000001)

public static final int ADVERTISE_TX_POWER_MEDIUM

Added in API level 21

Advertise using medium TX power level.

Constant Value: 2 (0x00000002)

public static final int ADVERTISE_TX_POWER_ULTRA_LOW

Added in API level 21

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

public static final Creator<AdvertiseSettings> CREATOR

Added in API level 21

Public Methods

public int describeContents ()

Added in API level 21

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public int getMode ()

Added in API level 21

Returns the advertise mode.

public int getTimeout ()

Added in API level 21

Returns the advertising time limit in milliseconds.

public int getTxPowerLevel ()

Added in API level 21

Returns the TX power level for advertising.

public boolean isConnectable ()

Added in API level 21

Returns whether the advertisement will indicate connectable.

public String toString ()

Added in API level 21

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.

public void writeToParcel (Parcel dest, int flags)

Added in API level 21

Flatten this object in to a Parcel.

Parameters
dest The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.