Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

WifiPdRangingCapabilities

---

Kotlin |Java

public final class WifiPdRangingCapabilities
extends Object implements Parcelable

java.lang.Object
↳	android.ranging.wifi.pd.WifiPdRangingCapabilities

---

The ranging capabilities for Wi-Fi Proximity Detection (PD).

This class defines the ranging capabilities for Wi-Fi PD, which allows devices to measure the distance to each other using Wi-Fi signals. These capabilities include supported PASN modes, channel widths, preamble types, and discovery channels.

See also:

• ERROR(RangingManager.getRangingCapabilities()/android.ranging.RangingManager#getRangingCapabilities() RangingManager.getRangingCapabilities())

Summary

Constants
int	AUTHENTICATED_PASN_MODE Authenticated PASN mode.
int	UNAUTHENTICATED_PASN_MODE Unauthenticated PASN mode.

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<WifiPdRangingCapabilities>	CREATOR A creator for creating WifiPdRangingCapabilities from a Parcel.

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Duration	get80211azNtbMinRangingInterval() Gets the minimum ranging interval for 802.11az NTB based ranging.
Duration	get80211mcMinRangingInterval() Gets the minimum ranging interval for 802.11mc based ranging.
int	getMaxChannelWidth() Gets the maximum supported channel width.
int	getMaxPreamble() Gets the maximum supported preamble type.
MacAddress	getProximityDetectionMacAddress() Gets the proximity detection MAC address.
Set<Integer>	getSupportedDiscoveryChannelFrequenciesMhz() Gets a set of supported discovery channel frequencies in Mhz.
Set<Integer>	getSupportedPasnModes() Gets a set of supported PASN modes.
int	getTechnology()
boolean	is80211azNtbSupported() Returns whether 802.11az NTB (Next Generation Trigger-Based) is supported.
boolean	is80211mcSupported() Returns whether 802.11mc (Wi-Fi Round Trip Time) is supported.
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.

Constants

AUTHENTICATED_PASN_MODE

public static final int AUTHENTICATED_PASN_MODE

Authenticated PASN mode. In this mode, ranging is performed over a secure link established using a password.

Constant Value: 1 (0x00000001)

UNAUTHENTICATED_PASN_MODE

public static final int UNAUTHENTICATED_PASN_MODE

Unauthenticated PASN mode. In this mode, ranging is performed without establishing a secure link.

Constant Value: 0 (0x00000000)

Fields

CREATOR

public static final Creator<WifiPdRangingCapabilities> CREATOR

A creator for creating WifiPdRangingCapabilities from a Parcel.

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

get80211azNtbMinRangingInterval

public Duration get80211azNtbMinRangingInterval ()

Gets the minimum ranging interval for 802.11az NTB based ranging.

Returns
Duration	Duration The ranging interval for 802.11az NTB. This value cannot be null.

get80211mcMinRangingInterval

public Duration get80211mcMinRangingInterval ()

Gets the minimum ranging interval for 802.11mc based ranging.

Returns
Duration	Duration The minimum ranging interval for 802.11mc. This value cannot be null.

getMaxChannelWidth

public int getMaxChannelWidth ()

Gets the maximum supported channel width.

Returns
int	The maximum supported ERROR(WifiAnnotations.ChannelWidth/android.net.wifi.WifiAnnotations.ChannelWidth WifiAnnotations.ChannelWidth). Value is one of the following: ScanResult.CHANNEL_WIDTH_20MHZ ScanResult.CHANNEL_WIDTH_40MHZ ScanResult.CHANNEL_WIDTH_80MHZ ScanResult.CHANNEL_WIDTH_160MHZ ScanResult.CHANNEL_WIDTH_80MHZ_PLUS_MHZ ScanResult.CHANNEL_WIDTH_320MHZ

getMaxPreamble

public int getMaxPreamble ()

Gets the maximum supported preamble type.

Returns
int	The maximum supported ERROR(WifiAnnotations.PreambleType/android.net.wifi.WifiAnnotations.PreambleType WifiAnnotations.PreambleType). Value is one of the following: ScanResult.PREAMBLE_LEGACY ScanResult.PREAMBLE_HT ScanResult.PREAMBLE_VHT ScanResult.PREAMBLE_HE ScanResult.PREAMBLE_EHT

getProximityDetectionMacAddress

public MacAddress getProximityDetectionMacAddress ()

Gets the proximity detection MAC address.

Returns
MacAddress	a byte array representing the MAC address. This value cannot be null.

getSupportedDiscoveryChannelFrequenciesMhz

public Set<Integer> getSupportedDiscoveryChannelFrequenciesMhz ()

Gets a set of supported discovery channel frequencies in Mhz.

Returns
Set<Integer>	a set of supported discovery channel frequencies in Mhz. Value is between 2400 and 7125 inclusive. This value cannot be null.

getSupportedPasnModes

public Set<Integer> getSupportedPasnModes ()

Gets a set of supported PASN modes.

Returns
Set<Integer>	an unmodifiable set of supported ERROR(PasnMode/android.ranging.wifi.pd.WifiPdRangingCapabilities.PasnMode PasnMode). Value is one of the following: UNAUTHENTICATED_PASN_MODE AUTHENTICATED_PASN_MODE . This value cannot be null.

getTechnology

public int getTechnology ()

Returns
int	Value is one of the following: RangingManager.UWB RangingManager.BLE_CS RangingManager.WIFI_NAN_RTT RangingManager.BLE_RSSI RangingManager.WIFI_STA_RTT RangingManager.WIFI_PD

is80211azNtbSupported

public boolean is80211azNtbSupported ()

Returns whether 802.11az NTB (Next Generation Trigger-Based) is supported.

Returns
boolean	true if 802.11az NTB is supported, false otherwise.

is80211mcSupported

public boolean is80211mcSupported ()

Returns whether 802.11mc (Wi-Fi Round Trip Time) is supported.

Returns
boolean	true if 802.11mc is supported, false otherwise.

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