Added in API level 36

Summary: Inherited Constants | Fields | Methods | Inherited Methods

UwbRangingCapabilities

Kotlin |Java

public final class UwbRangingCapabilities
extends Object implements Parcelable

java.lang.Object
↳	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

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<UwbRangingCapabilities>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`Duration`	`getMinimumRangingInterval()` Gets the minimum supported ranging interval.
`List<Integer>`	`getSupportedAntennaModes()` Gets the list of supported antenna modes.
`List<Integer>`	`getSupportedChannels()` Gets the list of supported UWB channels.
`List<Integer>`	`getSupportedConfigIds()` Gets the list of supported configuration IDs.
`List<Integer>`	`getSupportedNotificationConfigurations()` Gets the list of supported notification configurations.
`List<Integer>`	`getSupportedPreambleIndexes()` Gets the list of supported preamble indexes.
`List<Integer>`	`getSupportedRangingUpdateRates()` Gets the list of supported ranging update rates.
`List<Integer>`	`getSupportedSlotDurations()` Gets the list of supported slot durations in microseconds.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isAzimuthalAngleSupported()` Checks if the device hardware supports azimuthal angle measurement.
`boolean`	`isBackgroundRangingSupported()` Checks if background ranging is supported.
`boolean`	`isDistanceMeasurementSupported()` Checks if the device supports distance measurement.
`boolean`	`isDlTdoaSupported()` Whether Downlink time difference of arrival (DL-TDOA) is supported.
`boolean`	`isElevationAngleSupported()` Checks if the device hardware supports elevation angle measurement.
`boolean`	`isRangingIntervalReconfigurationSupported()` Checks if the ranging interval can be reconfigured.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 36

public static final Creator<UwbRangingCapabilities> CREATOR

Public methods

describeContents

Added in API level 36

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(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`

equals

Added in API level 36

public boolean equals (Object o)

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 return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

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
`o`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getMinimumRangingInterval

Added in API level 36

public Duration getMinimumRangingInterval ()

Gets the minimum supported ranging interval.

Returns
`Duration`	the minimum ranging interval. This value cannot be `null`.

getSupportedAntennaModes

Added in API level 37

public List<Integer> getSupportedAntennaModes ()

Gets the list of supported antenna modes.

Returns
`List<Integer>`	a list of supported antenna modes. This value cannot be `null`. Value is one of the following: `SessionConfig.ANTENNA_MODE_OMNI` `SessionConfig.ANTENNA_MODE_DIRECTIONAL`

getSupportedChannels

Added in API level 36

public List<Integer> getSupportedChannels ()

Gets the list of supported UWB channels.

Returns
`List<Integer>`	a list of supported channel numbers. This value cannot be `null`.

getSupportedConfigIds

Added in API level 36

public List<Integer> getSupportedConfigIds ()

Gets the list of supported configuration IDs.

Returns
`List<Integer>`	a list of supported configuration IDs. This value cannot be `null`.

getSupportedNotificationConfigurations

Added in API level 36

public List<Integer> getSupportedNotificationConfigurations ()

Gets the list of supported notification configurations.

Returns
`List<Integer>`	a list of supported notification configuration type. This value cannot be `null`. Value is one of the following: `DataNotificationConfig.NOTIFICATION_CONFIG_DISABLE` `DataNotificationConfig.NOTIFICATION_CONFIG_ENABLE` `DataNotificationConfig.NOTIFICATION_CONFIG_PROXIMITY_LEVEL` `DataNotificationConfig.NOTIFICATION_CONFIG_PROXIMITY_EDGE`

getSupportedPreambleIndexes

Added in API level 36

public List<Integer> getSupportedPreambleIndexes ()

Gets the list of supported preamble indexes.

Returns
`List<Integer>`	a list of supported preamble indexes. This value cannot be `null`.

getSupportedRangingUpdateRates

Added in API level 36

public List<Integer> getSupportedRangingUpdateRates ()

Gets the list of supported ranging update rates.

Returns
`List<Integer>`	a list of supported update rates. This value cannot be `null`.

getSupportedSlotDurations

Added in API level 36

public List<Integer> getSupportedSlotDurations ()

Gets the list of supported slot durations in microseconds.

Returns
`List<Integer>`	a list of supported slot durations. This value cannot be `null`. Value is one of the following: `UwbRangingParams.DURATION_1_MS` `UwbRangingParams.DURATION_2_MS`

hashCode

Added in API level 36

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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 hashCode method must consistently return the same integer, provided no information used in equals comparisons 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 equals method, then calling the hashCode method 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 equals method, then calling the hashCode method 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.

Returns
`int`	a hash code value for this object.

isAzimuthalAngleSupported

Added in API level 36

public boolean isAzimuthalAngleSupported ()

Checks if the device hardware supports azimuthal angle measurement.

Returns
`boolean`	`true` if azimuthal angle measurement is supported; `false` otherwise.

isBackgroundRangingSupported

Added in API level 36

public boolean isBackgroundRangingSupported ()

Checks if background ranging is supported.

Returns
`boolean`	`true` if background ranging is supported; `false` otherwise.

isDistanceMeasurementSupported

Added in API level 36

public boolean isDistanceMeasurementSupported ()

Checks if the device supports distance measurement.

Returns
`boolean`	`true` if distance measurement is supported; `false` otherwise.

isDlTdoaSupported

Added in API level 37

public boolean isDlTdoaSupported ()

Whether Downlink time difference of arrival (DL-TDOA) is supported.

Returns
`boolean`	true if DL-TDOA is supported.

isElevationAngleSupported

Added in API level 36

public boolean isElevationAngleSupported ()

Checks if the device hardware supports elevation angle measurement.

Returns
`boolean`	`true` if elevation angle measurement is supported; `false` otherwise.

isRangingIntervalReconfigurationSupported

Added in API level 36

public boolean isRangingIntervalReconfigurationSupported ()

Checks if the ranging interval can be reconfigured.

Returns
`boolean`	`true` if the interval is configurable; `false` otherwise.

toString

Added in API level 36

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 36

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 the following: `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`