WifiPdRangingParams

---

Kotlin |Java

class WifiPdRangingParams : Parcelable

kotlin.Any
↳	android.ranging.wifi.pd.WifiPdRangingParams

Defines the parameters for Wi-Fi Proximity Detection (PD) ranging.

These parameters are used to configure a Wi-Fi PD ranging session. This includes specifying the peer device's MAC address, discovery channel, ranging role, and security credentials.

Summary

Nested classes
	Builder Builder for WifiPdRangingParams.

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()
Int	getChannelWidth() Gets the channel width.
ByteArray?	getDeviceIk() Gets the device identity key (IK).
Int	getDiscoveryChannelFrequencyMhz() Gets the discovery channel frequency in MHz.
Int	getPasnMode() Gets the PASN mode.
String?	getPassword() Gets the password for the ranging session.
MacAddress	getPeerMacAddress() Gets the MAC address of the peer device.
Int	getPreambleType() Gets the preamble type.
Int	getRangingUpdateRate() Gets the ranging update rate.
Boolean	isResponder80211azNtbSupported() Returns whether the responder supports 802.
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<WifiPdRangingParams!>	CREATOR

Public methods

describeContents

fun describeContents(): Int

getChannelWidth

fun getChannelWidth(): Int

Gets the channel width.

Return
Int	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

getDeviceIk

fun getDeviceIk(): ByteArray?

Gets the device identity key (IK).

This is used for authenticated PASN mode.

Return
ByteArray?	This value may be null.

getDiscoveryChannelFrequencyMhz

fun getDiscoveryChannelFrequencyMhz(): Int

Gets the discovery channel frequency in MHz.

Return
Int	Value is between 2400 and 7125 inclusive

getPasnMode

fun getPasnMode(): Int

Gets the PASN mode.

Return
Int	Value is one of the following: android.ranging.wifi.pd.WifiPdRangingCapabilities#UNAUTHENTICATED_PASN_MODE android.ranging.wifi.pd.WifiPdRangingCapabilities#AUTHENTICATED_PASN_MODE

getPassword

fun getPassword(): String?

Gets the password for the ranging session.

This is used for authenticated PASN mode.

Return
String?	This value may be null.

getPeerMacAddress

fun getPeerMacAddress(): MacAddress

Gets the MAC address of the peer device.

Return
MacAddress	This value cannot be null.

getPreambleType

fun getPreambleType(): Int

Gets the preamble type.

Return
Int	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

getRangingUpdateRate

fun getRangingUpdateRate(): Int

Gets the ranging update rate.

Return
Int	Value is one of the following: android.ranging.raw.RawRangingDevice#UPDATE_RATE_NORMAL android.ranging.raw.RawRangingDevice#UPDATE_RATE_INFREQUENT android.ranging.raw.RawRangingDevice#UPDATE_RATE_FREQUENT

isResponder80211azNtbSupported

fun isResponder80211azNtbSupported(): Boolean

Returns whether the responder supports 802.11az NTB (Next Generation Trigger-Based).

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<WifiPdRangingParams!>