ResponderConfig

Kotlin |Java

class ResponderConfig : Parcelable

kotlin.Any
↳	android.net.wifi.rtt.ResponderConfig

Defines the configuration of an IEEE 802.11mc Responder. The Responder may be an Access Point (AP), a Wi-Fi Aware device, or a manually configured Responder.

A Responder configuration may be constructed from a ScanResult or manually (with the data obtained out-of-band from a peer).

Summary

Nested classes
	`Builder` Builder class used to construct `ResponderConfig` objects.

Constants
static Int	`RESPONDER_AP` Responder is an access point(AP).
static Int	`RESPONDER_STA` Responder is a client device(STA).

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()`
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
static ResponderConfig	`fromScanResult(scanResult: ScanResult)` Creates a Responder configuration from a `ScanResult` corresponding to an Access Point (AP), which can be obtained from `android.net.wifi.WifiManager#getScanResults()`.
Int	`getCenterFreq0Mhz()` If the Access Point (AP) bandwidth is 20 MHz, 0 MHz is returned.
Int	`getCenterFreq1Mhz()` If the Access Point (AP) bandwidth is 80 + 80 MHz, this param is not used and returns 0.
Int	`getChannelWidth()` AP Channel bandwidth; one of `ScanResult.CHANNEL_WIDTH_20MHZ`, `ScanResult.CHANNEL_WIDTH_40MHZ`, `ScanResult.CHANNEL_WIDTH_80MHZ`, `ScanResult.CHANNEL_WIDTH_160MHZ`, `CHANNEL_WIDTH_80MHZ_PLUS_MHZ` or `ScanResult.CHANNEL_WIDTH_320MHZ`.
Int	`getFrequencyMhz()`
MacAddress?	`getMacAddress()`
Int	`getPreamble()` Get the preamble type of the channel.
Int	`getResponderType()` Get responder type.
SecureRangingConfig?	`getSecureRangingConfig()` Get secure ranging configuration.
Int	`hashCode()`
Boolean	`is80211azNtbSupported()`
Boolean	`is80211mcSupported()`
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<ResponderConfig!>	`CREATOR`

Constants

RESPONDER_AP

Added in API level 34

static val RESPONDER_AP: Int

Responder is an access point(AP).

Value: 0

RESPONDER_STA

Added in API level 34

static val RESPONDER_STA: Int

Responder is a client device(STA).

Value: 1

Public methods

describeContents

Added in API level 33

fun describeContents(): Int

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

equals

Added in API level 33

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.
`o`	This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

fromScanResult

Added in API level 33

static fun fromScanResult(scanResult: ScanResult): ResponderConfig

Creates a Responder configuration from a ScanResult corresponding to an Access Point (AP), which can be obtained from android.net.wifi.WifiManager#getScanResults().

Parameters
`scanResult`	ScanResult: This value cannot be `null`.

Return
`ResponderConfig`	This value cannot be `null`.

getCenterFreq0Mhz

Added in API level 33

fun getCenterFreq0Mhz(): Int

If the Access Point (AP) bandwidth is 20 MHz, 0 MHz is returned. If the AP use 40, 80 or 160 MHz, this is the center frequency (in MHz). if the AP uses 80 + 80 MHz, this is the center frequency of the first segment (in MHz).

Return
`Int`	the center frequency in MHz of the first channel segment Value is 0 or greater

getCenterFreq1Mhz

Added in API level 33

fun getCenterFreq1Mhz(): Int

If the Access Point (AP) bandwidth is 80 + 80 MHz, this param is not used and returns 0. If the AP uses 80 + 80 MHz, this is the center frequency of the second segment in MHz.

Return
`Int`	the center frequency in MHz of the second channel segment (if used) Value is 0 or greater

getChannelWidth

Added in API level 33

fun getChannelWidth(): Int

AP Channel bandwidth; one of ScanResult.CHANNEL_WIDTH_20MHZ, ScanResult.CHANNEL_WIDTH_40MHZ, ScanResult.CHANNEL_WIDTH_80MHZ, ScanResult.CHANNEL_WIDTH_160MHZ, CHANNEL_WIDTH_80MHZ_PLUS_MHZ or ScanResult.CHANNEL_WIDTH_320MHZ.

Return
`Int`	the bandwidth repsentation of the Wi-Fi channel Value is `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`, or `android.net.wifi.ScanResult#CHANNEL_WIDTH_320MHZ`

getFrequencyMhz

Added in API level 33

fun getFrequencyMhz(): Int

Return
`Int`	the frequency in MHz of the Wi-Fi channel Value is 0 or greater

getMacAddress

Added in API level 33

fun getMacAddress(): MacAddress?

Return
`MacAddress?`	the MAC address of the responder This value may be `null`.

getPreamble

Added in API level 33

fun getPreamble(): Int

Get the preamble type of the channel.

Return
`Int`	the preamble used for this channel Value is `android.net.wifi.ScanResult#PREAMBLE_LEGACY`, `android.net.wifi.ScanResult#PREAMBLE_HT`, `android.net.wifi.ScanResult#PREAMBLE_VHT`, `android.net.wifi.ScanResult#PREAMBLE_HE`, or `android.net.wifi.ScanResult#PREAMBLE_EHT`

getResponderType

Added in API level 34

fun getResponderType(): Int

Get responder type.

Return
`Int`	The type of this responder Value is `android.net.wifi.rtt.ResponderConfig#RESPONDER_AP`, `android.net.wifi.rtt.ResponderConfig#RESPONDER_STA`, android.net.wifi.rtt.ResponderConfig.RESPONDER_P2P_GO, android.net.wifi.rtt.ResponderConfig.RESPONDER_P2P_CLIENT, or android.net.wifi.rtt.ResponderConfig.RESPONDER_AWARE

See Also

android.net.wifi.rtt.ResponderConfig.Builder#setResponderType(int)

getSecureRangingConfig

Added in API level Baklava

fun getSecureRangingConfig(): SecureRangingConfig?

Get secure ranging configuration.

Return
`SecureRangingConfig?`	Secure ranging configuration. Returns null for non-secure ranging configuration.

hashCode

Added in API level 33

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

is80211azNtbSupported

Added in API level 35

fun is80211azNtbSupported(): Boolean

Return
`Boolean`	true if the Responder supports the 802.11az non-trigger based ranging protocol, false otherwise.

is80211mcSupported

Added in API level 33

fun is80211mcSupported(): Boolean

Return
`Boolean`	true if the Responder supports the 802.11mc protocol, false otherwise.

toString

Added in API level 33

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 33

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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 33

static val CREATOR: Parcelable.Creator<ResponderConfig!>