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 | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Duration |
Gets the minimum supported ranging interval. |
| MutableList<Int!> |
Gets the list of supported antenna modes. |
| 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. |
| Int |
hashCode()Returns a hash code value for the object. |
| 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 |
Whether Downlink time difference of arrival (DL-TDOA) is supported. |
| Boolean |
Checks if the device hardware supports elevation angle measurement. |
| Boolean |
Checks if the ranging interval can be reconfigured. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<UwbRangingCapabilities!> | |
Public methods
describeContents
fun describeContents(): Int
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(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getMinimumRangingInterval
fun getMinimumRangingInterval(): Duration
Gets the minimum supported ranging interval.
| Return | |
|---|---|
Duration |
the minimum ranging interval. This value cannot be null. |
getSupportedAntennaModes
fun getSupportedAntennaModes(): MutableList<Int!>
Gets the list of supported antenna modes.
| Return | |
|---|---|
MutableList<Int!> |
a list of supported antenna modes. This value cannot be null. Value is one of the following: |
getSupportedChannels
fun getSupportedChannels(): MutableList<Int!>
Gets the list of supported UWB channels.
| Return | |
|---|---|
MutableList<Int!> |
a list of supported channel numbers. This value cannot be null. |
getSupportedConfigIds
fun getSupportedConfigIds(): MutableList<Int!>
Gets the list of supported configuration IDs.
| Return | |
|---|---|
MutableList<Int!> |
a list of supported configuration IDs. This value cannot be null. |
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 one of the following: |
getSupportedPreambleIndexes
fun getSupportedPreambleIndexes(): MutableList<Int!>
Gets the list of supported preamble indexes.
| Return | |
|---|---|
MutableList<Int!> |
a list of supported preamble indexes. This value cannot be null. |
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. |
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 one of the following: |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Return | |
|---|---|
Int |
a hash code value for this object. |
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. |
isDlTdoaSupported
fun isDlTdoaSupported(): Boolean
Whether Downlink time difference of arrival (DL-TDOA) is supported.
| Return | |
|---|---|
Boolean |
true if DL-TDOA is supported. |
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
Returns a string representation of the object.
| 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 the following:
|