Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

WifiPdRangingParams

---

Kotlin |Java

public final class WifiPdRangingParams
extends Object implements Parcelable

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

See also:

• ERROR(RangingSession.start(RangingConfig,RangingSession.Callback)/android.ranging.RangingSession#start(android.ranging.RangingConfig,android.ranging.RangingSession.Callback) RangingSession.start(RangingConfig,RangingSession.Callback))

Summary

Nested classes
class	WifiPdRangingParams.Builder Builder for WifiPdRangingParams.

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

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
int	getChannelWidth() Gets the channel width.
byte[]	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.11az NTB (Next Generation Trigger-Based).
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

public static final Creator<WifiPdRangingParams> CREATOR

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

getChannelWidth

public int getChannelWidth ()

Gets the channel width.

Returns
int	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

getDeviceIk

public byte[] getDeviceIk ()

Gets the device identity key (IK).

This is used for authenticated PASN mode.

Returns
byte[]	This value may be null.

getDiscoveryChannelFrequencyMhz

public int getDiscoveryChannelFrequencyMhz ()

Gets the discovery channel frequency in MHz.

Returns
int	Value is between 2400 and 7125 inclusive

getPasnMode

public int getPasnMode ()

Gets the PASN mode.

Returns
int	Value is one of the following: WifiPdRangingCapabilities.UNAUTHENTICATED_PASN_MODE WifiPdRangingCapabilities.AUTHENTICATED_PASN_MODE

getPassword

public String getPassword ()

Gets the password for the ranging session.

This is used for authenticated PASN mode.

Returns
String	This value may be null.

getPeerMacAddress

public MacAddress getPeerMacAddress ()

Gets the MAC address of the peer device.

Returns
MacAddress	This value cannot be null.

getPreambleType

public int getPreambleType ()

Gets the preamble type.

Returns
int	Value is one of the following: ScanResult.PREAMBLE_LEGACY ScanResult.PREAMBLE_HT ScanResult.PREAMBLE_VHT ScanResult.PREAMBLE_HE ScanResult.PREAMBLE_EHT

getRangingUpdateRate

public int getRangingUpdateRate ()

Gets the ranging update rate.

Returns
int	Value is one of the following: RawRangingDevice.UPDATE_RATE_NORMAL RawRangingDevice.UPDATE_RATE_INFREQUENT RawRangingDevice.UPDATE_RATE_FREQUENT

isResponder80211azNtbSupported

public boolean isResponder80211azNtbSupported ()

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

Returns
boolean

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