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.
`Duration`	`getMinimumRangingInterval()` Gets the minimum supported ranging interval.
`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.
`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`	`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(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`

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

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`. Value is one of the following: `UwbComplexChannel.UWB_CHANNEL_5` `UwbComplexChannel.UWB_CHANNEL_6` `UwbComplexChannel.UWB_CHANNEL_8` `UwbComplexChannel.UWB_CHANNEL_9` `UwbComplexChannel.UWB_CHANNEL_10` `UwbComplexChannel.UWB_CHANNEL_12` `UwbComplexChannel.UWB_CHANNEL_13` `UwbComplexChannel.UWB_CHANNEL_14`

getSupportedConfigIds

Added in API level 36

public List<Integer> getSupportedConfigIds ()

Gets the list of supported configuration IDs.

Returns

Returns
`List<Integer>`	a list of supported configuration IDs. This value cannot be `null`. Value is one of the following: `UwbRangingParams.CONFIG_UNICAST_DS_TWR` `UwbRangingParams.CONFIG_MULTICAST_DS_TWR` `UwbRangingParams.CONFIG_PROVISIONED_UNICAST_DS_TWR` `UwbRangingParams.CONFIG_PROVISIONED_MULTICAST_DS_TWR` `UwbRangingParams.CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR` `UwbRangingParams.CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST`

List<Integer>

a list of supported configuration IDs.
This value cannot be null.
Value is one of the following:

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

Returns
`List<Integer>`	a list of supported preamble indexes. This value cannot be `null`. Value is one of the following: `UwbComplexChannel.UWB_PREAMBLE_CODE_INDEX_9` `UwbComplexChannel.UWB_PREAMBLE_CODE_INDEX_10` `UwbComplexChannel.UWB_PREAMBLE_CODE_INDEX_11` `UwbComplexChannel.UWB_PREAMBLE_CODE_INDEX_12` `UwbComplexChannel.UWB_PREAMBLE_CODE_INDEX_25` `UwbComplexChannel.UWB_PREAMBLE_CODE_INDEX_26` `UwbComplexChannel.UWB_PREAMBLE_CODE_INDEX_27` `UwbComplexChannel.UWB_PREAMBLE_CODE_INDEX_28` `UwbComplexChannel.UWB_PREAMBLE_CODE_INDEX_29` `UwbComplexChannel.UWB_PREAMBLE_CODE_INDEX_30` `UwbComplexChannel.UWB_PREAMBLE_CODE_INDEX_31` `UwbComplexChannel.UWB_PREAMBLE_CODE_INDEX_32`

List<Integer>

a list of supported preamble indexes.
This value cannot be null.
Value is one of the following:

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`. Value is one of the following: `RawRangingDevice.UPDATE_RATE_NORMAL` `RawRangingDevice.UPDATE_RATE_INFREQUENT` `RawRangingDevice.UPDATE_RATE_FREQUENT`

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`

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.

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`