ResponderConfig
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 class used to construct |
Constants | |
---|---|
static Int |
Responder is an access point(AP). |
static Int |
Responder is a client device(STA). |
Inherited constants | |
---|---|
Public methods | |
---|---|
Int | |
Boolean |
Indicates whether some other object is "equal to" this one. |
static ResponderConfig |
fromScanResult(scanResult: ScanResult) Creates a Responder configuration from a |
Int |
If the Access Point (AP) bandwidth is 20 MHz, 0 MHz is returned. |
Int |
If the Access Point (AP) bandwidth is 80 80 MHz, this param is not used and returns 0. |
Int |
AP Channel bandwidth; one of |
Int | |
MacAddress? | |
Int |
Get the preamble type of the channel. |
Int |
Get responder type. |
Int |
hashCode() |
Boolean | |
Boolean | |
String |
toString() |
Unit |
writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel. |
Properties | |
---|---|
static Parcelable.Creator<ResponderConfig!> |
Constants
RESPONDER_AP
static val RESPONDER_AP: Int
Responder is an access point(AP).
Value: 0
RESPONDER_STA
static val RESPONDER_STA: Int
Responder is a client device(STA).
Value: 1
Public methods
describeContents
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
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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
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
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
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
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
fun getFrequencyMhz(): Int
Return | |
---|---|
Int |
the frequency in MHz of the Wi-Fi channel Value is 0 or greater |
getMacAddress
fun getMacAddress(): MacAddress?
Return | |
---|---|
MacAddress? |
the MAC address of the responder This value may be null . |
getPreamble
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
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 |
is80211azNtbSupported
fun is80211azNtbSupported(): Boolean
Return | |
---|---|
Boolean |
true if the Responder supports the 802.11az non-trigger based ranging protocol, false otherwise. |
is80211mcSupported
fun is80211mcSupported(): Boolean
Return | |
---|---|
Boolean |
true if the Responder supports the 802.11mc protocol, false otherwise. |
toString
fun toString(): String
Return | |
---|---|
String |
a string representation of the object. |
writeToParcel
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 |