RangingCapabilities
public final class RangingCapabilities
extends Object implements Parcelable
| java.lang.Object | |
| ↳ | 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 | |
|---|---|
int | DISABLED_REGULATORY Indicates that the ranging technology is disabled due to regulatory restrictions. |
int | DISABLED_USER Indicates that the ranging technology is disabled by the user. |
int | DISABLED_USER_RESTRICTIONS Indicates that the ranging technology is disabled due to device usage restrictions. |
int | ENABLED Indicates that the ranging technology is enabled and available for use. |
int | NOT_SUPPORTED Indicates that the ranging technology is not supported on the current device. |
Inherited constants |
|---|
Fields | |
|---|---|
public static final Creator<RangingCapabilities> | CREATOR
|
Public methods | |
|---|---|
int | describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
BleCsRangingCapabilities | getCsCapabilities() Gets the BLE channel sounding ranging capabilities. |
RttRangingCapabilities | getRttRangingCapabilities() Gets the WiFi NAN-RTT ranging capabilities. |
Map<Integer, Integer> | getTechnologyAvailability() Gets a map containing the availability of various ranging technologies. |
UwbRangingCapabilities | getUwbCapabilities() Gets the UWB ranging capabilities. |
String | toString() Returns a string representation of the object. |
void | writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Constants
DISABLED_REGULATORY
public static final int DISABLED_REGULATORY
Indicates that the ranging technology is disabled due to regulatory restrictions.
Constant Value: 2 (0x00000002)
DISABLED_USER
public static final int DISABLED_USER
Indicates that the ranging technology is disabled by the user.
Constant Value: 1 (0x00000001)
DISABLED_USER_RESTRICTIONS
public static final int DISABLED_USER_RESTRICTIONS
Indicates that the ranging technology is disabled due to device usage restrictions.
Constant Value: 4 (0x00000004)
ENABLED
public static final int ENABLED
Indicates that the ranging technology is enabled and available for use.
Constant Value: 3 (0x00000003)
NOT_SUPPORTED
public static final int NOT_SUPPORTED
Indicates that the ranging technology is not supported on the current device.
Constant Value: 0 (0x00000000)
Fields
Public methods
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Returns | |
|---|---|
int | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
getCsCapabilities
public BleCsRangingCapabilities getCsCapabilities ()
Gets the BLE channel sounding ranging capabilities.
| Returns | |
|---|---|
BleCsRangingCapabilities | a BleCsRangingCapabilities object or null if not available. |
getRttRangingCapabilities
public RttRangingCapabilities getRttRangingCapabilities ()
Gets the WiFi NAN-RTT ranging capabilities.
| Returns | |
|---|---|
RttRangingCapabilities | a RttRangingCapabilities object or null if not available. |
getTechnologyAvailability
public Map<Integer, Integer> getTechnologyAvailability ()
Gets a map containing the availability of various ranging technologies.
The map uses technology identifiers as keys and their respective availability statuses as values.
| Returns | |
|---|---|
Map<Integer, Integer> | a Map with key ERROR(RangingTechnology/android.ranging.RangingManager.RangingTechnology RangingTechnology) and value ERROR(RangingTechnologyAvailability/android.ranging.RangingCapabilities.RangingTechnologyAvailability RangingTechnologyAvailability). This value cannot be null. |
getUwbCapabilities
public UwbRangingCapabilities getUwbCapabilities ()
Gets the UWB ranging capabilities.
| Returns | |
|---|---|
UwbRangingCapabilities | a UwbRangingCapabilities object or null if not available. |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String | a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |