RangingCapabilities

Kotlin |Java

class RangingCapabilities : Parcelable

kotlin.Any
↳	android.ranging.RangingCapabilities

Represents the capabilities and availability of various ranging technologies.

The RangingCapabilities class encapsulates the status of different ranging technologies. It also allows querying the availability of other ranging technologies through a mapping of technology identifiers to availability statuses.

Summary

Constants
static Int	`DISABLED_REGULATORY` Indicates that the ranging technology is disabled due to regulatory restrictions.
static Int	`DISABLED_USER` Indicates that the ranging technology is disabled by the user.
static Int	`DISABLED_USER_RESTRICTIONS` Indicates that the ranging technology is disabled due to device usage restrictions.
static Int	`ENABLED` Indicates that the ranging technology is enabled and available for use.
static Int	`NOT_SUPPORTED` Indicates that the ranging technology is not supported on the current device.

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()`
BleCsRangingCapabilities?	`getCsCapabilities()` Gets the BLE channel sounding ranging capabilities.
RttRangingCapabilities?	`getRttRangingCapabilities()` Gets the WiFi NAN-RTT ranging capabilities.
MutableMap<Int!, Int!>	`getTechnologyAvailability()` Gets a map containing the availability of various ranging technologies.
UwbRangingCapabilities?	`getUwbCapabilities()` Gets the UWB ranging capabilities.
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

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

Constants

DISABLED_REGULATORY

Added in API level 36

static val DISABLED_REGULATORY: Int

Indicates that the ranging technology is disabled due to regulatory restrictions.

Value: 2

DISABLED_USER

Added in API level 36

static val DISABLED_USER: Int

Indicates that the ranging technology is disabled by the user.

Value: 1

DISABLED_USER_RESTRICTIONS

Added in API level 36

static val DISABLED_USER_RESTRICTIONS: Int

Indicates that the ranging technology is disabled due to device usage restrictions.

Value: 4

ENABLED

Added in API level 36

static val ENABLED: Int

Indicates that the ranging technology is enabled and available for use.

Value: 3

NOT_SUPPORTED

Added in API level 36

static val NOT_SUPPORTED: Int

Indicates that the ranging technology is not supported on the current device.

Value: 0

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`

getCsCapabilities

Added in API level 36

fun getCsCapabilities(): BleCsRangingCapabilities?

Gets the BLE channel sounding ranging capabilities.

Return
`BleCsRangingCapabilities?`	a `BleCsRangingCapabilities` object or `null` if not available.

getRttRangingCapabilities

Added in API level 36

fun getRttRangingCapabilities(): RttRangingCapabilities?

Gets the WiFi NAN-RTT ranging capabilities.

Return
`RttRangingCapabilities?`	a `RttRangingCapabilities` object or `null` if not available.

getTechnologyAvailability

Added in API level 36

fun getTechnologyAvailability(): MutableMap<Int!, Int!>

Gets a map containing the availability of various ranging technologies.

The map uses technology identifiers as keys and their respective availability statuses as values.

Return
`MutableMap<Int!, Int!>`	a `Map` with key android.ranging.RangingManager.RangingTechnology and value android.ranging.RangingCapabilities.RangingTechnologyAvailability. This value cannot be `null`.

getUwbCapabilities

Added in API level 36

fun getUwbCapabilities(): UwbRangingCapabilities?

Gets the UWB ranging capabilities.

Return
`UwbRangingCapabilities?`	a `UwbRangingCapabilities` object or `null` if not available.

toString

Added in API level 36

fun toString(): String

Return
`String`	a string representation of the object.

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<RangingCapabilities!>