RangingCapabilities


class RangingCapabilities : Parcelable

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

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

static Int

Indicates that the ranging technology is disabled by the user.

static Int

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

static Int

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

static Int

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

Inherited constants
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

BleCsRangingCapabilities?

Gets the BLE channel sounding ranging capabilities.

RttRangingCapabilities?

Gets the WiFi NAN-RTT ranging capabilities.

MutableMap<Int!, Int!>

Gets a map containing the availability of various ranging technologies.

UwbRangingCapabilities?

Gets the UWB ranging capabilities.

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Constants

DISABLED_REGULATORY

static val DISABLED_REGULATORY: Int

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

Value: 2

DISABLED_USER

static val DISABLED_USER: Int

Indicates that the ranging technology is disabled by the user.

Value: 1

DISABLED_USER_RESTRICTIONS

static val DISABLED_USER_RESTRICTIONS: Int

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

Value: 4

ENABLED

static val ENABLED: Int

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

Value: 3

NOT_SUPPORTED

static val NOT_SUPPORTED: Int

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

Value: 0

Public methods

describeContents

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

fun getCsCapabilities(): BleCsRangingCapabilities?

Gets the BLE channel sounding ranging capabilities.

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

getRttRangingCapabilities

fun getRttRangingCapabilities(): RttRangingCapabilities?

Gets the WiFi NAN-RTT ranging capabilities.

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

getTechnologyAvailability

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

fun getUwbCapabilities(): UwbRangingCapabilities?

Gets the UWB ranging capabilities.

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

toString

fun toString(): String
Return
String a string representation of the object.

writeToParcel

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

static val CREATOR: Parcelable.Creator<RangingCapabilities!>