BleCsRangingParams

Kotlin |Java

class BleCsRangingParams : Parcelable

kotlin.Any
↳	android.ranging.ble.cs.BleCsRangingParams

BleCsRangingParams encapsulates the parameters required for a bluetooth channel sounding ranging session.

Summary

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

Constants
static Int	`LOCATION_TYPE_INDOOR` Location of the device is indoor.
static Int	`LOCATION_TYPE_OUTDOOR` Location of the device is outdoor.
static Int	`LOCATION_TYPE_UNKNOWN` Location of the device is unknown.
static Int	`SIGHT_TYPE_LINE_OF_SIGHT` Remote device is in line of sight.
static Int	`SIGHT_TYPE_NON_LINE_OF_SIGHT` Remote device is not in line of sight.
static Int	`SIGHT_TYPE_UNKNOWN` Sight type is unknown.

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()`
Int	`getLocationType()` Returns the location type for the ranging session.
String	`getPeerBluetoothAddress()` Returns the Bluetooth address of the peer device.
Int	`getRangingUpdateRate()` Returns the ranging update rate.
Int	`getSecurityLevel()` Returns the security level for the ranging session.
Int	`getSightType()` Returns the sight type for this ranging session.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

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

Constants

LOCATION_TYPE_INDOOR

Added in API level Baklava

static val LOCATION_TYPE_INDOOR: Int

Location of the device is indoor.

Value: 1

LOCATION_TYPE_OUTDOOR

Added in API level Baklava

static val LOCATION_TYPE_OUTDOOR: Int

Location of the device is outdoor.

Value: 2

LOCATION_TYPE_UNKNOWN

Added in API level Baklava

static val LOCATION_TYPE_UNKNOWN: Int

Location of the device is unknown.

Value: 0

SIGHT_TYPE_LINE_OF_SIGHT

Added in API level Baklava

static val SIGHT_TYPE_LINE_OF_SIGHT: Int

Remote device is in line of sight.

Value: 1

SIGHT_TYPE_NON_LINE_OF_SIGHT

Added in API level Baklava

static val SIGHT_TYPE_NON_LINE_OF_SIGHT: Int

Remote device is not in line of sight.

Value: 2

SIGHT_TYPE_UNKNOWN

Added in API level Baklava

static val SIGHT_TYPE_UNKNOWN: Int

Sight type is unknown.

Value: 0

Public methods

describeContents

Added in API level Baklava

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`

getLocationType

Added in API level Baklava

fun getLocationType(): Int

Returns the location type for the ranging session.

Return
`Int`	the location type. Value is `android.ranging.ble.cs.BleCsRangingParams#LOCATION_TYPE_UNKNOWN`, `android.ranging.ble.cs.BleCsRangingParams#LOCATION_TYPE_INDOOR`, or `android.ranging.ble.cs.BleCsRangingParams#LOCATION_TYPE_OUTDOOR`

getPeerBluetoothAddress

Added in API level Baklava

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 Baklava

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`

getSecurityLevel

Added in API level Baklava

fun getSecurityLevel(): Int

Returns the security level for the ranging session.

Return
`Int`	the security level Value is `android.ranging.ble.cs.BleCsRangingCapabilities#CS_SECURITY_LEVEL_ONE`, or `android.ranging.ble.cs.BleCsRangingCapabilities#CS_SECURITY_LEVEL_FOUR`

getSightType

Added in API level Baklava

fun getSightType(): Int

Returns the sight type for this ranging session.

Return
`Int`	the sight type Value is `android.ranging.ble.cs.BleCsRangingParams#SIGHT_TYPE_UNKNOWN`, `android.ranging.ble.cs.BleCsRangingParams#SIGHT_TYPE_LINE_OF_SIGHT`, or `android.ranging.ble.cs.BleCsRangingParams#SIGHT_TYPE_NON_LINE_OF_SIGHT`

writeToParcel

Added in API level Baklava

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 Baklava

static val CREATOR: Parcelable.Creator<BleCsRangingParams!>