Added in API level 33

Summary: Ctors | Methods | Inherited Methods

ResponderConfig.Builder

Kotlin |Java

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()` Default constructor for the Builder.
`Builder(ResponderConfig config)` Creates a new Builder instance, initializing it with the values from an existing `ResponderConfig` object.

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`	`setPeerHandle(PeerHandle peerHandle)` Sets the Responder Aware Peer handle.
`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)`
`ResponderConfig.Builder`	`setSecureRangingConfig(SecureRangingConfig secureRangingConfig)` Set secure ranging configuration.
`ResponderConfig.Builder`	`setUsdPeerId(int peerId)` Sets the USD peer ID.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

Added in API level 33

public Builder ()

Default constructor for the Builder.

Builder

Added in API level 33

public Builder (ResponderConfig config)

Creates a new Builder instance, initializing it with the values from an existing ResponderConfig object. This allows for easy modification of an existing configuration.

Parameters
`config`	`ResponderConfig`: The ResponderConfig instance to copy values from. This value cannot be `null`.

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.

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 one of the following: `ScanResult.CHANNEL_WIDTH_20MHZ` `ScanResult.CHANNEL_WIDTH_40MHZ` `ScanResult.CHANNEL_WIDTH_80MHZ` `ScanResult.CHANNEL_WIDTH_160MHZ` `ScanResult.CHANNEL_WIDTH_80MHZ_PLUS_MHZ` `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.

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.

A responder must be identified by either a MacAddress or a PeerHandle (for Aware peers, set via setPeerHandle(android.net.wifi.aware.PeerHandle)), but not both.

Note: This method sets the MAC address. If a PeerHandle was previously set using setPeerHandle(android.net.wifi.aware.PeerHandle), both identifiers might be temporarily present within the builder. The final validation ensuring that only one of these identifiers is exclusively set occurs during the build() operation. If build() is called when both a MAC address and a PeerHandle are configured or when neither is set, it will result in an IllegalArgumentException.

Parameters
`macAddress`	`MacAddress`: the physical address of the responder. This value may be `null`.

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

setPeerHandle

Added in API level 33

public ResponderConfig.Builder setPeerHandle (PeerHandle peerHandle)

Sets the Responder Aware Peer handle.

Use this method to identify the responder when it is a Wi-Fi Aware peer. The PeerHandle is a unique identifier for an Aware peer obtained through Wi-Fi Aware discovery processes.

A responder must be identified by either a PeerHandle (for Aware peers) or a MacAddress (for non-Aware peers like Access Points or Wi-Fi Direct devices), but not both.

Note: This method sets the peer handle. If a MAC address was previously set using setMacAddress(android.net.MacAddress), both identifiers might be temporarily present within the builder. The final validation ensuring that only one of these identifiers is exclusively set occurs during the build() operation. If build() is called when both a MAC address and a PeerHandle are configured or when neither is set, it will result in an IllegalArgumentException.

Parameters
`peerHandle`	`PeerHandle`: Peer handle of the responder. This value may 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 one of the following: `ScanResult.PREAMBLE_LEGACY` `ScanResult.PREAMBLE_HT` `ScanResult.PREAMBLE_VHT` `ScanResult.PREAMBLE_HE` `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 one of the following: `ResponderConfig.RESPONDER_AP` `ResponderConfig.RESPONDER_STA`

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

setSecureRangingConfig

Added in API level 36

public ResponderConfig.Builder setSecureRangingConfig (SecureRangingConfig secureRangingConfig)

Set secure ranging configuration. See SecureRangingConfig for more details.

Note: Secure ranging will get enabled only if the device and responder support. For device support see WifiRttManager.getRttCharacteristics(). Following capabilities needs to be enabled,

For the responder support (from scan result),

ScanResult.capabilities string contains PASN and optionally a base AKM
ScanResult.isSecureHeLtfSupported()
ScanResult.isRangingFrameProtectionRequired()

Parameters
`secureRangingConfig`	`SecureRangingConfig`: Secure ranging configuration. This value cannot be `null`.

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

setUsdPeerId

Added in API level 33

public ResponderConfig.Builder setUsdPeerId (int peerId)

Sets the USD peer ID.

Use this method to identify the peer when the peer is discovered over USD channel. The peer id is a unique identifier for an USD peer obtained through Wi-Fi USD discovery processes (See obtained from ERROR(DiscoveryResult.getPeerId()/android.net.wifi.usd.DiscoveryResult#getPeerId() DiscoveryResult.getPeerId()).

Parameters
`peerId`	`int`: Peer ID of the USD peer

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