Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#nestedclasses) \| [Inherited Constants](https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#inhconstants) \| [Fields](https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#lfields) \| [Methods](https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#inhmethods)

# WifiPdRangingParams

*** ** * ** ***


`
public

final

class
WifiPdRangingParams
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.ranging.wifi.pd.WifiPdRangingParams |

<br />

*** ** * ** ***

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

- `https://developer.android.com/`

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams.Builder` Builder for `https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams`. |

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams>` | `https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#getChannelWidth()() ` Gets the channel width. |
| ` byte[]` | ` https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#getDeviceIk()() ` Gets the device identity key (IK). |
| ` int` | ` https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#getDiscoveryChannelFrequencyMhz()() ` Gets the discovery channel frequency in MHz. |
| ` int` | ` https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#getPasnMode()() ` Gets the PASN mode. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#getPassword()() ` Gets the password for the ranging session. |
| ` https://developer.android.com/reference/android/net/MacAddress` | ` https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#getPeerMacAddress()() ` Gets the MAC address of the peer device. |
| ` int` | ` https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#getPreambleType()() ` Gets the preamble type. |
| ` int` | ` https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#getRangingUpdateRate()() ` Gets the ranging update rate. |
| ` boolean` | ` https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#isResponder80211azNtbSupported()() ` Returns whether the responder supports 802.11az NTB (Next Generation Trigger-Based). |
| ` void` | ` https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingParams#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/android/os/Parcelable ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. | ||

## Fields

### CREATOR

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<WifiPdRangingParams> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getChannelWidth

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getChannelWidth ()
```

Gets the channel width.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/net/wifi/ScanResult#CHANNEL_WIDTH_20MHZ` - `https://developer.android.com/reference/android/net/wifi/ScanResult#CHANNEL_WIDTH_40MHZ` - `https://developer.android.com/reference/android/net/wifi/ScanResult#CHANNEL_WIDTH_80MHZ` - `https://developer.android.com/reference/android/net/wifi/ScanResult#CHANNEL_WIDTH_160MHZ` - `https://developer.android.com/reference/android/net/wifi/ScanResult#CHANNEL_WIDTH_80MHZ_PLUS_MHZ` - `https://developer.android.com/reference/android/net/wifi/ScanResult#CHANNEL_WIDTH_320MHZ` |

### getDeviceIk

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public byte[] getDeviceIk ()
```

Gets the device identity key (IK).

This is used for authenticated PASN mode.

<br />

| Returns ||
|---|---|
| `byte[]` | This value may be `null`. <br /> |

### getDiscoveryChannelFrequencyMhz

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getDiscoveryChannelFrequencyMhz ()
```

Gets the discovery channel frequency in MHz.

<br />

| Returns ||
|---|---|
| `int` | Value is between 2400 and 7125 inclusive <br /> |

### getPasnMode

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getPasnMode ()
```

Gets the PASN mode.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingCapabilities#UNAUTHENTICATED_PASN_MODE` - `https://developer.android.com/reference/android/ranging/wifi/pd/WifiPdRangingCapabilities#AUTHENTICATED_PASN_MODE` |

### getPassword

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getPassword ()
```

Gets the password for the ranging session.

This is used for authenticated PASN mode.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value may be `null`. <br /> |

### getPeerMacAddress

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public MacAddress getPeerMacAddress ()
```

Gets the MAC address of the peer device.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/net/MacAddress` | This value cannot be `null`. <br /> |

### getPreambleType

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getPreambleType ()
```

Gets the preamble type.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/net/wifi/ScanResult#PREAMBLE_LEGACY` - `https://developer.android.com/reference/android/net/wifi/ScanResult#PREAMBLE_HT` - `https://developer.android.com/reference/android/net/wifi/ScanResult#PREAMBLE_VHT` - `https://developer.android.com/reference/android/net/wifi/ScanResult#PREAMBLE_HE` - `https://developer.android.com/reference/android/net/wifi/ScanResult#PREAMBLE_EHT` |

### getRangingUpdateRate

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getRangingUpdateRate ()
```

Gets the ranging update rate.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### isResponder80211azNtbSupported

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isResponder80211azNtbSupported ()
```

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

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### writeToParcel

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |