Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

PeriodicAdvertisingParameters

public final class PeriodicAdvertisingParameters
extends Object implements Parcelable

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


The PeriodicAdvertisingParameters provide a way to adjust periodic advertising preferences for each Bluetooth LE advertising set. Use AdvertisingSetParameters.Builder to create an instance of this class.

Summary

Nested classes

class PeriodicAdvertisingParameters.Builder

 

Inherited constants

Fields

public static final Creator<PeriodicAdvertisingParameters> CREATOR

Public methods

int describeContents()

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

boolean getIncludeTxPower()

Returns whether the TX Power will be included.

int getInterval()

Returns the periodic advertising interval, in 1.25ms unit.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

added in API level 26
public static final Creator<PeriodicAdvertisingParameters> CREATOR

Public methods

describeContents

added in API level 26
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(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.

getIncludeTxPower

added in API level 26
public boolean getIncludeTxPower ()

Returns whether the TX Power will be included.

Returns
boolean

getInterval

added in API level 26
public int getInterval ()

Returns the periodic advertising interval, in 1.25ms unit. Valid values are from 80 (100ms) to 65519 (81.89875s).

Returns
int

writeToParcel

added in API level 26
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.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.