Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#nestedclasses) \| [Constants](https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#constants) \| [Inherited Constants](https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#inhconstants) \| [Fields](https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#lfields) \| [Methods](https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#inhmethods)

# SoftApConfiguration

*** ** * ** ***

` public final class SoftApConfiguration `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.net.wifi.SoftApConfiguration |

<br />

*** ** * ** ***

Configuration for a soft access point (a.k.a. Soft AP, SAP, Hotspot).

This is input for the framework provided by a client app, i.e. it exposes knobs to instruct the framework how it should configure a hotspot.

System apps can use this to configure a tethered hotspot or local-only hotspot.

Instances of this class are immutable.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration.Builder` Builds a `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration`, which allows an app to configure various aspects of a Soft AP. |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#BAND_2GHZ` 2GHz band. |
| `int` | `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#BAND_5GHZ` 5GHz band. |
| `int` | `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#BAND_60GHZ` 60GHz band. |
| `int` | `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#BAND_6GHZ` 6GHz band. |
| `int` | `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_OPEN` THe definition of security type OPEN. |
| `int` | `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA2_PSK` The definition of security type WPA2-PSK. |
| `int` | `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA3_OWE` The definition of security type WPA3-OWE. |
| `int` | `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA3_OWE_TRANSITION` The definition of security type WPA3-OWE Transition. |
| `int` | `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA3_SAE` The definition of security type WPA3-SAE. |
| `int` | `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA3_SAE_TRANSITION` The definition of security type WPA3-SAE Transition mode. |

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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)`".

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/net/wifi/SoftApConfiguration>` | `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#CREATOR` <br /> |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object otherObj) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/android/net/MacAddress` | ` https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#getBssid()() ` Returns MAC address set to be BSSID for the AP. |
| ` https://developer.android.com/reference/android/util/SparseIntArray` | ` https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#getChannels()() ` Returns SparseIntArray (key: `BandType` , value: channel) that consists of the configured bands and channels for the AP(s). |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#getPassphrase()() ` Returns String set to be passphrase for current AP. |
| ` int` | ` https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#getSecurityType()() ` Get security type params which depends on which security passphrase to set. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#getSsid()() ` *This method was deprecated in API level 33. Use `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#getWifiSsid()` instead.* |
| ` https://developer.android.com/reference/android/net/wifi/WifiSsid` | ` https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#getWifiSsid()() ` Return WifiSsid set to be the SSID for the AP. |
| ` int` | ` https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#hashCode()() ` Returns a hash code value for the object. |
| ` boolean` | ` https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#isHiddenSsid()() ` Returns Boolean set to be indicate hidden (true: doesn't broadcast its SSID) or not (false: broadcasts its SSID) for the AP. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Constants

### BAND_2GHZ

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int BAND_2GHZ
```

2GHz band.

<br />

Constant Value: 1 (0x00000001)

### BAND_5GHZ

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int BAND_5GHZ
```

5GHz band.

<br />

Constant Value: 2 (0x00000002)

### BAND_60GHZ

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int BAND_60GHZ
```

60GHz band.

<br />

Constant Value: 8 (0x00000008)

### BAND_6GHZ

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int BAND_6GHZ
```

6GHz band.

<br />

Constant Value: 4 (0x00000004)

### SECURITY_TYPE_OPEN

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SECURITY_TYPE_OPEN
```

THe definition of security type OPEN.

<br />

Constant Value: 0 (0x00000000)

### SECURITY_TYPE_WPA2_PSK

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SECURITY_TYPE_WPA2_PSK
```

The definition of security type WPA2-PSK.

<br />

Constant Value: 1 (0x00000001)

### SECURITY_TYPE_WPA3_OWE

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SECURITY_TYPE_WPA3_OWE
```

The definition of security type WPA3-OWE.

<br />

Constant Value: 5 (0x00000005)

### SECURITY_TYPE_WPA3_OWE_TRANSITION

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SECURITY_TYPE_WPA3_OWE_TRANSITION
```

The definition of security type WPA3-OWE Transition.

<br />

Constant Value: 4 (0x00000004)

### SECURITY_TYPE_WPA3_SAE

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SECURITY_TYPE_WPA3_SAE
```

The definition of security type WPA3-SAE.

<br />

Constant Value: 3 (0x00000003)

### SECURITY_TYPE_WPA3_SAE_TRANSITION

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SECURITY_TYPE_WPA3_SAE_TRANSITION
```

The definition of security type WPA3-SAE Transition mode.

<br />

Constant Value: 2 (0x00000002)

## Fields

### CREATOR

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<SoftApConfiguration> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object otherObj)
```

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.

<br />

| Parameters ||
|---|---|
| `otherObj` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getBssid

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public MacAddress getBssid ()
```

Returns MAC address set to be BSSID for the AP.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/net/MacAddress` | This value may be `null`. <br /> |

### getChannels

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public SparseIntArray getChannels ()
```

Returns SparseIntArray (key: `BandType` , value: channel) that consists of the configured bands and channels for the AP(s). The returned channel value is Wi-Fi channel numbering. 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. Note: return array may only include one channel when current setting is single AP mode. See also `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration.Builder#setChannels(android.util.SparseIntArray)`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/util/SparseIntArray` | This value cannot be `null`. <br /> |

### getPassphrase

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getPassphrase ()
```

Returns String set to be passphrase for current AP.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value may be `null`. <br /> |

### getSecurityType

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSecurityType ()
```

Get security type params which depends on which security passphrase to set.

<br />

| Returns ||
|---|---|
| `int` | One of: `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_OPEN`, `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA2_PSK`, `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA3_SAE_TRANSITION`, `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA3_SAE`, `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA3_OWE_TRANSITION`, `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA3_OWE` Value is one of the following: - `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_OPEN` - `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA2_PSK` - `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA3_SAE_TRANSITION` - `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA3_SAE` - `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA3_OWE_TRANSITION` - `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#SECURITY_TYPE_WPA3_OWE` |

### getSsid

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getSsid ()
```

<br />

**This method was deprecated in API level 33.**   

Use `https://developer.android.com/reference/android/net/wifi/SoftApConfiguration#getWifiSsid()` instead.

Return the UTF-8 String set to be the SSID for the AP. If the SSID cannot be decoded as UTF-8, then this will return `https://developer.android.com/reference/android/net/wifi/WifiManager#UNKNOWN_SSID`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value may be `null`. <br /> |

### getWifiSsid

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public WifiSsid getWifiSsid ()
```

Return WifiSsid set to be the SSID for the AP.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/net/wifi/WifiSsid` | This value may be `null`. <br /> |

### hashCode

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int hashCode ()
```

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `https://developer.android.com/reference/java/util/HashMap`.

The general contract of `hashCode` is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### isHiddenSsid

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isHiddenSsid ()
```

Returns Boolean set to be indicate hidden (true: doesn't broadcast its SSID) or not (false: broadcasts its SSID) for the AP.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### toString

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |