UwbRangingCapabilities
class UwbRangingCapabilities : Parcelable
| kotlin.Any | |
| ↳ | android.ranging.uwb.UwbRangingCapabilities |
Represents the capabilities of Ultra-Wideband (UWB) ranging technology.
This class encapsulates various UWB-related features, including support for specific measurement types (e.g., distance, azimuth, elevation), ranging configurations, and operational parameters like update rates and channel availability.
Summary
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Duration |
Gets the minimum supported ranging interval. |
| MutableList<Int!> |
Gets the list of supported UWB channels. |
| MutableList<Int!> |
Gets the list of supported configuration IDs. |
| MutableList<Int!> |
Gets the list of supported notification configurations. |
| MutableList<Int!> |
Gets the list of supported preamble indexes. |
| MutableList<Int!> |
Gets the list of supported ranging update rates. |
| MutableList<Int!> |
Gets the list of supported slot durations in microseconds. |
| Boolean |
Checks if the device hardware supports azimuthal angle measurement. |
| Boolean |
Checks if background ranging is supported. |
| Boolean |
Checks if the device supports distance measurement. |
| Boolean |
Checks if the device hardware supports elevation angle measurement. |
| Boolean |
Checks if the ranging interval can be reconfigured. |
| String |
toString() |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<UwbRangingCapabilities!> | |
Public methods
getMinimumRangingInterval
fun getMinimumRangingInterval(): Duration
Gets the minimum supported ranging interval.
| Return | |
|---|---|
Duration |
the minimum ranging interval. This value cannot be null. |
getSupportedChannels
fun getSupportedChannels(): MutableList<Int!>
Gets the list of supported UWB channels.
getSupportedConfigIds
fun getSupportedConfigIds(): MutableList<Int!>
Gets the list of supported configuration IDs.
getSupportedNotificationConfigurations
fun getSupportedNotificationConfigurations(): MutableList<Int!>
Gets the list of supported notification configurations.
| Return | |
|---|---|
MutableList<Int!> |
a list of supported notification configuration type. This value cannot be null. Value is android.ranging.DataNotificationConfig#NOTIFICATION_CONFIG_DISABLE, android.ranging.DataNotificationConfig#NOTIFICATION_CONFIG_ENABLE, android.ranging.DataNotificationConfig#NOTIFICATION_CONFIG_PROXIMITY_LEVEL, or android.ranging.DataNotificationConfig#NOTIFICATION_CONFIG_PROXIMITY_EDGE |
getSupportedPreambleIndexes
fun getSupportedPreambleIndexes(): MutableList<Int!>
Gets the list of supported preamble indexes.
getSupportedRangingUpdateRates
fun getSupportedRangingUpdateRates(): MutableList<Int!>
Gets the list of supported ranging update rates.
| Return | |
|---|---|
MutableList<Int!> |
a list of supported update rates. This value cannot be null. Value is android.ranging.raw.RawRangingDevice#UPDATE_RATE_NORMAL, android.ranging.raw.RawRangingDevice#UPDATE_RATE_INFREQUENT, or android.ranging.raw.RawRangingDevice#UPDATE_RATE_FREQUENT |
getSupportedSlotDurations
fun getSupportedSlotDurations(): MutableList<Int!>
Gets the list of supported slot durations in microseconds.
| Return | |
|---|---|
MutableList<Int!> |
a list of supported slot durations. This value cannot be null. Value is android.ranging.uwb.UwbRangingParams#DURATION_1_MS, or android.ranging.uwb.UwbRangingParams#DURATION_2_MS |
isAzimuthalAngleSupported
fun isAzimuthalAngleSupported(): Boolean
Checks if the device hardware supports azimuthal angle measurement.
| Return | |
|---|---|
Boolean |
true if azimuthal angle measurement is supported; false otherwise. |
isBackgroundRangingSupported
fun isBackgroundRangingSupported(): Boolean
Checks if background ranging is supported.
| Return | |
|---|---|
Boolean |
true if background ranging is supported; false otherwise. |
isDistanceMeasurementSupported
fun isDistanceMeasurementSupported(): Boolean
Checks if the device supports distance measurement.
| Return | |
|---|---|
Boolean |
true if distance measurement is supported; false otherwise. |
isElevationAngleSupported
fun isElevationAngleSupported(): Boolean
Checks if the device hardware supports elevation angle measurement.
| Return | |
|---|---|
Boolean |
true if elevation angle measurement is supported; false otherwise. |
isRangingIntervalReconfigurationSupported
fun isRangingIntervalReconfigurationSupported(): Boolean
Checks if the ranging interval can be reconfigured.
| Return | |
|---|---|
Boolean |
true if the interval is configurable; false otherwise. |
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 |