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

# WifiPdRangingCapabilities

*** ** * ** ***

```
class WifiPdRangingCapabilities : Parcelable
```

|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||
| ↳ | [android.ranging.wifi.pd.WifiPdRangingCapabilities](https://developer.android.com/reference/kotlin/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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#AUTHENTICATED_PASN_MODE:kotlin.Int` Authenticated PASN mode. |
| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#UNAUTHENTICATED_PASN_MODE:kotlin.Int` Unauthenticated PASN mode. |

Inherited constants From class `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#` `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int`


Descriptor bit used with `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.

<br />

`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int`


Flag for use with `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#writeToParcel(android.os.Parcel,%20kotlin.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)`". Some implementations may want to release resources at this point.

<br />

| Public methods ||
|---|---|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#describeContents()()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#equals(kotlin.Any)(other: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?)` Indicates whether some other object is "equal to" this one. |
| [Duration](https://developer.android.com/reference/kotlin/java/time/Duration.html#) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#get80211azNtbMinRangingInterval()()` Gets the minimum ranging interval for 802. |
| [Duration](https://developer.android.com/reference/kotlin/java/time/Duration.html#) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#get80211mcMinRangingInterval()()` Gets the minimum ranging interval for 802. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#getMaxChannelWidth()()` Gets the maximum supported channel width. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#getMaxPreamble()()` Gets the maximum supported preamble type. |
| [MacAddress](https://developer.android.com/reference/kotlin/android/net/MacAddress.html#) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#getProximityDetectionMacAddress()()` Gets the proximity detection MAC address. |
| [MutableSet](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html)\<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)!\> | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#getSupportedDiscoveryChannelFrequenciesMhz()()` Gets a set of supported discovery channel frequencies in Mhz. |
| [MutableSet](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html)\<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)!\> | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#getSupportedPasnModes()()` Gets a set of supported PASN modes. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#getTechnology()()` <br /> |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#hashCode()()` Returns a hash code value for the object. |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#is80211azNtbSupported()()` Returns whether 802. |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#is80211mcSupported()()` Returns whether 802. |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#toString()()` Returns a string representation of the object. |
| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#writeToParcel(android.os.Parcel,%20kotlin.Int)(dest: https://developer.android.com/reference/kotlin/android/os/Parcel.html#, flags: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Flatten this object in to a Parcel. |

| Properties ||
|---|---|
| static [Parcelable.Creator](https://developer.android.com/reference/kotlin/android/os/Parcelable.Creator.html#)\<[WifiPdRangingCapabilities](https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#)!\> | `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#CREATOR:android.os.Parcelable.Creator` A creator for creating `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#` from a `https://developer.android.com/reference/kotlin/android/os/Parcel.html#`. |

## Constants

### AUTHENTICATED_PASN_MODE

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

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

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

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

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

```
fun describeContents(): Int
```

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

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | 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/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int` |

### equals

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

```
fun equals(other: Any?): Boolean
```

Indicates whether some other object is "equal to" this one.

The `equals` method implements an equivalence relation on non-null object references:

- It is *reflexive* : for any non-null reference value `x`, `x.equals(x)` should return `true`.
- It is *symmetric* : for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
- It is *transitive* : for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
- It is *consistent* : for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
- For any non-null reference value `x`, `x.equals(null)` should return `false`.

An equivalence relation partitions the elements it operates on into *equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

| Parameters ||
|---|---|
| `obj` | the reference object with which to compare. |

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `true` if this object is the same as the obj argument; `false` otherwise. |

### get80211azNtbMinRangingInterval

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

```
fun get80211azNtbMinRangingInterval(): Duration
```

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

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/java/time/Duration.html#` | `https://developer.android.com/reference/kotlin/java/time/Duration.html#` The ranging interval for 802.11az NTB. This value cannot be `null`. |

### get80211mcMinRangingInterval

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

```
fun get80211mcMinRangingInterval(): Duration
```

Gets the minimum ranging interval for 802.11mc based ranging.

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/java/time/Duration.html#` | `https://developer.android.com/reference/kotlin/java/time/Duration.html#` The minimum ranging interval for 802.11mc. This value cannot be `null`. |

### getMaxChannelWidth

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

```
fun getMaxChannelWidth(): Int
```

Gets the maximum supported channel width.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | The maximum supported android.net.wifi.WifiAnnotations.ChannelWidth. Value is one of the following: - `https://developer.android.com/reference/kotlin/android/net/wifi/ScanResult.html#CHANNEL_WIDTH_20MHZ:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/net/wifi/ScanResult.html#CHANNEL_WIDTH_40MHZ:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/net/wifi/ScanResult.html#CHANNEL_WIDTH_80MHZ:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/net/wifi/ScanResult.html#CHANNEL_WIDTH_160MHZ:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/net/wifi/ScanResult.html#CHANNEL_WIDTH_80MHZ_PLUS_MHZ:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/net/wifi/ScanResult.html#CHANNEL_WIDTH_320MHZ:kotlin.Int` |

### getMaxPreamble

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

```
fun getMaxPreamble(): Int
```

Gets the maximum supported preamble type.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | The maximum supported android.net.wifi.WifiAnnotations.PreambleType. Value is one of the following: - `https://developer.android.com/reference/kotlin/android/net/wifi/ScanResult.html#PREAMBLE_LEGACY:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/net/wifi/ScanResult.html#PREAMBLE_HT:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/net/wifi/ScanResult.html#PREAMBLE_VHT:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/net/wifi/ScanResult.html#PREAMBLE_HE:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/net/wifi/ScanResult.html#PREAMBLE_EHT:kotlin.Int` |

### getProximityDetectionMacAddress

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

```
fun getProximityDetectionMacAddress(): MacAddress
```

Gets the proximity detection MAC address.

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/net/MacAddress.html#` | a byte array representing the MAC address. This value cannot be `null`. |

### getSupportedDiscoveryChannelFrequenciesMhz

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

```
fun getSupportedDiscoveryChannelFrequenciesMhz(): MutableSet<Int!>
```

Gets a set of supported discovery channel frequencies in Mhz.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html!>` | a set of supported discovery channel frequencies in Mhz. Value is between 2400 and 7125 inclusive. This value cannot be `null`. |

### getSupportedPasnModes

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

```
fun getSupportedPasnModes(): MutableSet<Int!>
```

Gets a set of supported PASN modes.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html!>` | an unmodifiable set of supported android.ranging.wifi.pd.WifiPdRangingCapabilities.PasnMode. Value is one of the following: - `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#UNAUTHENTICATED_PASN_MODE:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#AUTHENTICATED_PASN_MODE:kotlin.Int` . This value cannot be `null`. |

### getTechnology

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

```
fun getTechnology(): Int
```

### hashCode

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

```
fun hashCode(): Int
```

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `https://developer.android.com/reference/kotlin/java/util/HashMap.html#`.

The general contract of `hashCode` is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `https://developer.android.com/reference/kotlin/java/lang/Object.html#equals(kotlin.Any)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/kotlin/java/lang/Object.html#equals(kotlin.Any)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | a hash code value for this object. |

### is80211azNtbSupported

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

```
fun is80211azNtbSupported(): Boolean
```

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

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `true` if 802.11az NTB is supported, `false` otherwise. |

### is80211mcSupported

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

```
fun is80211mcSupported(): Boolean
```

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

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `true` if 802.11mc is supported, `false` otherwise. |

### toString

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

```
fun toString(): String
```

Returns a string representation of the object.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | a string representation of the object. |

### writeToParcel

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

```
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit
```

Flatten this object in to a Parcel.

| Parameters ||
|---|---|
| `dest` | [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html#): This value cannot be `null`. |
| `flags` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int` |

## Properties

### CREATOR

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

```
static val CREATOR: Parcelable.Creator<WifiPdRangingCapabilities!>
```

A creator for creating `https://developer.android.com/reference/kotlin/android/ranging/wifi/pd/WifiPdRangingCapabilities#` from a `https://developer.android.com/reference/kotlin/android/os/Parcel.html#`.