ResponderConfig.Builder


public static final class ResponderConfig.Builder
extends Object

java.lang.Object
   ↳ android.net.wifi.rtt.ResponderConfig.Builder


Builder class used to construct ResponderConfig objects.

Summary

Public constructors

Builder()

Public methods

ResponderConfig build()

Build ResponderConfig given the current configurations made on the builder.

ResponderConfig.Builder set80211azNtbSupported(boolean supports80211azNtb)

Sets an indication the access point can to respond to the IEEE 802.11az non-trigger based ranging protocol, but, if false, indicates only IEEE 802.11mc or one-sided Wi-Fi RTT is possible.

ResponderConfig.Builder set80211mcSupported(boolean supports80211mc)

Sets an indication the access point can to respond to the two-sided Wi-Fi RTT protocol, but, if false, indicates only one-sided Wi-Fi RTT is possible.

ResponderConfig.Builder setCenterFreq0Mhz(int centerFreq0)

Sets the center frequency in MHz of the first segment of the channel.

ResponderConfig.Builder setCenterFreq1Mhz(int centerFreq1)

Sets the center frequency in MHz of the second segment of the channel, if used.

ResponderConfig.Builder setChannelWidth(int channelWidth)

Sets the channel bandwidth in MHz.

ResponderConfig.Builder setFrequencyMhz(int frequency)

Sets the frequency of the channel in MHz.

ResponderConfig.Builder setMacAddress(MacAddress macAddress)

Sets the Responder MAC Address.

ResponderConfig.Builder setPreamble(int preamble)

Sets the preamble encoding for the protocol.

ResponderConfig.Builder setResponderType(int responderType)

Sets the responder type, can be ResponderConfig.RESPONDER_AP or ResponderConfig.RESPONDER_STA or ERROR(/#RESPONDER_AWARE)

Inherited methods

Public constructors

Builder

Added in API level 33
public Builder ()

Public methods

build

Added in API level 33
public ResponderConfig build ()

Build ResponderConfig given the current configurations made on the builder.

Returns
ResponderConfig an instance of ResponderConfig This value cannot be null.

set80211azNtbSupported

Added in API level 35
public ResponderConfig.Builder set80211azNtbSupported (boolean supports80211azNtb)

Sets an indication the access point can to respond to the IEEE 802.11az non-trigger based ranging protocol, but, if false, indicates only IEEE 802.11mc or one-sided Wi-Fi RTT is possible.

Parameters
supports80211azNtb boolean: the ability to support the IEEE 802.11az non-trigger based ranging protocol

Returns
ResponderConfig.Builder the builder to facilitate chaining builder.setXXX(..).setXXX(..). This value cannot be null.

set80211mcSupported

Added in API level 33
public ResponderConfig.Builder set80211mcSupported (boolean supports80211mc)

Sets an indication the access point can to respond to the two-sided Wi-Fi RTT protocol, but, if false, indicates only one-sided Wi-Fi RTT is possible.

Parameters
supports80211mc boolean: the ability to support the Wi-Fi RTT protocol

Returns
ResponderConfig.Builder the builder to facilitate chaining builder.setXXX(..).setXXX(..). This value cannot be null.

setCenterFreq0Mhz

Added in API level 33
public ResponderConfig.Builder setCenterFreq0Mhz (int centerFreq0)

Sets the center frequency in MHz of the first segment of the channel.

Note: The frequency is used as a hint, and the underlying WiFi subsystem may use it, or select an alternate if its own connectivity scans have determined the frequency of the access point has changed.

Parameters
centerFreq0 int: the center frequency in MHz of first channel segment Value is 0 or greater

Returns
ResponderConfig.Builder the builder to facilitate chaining builder.setXXX(..).setXXX(..). This value cannot be null.

setCenterFreq1Mhz

Added in API level 33
public ResponderConfig.Builder setCenterFreq1Mhz (int centerFreq1)

Sets the center frequency in MHz of the second segment of the channel, if used.

Note: The frequency is used as a hint, and the underlying WiFi subsystem may use it, or select an alternate if its own connectivity scans have determined the frequency of the access point has changed.

Parameters
centerFreq1 int: the center frequency in MHz of second channel segment Value is 0 or greater

Returns
ResponderConfig.Builder the builder to facilitate chaining builder.setXXX(..).setXXX(..). This value cannot be null.

setChannelWidth

Added in API level 33
public ResponderConfig.Builder setChannelWidth (int channelWidth)

Sets the channel bandwidth in MHz.

Parameters
channelWidth int: the bandwidth of the channel in MHz Value is ScanResult.CHANNEL_WIDTH_20MHZ, ScanResult.CHANNEL_WIDTH_40MHZ, ScanResult.CHANNEL_WIDTH_80MHZ, ScanResult.CHANNEL_WIDTH_160MHZ, ScanResult.CHANNEL_WIDTH_80MHZ_PLUS_MHZ, or ScanResult.CHANNEL_WIDTH_320MHZ

Returns
ResponderConfig.Builder the builder to facilitate chaining builder.setXXX(..).setXXX(..). This value cannot be null.

setFrequencyMhz

Added in API level 33
public ResponderConfig.Builder setFrequencyMhz (int frequency)

Sets the frequency of the channel in MHz.

Note: The frequency is used as a hint, and the underlying WiFi subsystem may use it, or select an alternate if its own connectivity scans have determined the frequency of the access point has changed.

Parameters
frequency int: the frequency of the channel in MHz Value is 0 or greater

Returns
ResponderConfig.Builder the builder to facilitate chaining builder.setXXX(..).setXXX(..). This value cannot be null.

setMacAddress

Added in API level 33
public ResponderConfig.Builder setMacAddress (MacAddress macAddress)

Sets the Responder MAC Address.

Parameters
macAddress MacAddress: the phyical address of the responder This value cannot be null.

Returns
ResponderConfig.Builder the builder to facilitate chaining builder.setXXX(..).setXXX(..). This value cannot be null.

setPreamble

Added in API level 33
public ResponderConfig.Builder setPreamble (int preamble)

Sets the preamble encoding for the protocol.

Parameters
preamble int: the preamble encoding Value is ScanResult.PREAMBLE_LEGACY, ScanResult.PREAMBLE_HT, ScanResult.PREAMBLE_VHT, ScanResult.PREAMBLE_HE, or ScanResult.PREAMBLE_EHT

Returns
ResponderConfig.Builder the builder to facilitate chaining builder.setXXX(..).setXXX(..). This value cannot be null.

setResponderType

Added in API level 34
public ResponderConfig.Builder setResponderType (int responderType)

Sets the responder type, can be ResponderConfig.RESPONDER_AP or ResponderConfig.RESPONDER_STA or ERROR(/#RESPONDER_AWARE)

Parameters
responderType int: the type of the responder, if not set defaults to ResponderConfig.RESPONDER_AP Value is ResponderConfig.RESPONDER_AP, 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

Returns
ResponderConfig.Builder the builder to facilitate chaining builder.setXXX(..).setXXX(..). This value cannot be null.