Added in API level 37

WifiPdRangingParams

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 for WifiPdRangingParams.
Inherited constants
Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Int

Gets the channel width.
ByteArray?

Gets the device identity key (IK).
Int

Gets the discovery channel frequency in MHz.
Int

Gets the PASN mode.
String?

Gets the password for the ranging session.
MacAddress

Gets the MAC address of the peer device.
Int

Gets the preamble type.
Int

Gets the ranging update rate.
Boolean

Returns whether the responder supports 802.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<WifiPdRangingParams!>

Public methods

describeContents

Added in API level 37
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 writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

getChannelWidth

Added in API level 37
fun getChannelWidth(): Int

Gets the channel width.

Return
Int Value is one of the following:

getDeviceIk

Added in API level 37
fun getDeviceIk(): ByteArray?

Gets the device identity key (IK).

This is used for authenticated PASN mode.

Return
ByteArray? This value may be null.

getDiscoveryChannelFrequencyMhz

Added in API level 37
fun getDiscoveryChannelFrequencyMhz(): Int

Gets the discovery channel frequency in MHz.

Return
Int Value is between 2400 and 7125 inclusive

getPasnMode

Added in API level 37
fun getPasnMode(): Int

Gets the PASN mode.

Return
Int Value is one of the following:

getPassword

Added in API level 37
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

Added in API level 37
fun getPeerMacAddress(): MacAddress

Gets the MAC address of the peer device.

Return
MacAddress This value cannot be null.

getPreambleType

Added in API level 37
fun getPreambleType(): Int

Gets the preamble type.

Return
Int Value is one of the following:

getRangingUpdateRate

Added in API level 37
fun getRangingUpdateRate(): Int

Gets the ranging update rate.

isResponder80211azNtbSupported

Added in API level 37
fun isResponder80211azNtbSupported(): Boolean

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

writeToParcel

Added in API level 37
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:

Properties

CREATOR

Added in API level 37
static val CREATOR: Parcelable.Creator<WifiPdRangingParams!>