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.
Nested classes | |
|---|---|
class |
AdvertiseSettings.Builder
Builder class for |
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
|
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. |
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
| |
From
interface
android.os.Parcelable
| |
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)
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)
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)
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)
int ADVERTISE_TX_POWER_LOW
Advertise using low TX power level.
Constant Value: 1 (0x00000001)
int ADVERTISE_TX_POWER_MEDIUM
Advertise using medium TX power level.
Constant Value: 2 (0x00000002)
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)
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(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. |
int getTimeout ()
Returns the advertising time limit in milliseconds.
| Returns | |
|---|---|
int |
|
int getTxPowerLevel ()
Returns the TX power level for advertising.
| Returns | |
|---|---|
int |
|
boolean isConnectable ()
Returns whether the advertisement will indicate connectable.
| Returns | |
|---|---|
boolean |
|
String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
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. |
flags |
int:
Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
|
Developers