WifiPdRangingCapabilities

---

Kotlin |Java

class WifiPdRangingCapabilities : Parcelable

kotlin.Any
↳	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.

Summary

Constants
static Int	AUTHENTICATED_PASN_MODE Authenticated PASN mode.
static Int	UNAUTHENTICATED_PASN_MODE Unauthenticated PASN mode.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	describeContents()
Duration	get80211azNtbMinRangingInterval() Gets the minimum ranging interval for 802.
Duration	get80211mcMinRangingInterval() Gets the minimum ranging interval for 802.
Int	getMaxChannelWidth() Gets the maximum supported channel width.
Int	getMaxPreamble() Gets the maximum supported preamble type.
MacAddress	getProximityDetectionMacAddress() Gets the proximity detection MAC address.
MutableSet<Int!>	getSupportedDiscoveryChannelFrequenciesMhz() Gets a set of supported discovery channel frequencies in Mhz.
MutableSet<Int!>	getSupportedPasnModes() Gets a set of supported PASN modes.
Int	getTechnology()
Boolean	is80211azNtbSupported() Returns whether 802.
Boolean	is80211mcSupported() Returns whether 802.
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<WifiPdRangingCapabilities!>	CREATOR A creator for creating WifiPdRangingCapabilities from a Parcel.

Constants

AUTHENTICATED_PASN_MODE

static val AUTHENTICATED_PASN_MODE: Int

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

Value: 1

UNAUTHENTICATED_PASN_MODE

static val UNAUTHENTICATED_PASN_MODE: Int

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

Value: 0

Public methods

describeContents

fun describeContents(): Int

get80211azNtbMinRangingInterval

fun get80211azNtbMinRangingInterval(): Duration

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

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

get80211mcMinRangingInterval

fun get80211mcMinRangingInterval(): Duration

Gets the minimum ranging interval for 802.11mc based ranging.

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

getMaxChannelWidth

fun getMaxChannelWidth(): Int

Gets the maximum supported channel width.

Return
Int	The maximum supported android.net.wifi.WifiAnnotations.ChannelWidth. Value is one of the following: android.net.wifi.ScanResult#CHANNEL_WIDTH_20MHZ android.net.wifi.ScanResult#CHANNEL_WIDTH_40MHZ android.net.wifi.ScanResult#CHANNEL_WIDTH_80MHZ android.net.wifi.ScanResult#CHANNEL_WIDTH_160MHZ android.net.wifi.ScanResult#CHANNEL_WIDTH_80MHZ_PLUS_MHZ android.net.wifi.ScanResult#CHANNEL_WIDTH_320MHZ

getMaxPreamble

fun getMaxPreamble(): Int

Gets the maximum supported preamble type.

Return
Int	The maximum supported android.net.wifi.WifiAnnotations.PreambleType. Value is one of the following: android.net.wifi.ScanResult#PREAMBLE_LEGACY android.net.wifi.ScanResult#PREAMBLE_HT android.net.wifi.ScanResult#PREAMBLE_VHT android.net.wifi.ScanResult#PREAMBLE_HE android.net.wifi.ScanResult#PREAMBLE_EHT

getProximityDetectionMacAddress

fun getProximityDetectionMacAddress(): MacAddress

Gets the proximity detection MAC address.

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

getSupportedDiscoveryChannelFrequenciesMhz

fun getSupportedDiscoveryChannelFrequenciesMhz(): MutableSet<Int!>

Gets a set of supported discovery channel frequencies in Mhz.

Return
MutableSet<Int!>	a set of supported discovery channel frequencies in Mhz. Value is between 2400 and 7125 inclusive. This value cannot be null.

getSupportedPasnModes

fun getSupportedPasnModes(): MutableSet<Int!>

Gets a set of supported PASN modes.

Return
MutableSet<Int!>	an unmodifiable set of supported android.ranging.wifi.pd.WifiPdRangingCapabilities.PasnMode. Value is one of the following: UNAUTHENTICATED_PASN_MODE AUTHENTICATED_PASN_MODE . This value cannot be null.

getTechnology

fun getTechnology(): Int

Return
Int	Value is one of the following: android.ranging.RangingManager#UWB android.ranging.RangingManager#BLE_CS android.ranging.RangingManager#WIFI_NAN_RTT android.ranging.RangingManager#BLE_RSSI android.ranging.RangingManager#WIFI_STA_RTT android.ranging.RangingManager#WIFI_PD

is80211azNtbSupported

fun is80211azNtbSupported(): Boolean

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

Return
Boolean	true if 802.11az NTB is supported, false otherwise.

is80211mcSupported

fun is80211mcSupported(): Boolean

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

Return
Boolean	true if 802.11mc is supported, false otherwise.

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: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

static val CREATOR: Parcelable.Creator<WifiPdRangingCapabilities!>

A creator for creating WifiPdRangingCapabilities from a Parcel.