Added in API level 26

PeriodicAdvertisingParameters

---

Kotlin |Java

class PeriodicAdvertisingParameters : Parcelable

kotlin.Any
↳	android.bluetooth.le.PeriodicAdvertisingParameters

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

Summary

Nested classes
	Builder

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	describeContents()
Boolean	getIncludeTxPower() Returns whether the TX Power will be included.
Int	getInterval() Returns the periodic advertising interval, in 1.
Unit	writeToParcel(dest: Parcel, flags: Int)

Properties
static Parcelable.Creator<PeriodicAdvertisingParameters!>!	CREATOR

Public methods

describeContents

Added in API level 26

fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

getIncludeTxPower

Added in API level 26

fun getIncludeTxPower(): Boolean

Returns whether the TX Power will be included.

getInterval

Added in API level 26

fun getInterval(): Int

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

writeToParcel

Added in API level 26

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 26

static val CREATOR: Parcelable.Creator<PeriodicAdvertisingParameters!>!