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 individual advertisement. Use AdvertiseSettings.Builder to create an instance.

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.
int ADVERTISE_TYPE_CONNECTABLE Connectable undirected advertising type, as defined in same spec mentioned above.
int ADVERTISE_TYPE_NON_CONNECTABLE Non-connectable undirected advertising event, as defined in Bluetooth Specification V4.1 vol6, part B, section 4.4.2 - Advertising state.
int ADVERTISE_TYPE_SCANNABLE Scannable undirected advertise type, as defined in same spec mentioned above.
[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 getTxPowerLevel()
Returns the tx power level for advertising.
int getType()
Returns the advertise event type.
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

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

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

Constant Value: 2 (0x00000002)

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)

public static final int ADVERTISE_TX_POWER_HIGH

Advertise using high tx power level. This is corresponding to largest visibility range of the advertising packet.

Constant Value: 3 (0x00000003)

public static final int ADVERTISE_TX_POWER_LOW

Advertise using low tx power level.

Constant Value: 1 (0x00000001)

public static final int ADVERTISE_TX_POWER_MEDIUM

Advertise using medium tx power level.

Constant Value: 2 (0x00000002)

public static final int ADVERTISE_TX_POWER_ULTRA_LOW

Advertise using the lowest transmission(tx) power level. An app can use low transmission power to restrict the visibility range of its advertising packet.

Constant Value: 0 (0x00000000)

public static final int ADVERTISE_TYPE_CONNECTABLE

Connectable undirected advertising type, as defined in same spec mentioned above. This event type allows a scanner to send scan request asking additional information about the advertiser. It also allows an initiator to send a connect request for connection.

Constant Value: 2 (0x00000002)

public static final int ADVERTISE_TYPE_NON_CONNECTABLE

Non-connectable undirected advertising event, as defined in Bluetooth Specification V4.1 vol6, part B, section 4.4.2 - Advertising state.

Constant Value: 0 (0x00000000)

public static final int ADVERTISE_TYPE_SCANNABLE

Scannable undirected advertise type, as defined in same spec mentioned above. This event type allows a scanner to send a scan request asking additional information about the advertiser.

Constant Value: 1 (0x00000001)

Fields

public static final Creator<AdvertiseSettings> CREATOR

Public Methods

public int describeContents ()

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 ()

Returns the advertise mode.

public int getTxPowerLevel ()

Returns the tx power level for advertising.

public int getType ()

Returns the advertise event type.

public String toString ()

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)

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.