BleRssiRangingParams

Kotlin |Java

class BleRssiRangingParams : Parcelable

kotlin.Any
↳	android.ranging.ble.rssi.BleRssiRangingParams

BleRssiRangingParams encapsulates the parameters required for a bluetooth rssi based ranging session.

Summary

Nested classes
	`Builder` Builder class to create `BleRssiRangingParams` instances.

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()`
String	`getPeerBluetoothAddress()` Returns the Bluetooth address of the peer device.
Int	`getRangingUpdateRate()` Returns the ranging update rate.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<BleRssiRangingParams!>	`CREATOR`

Public methods

describeContents

Added in API level 36

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`

getPeerBluetoothAddress

Added in API level 36

fun getPeerBluetoothAddress(): String

Returns the Bluetooth address of the peer device.

Return
`String`	String representing the Bluetooth address. This value cannot be `null`.

getRangingUpdateRate

Added in API level 36

fun getRangingUpdateRate(): Int

Returns the ranging update rate.

Return
`Int`	ranging update rate. Value is `android.ranging.raw.RawRangingDevice#UPDATE_RATE_NORMAL`, `android.ranging.raw.RawRangingDevice#UPDATE_RATE_INFREQUENT`, or `android.ranging.raw.RawRangingDevice#UPDATE_RATE_FREQUENT`

writeToParcel

Added in API level 36

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

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: 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 36

static val CREATOR: Parcelable.Creator<BleRssiRangingParams!>