Summary: Ctors | Methods | Inherited Methods

SoftApConfiguration.Builder

Kotlin |Java

public static final class SoftApConfiguration.Builder
extends Object

java.lang.Object
↳	android.net.wifi.SoftApConfiguration.Builder

Builds a SoftApConfiguration, which allows an app to configure various aspects of a Soft AP. All fields are optional. By default, SSID and BSSID are automatically chosen by the framework, and an open network is created.

Summary

Public constructors
`Builder()` Constructs a Builder with default values (see `Builder`).

Public methods
`SoftApConfiguration`	`build()` Builds the `SoftApConfiguration`.
`SoftApConfiguration.Builder`	`setChannels(SparseIntArray channels)` Specifies the channels and associated bands for the APs.

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 Android Baklava

public Builder ()

Constructs a Builder with default values (see Builder).

Public methods

build

Added in Android Baklava

public SoftApConfiguration build ()

Builds the SoftApConfiguration.

Returns
`SoftApConfiguration`	A new `SoftApConfiguration`, as configured by previous method calls. This value cannot be `null`.

setChannels

Added in Android Baklava

public SoftApConfiguration.Builder setChannels (SparseIntArray channels)

Specifies the channels and associated bands for the APs.

The API contains (band, channel) input since the 6GHz band uses the same channel numbering scheme as is used in the 2.4GHz and 5GHz band. Therefore, both are needed to uniquely identify individual channels.

Reference the Wi-Fi channel numbering and the channelization in IEEE 802.11-2016 specifications, section 17.3.8.4.2, 17.3.8.4.3 and Table 15-6.

Using the special value 0 which has the framework auto-select a valid channel from the band configured. When more than 1 channel/band is set, this will bring up concurrent APs on the requested channels and bands (if possible). Use WifiManager.isBridgedApConcurrencySupported() to determine whether concurrent APs are supported. If not set, the default value is SoftApConfiguration.BAND_2GHZ with the special channel value 0 which has the framework auto-select from SoftApConfiguration.BAND_2GHZ.

Parameters
`channels`	`SparseIntArray`: SparseIntArray (key: `#BandType` , value: channel) consists of `BAND_` and corresponding channel. This value cannot be `null`.

Returns
`SoftApConfiguration.Builder`	Builder for chaining. This value cannot be `null`.

Throws
`IllegalArgumentException`	when more than 2 channels are set or the invalid channel or band type is configured.