Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/android/media/SoundPool.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/media/SoundPool.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/SoundPool.Builder#inhmethods)

# SoundPool.Builder

*** ** * ** ***


`
public
static


class
SoundPool.Builder
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.media.SoundPool.Builder |

<br />

*** ** * ** ***

Builder class for `https://developer.android.com/reference/android/media/SoundPool` objects.

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/media/SoundPool.Builder#Builder()() ` Constructs a new Builder with the defaults format values. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/media/SoundPool` | ` https://developer.android.com/reference/android/media/SoundPool.Builder#build()() ` |
| ` https://developer.android.com/reference/android/media/SoundPool.Builder` | ` https://developer.android.com/reference/android/media/SoundPool.Builder#setAudioAttributes(android.media.AudioAttributes)(https://developer.android.com/reference/android/media/AudioAttributes attributes) ` Sets the `https://developer.android.com/reference/android/media/AudioAttributes`. |
| ` https://developer.android.com/reference/android/media/SoundPool.Builder` | ` https://developer.android.com/reference/android/media/SoundPool.Builder#setAudioSessionId(int)(int sessionId) ` Sets the session ID the `https://developer.android.com/reference/android/media/SoundPool` will be attached to. |
| ` https://developer.android.com/reference/android/media/SoundPool.Builder` | ` https://developer.android.com/reference/android/media/SoundPool.Builder#setContext(android.content.Context)(https://developer.android.com/reference/android/content/Context context) ` Sets the context the SoundPool belongs to. |
| ` https://developer.android.com/reference/android/media/SoundPool.Builder` | ` https://developer.android.com/reference/android/media/SoundPool.Builder#setMaxStreams(int)(int maxStreams) ` Sets the maximum of number of simultaneous streams that can be played simultaneously. |

| ### 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*. | ||

## Public constructors

### Builder

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

```
public Builder ()
```

Constructs a new Builder with the defaults format values.
If not provided, the maximum number of streams is 1 (see `https://developer.android.com/reference/android/media/SoundPool.Builder#setMaxStreams(int)` to
change it), and the audio attributes have a usage value of
`https://developer.android.com/reference/android/media/AudioAttributes#USAGE_MEDIA` (see `https://developer.android.com/reference/android/media/SoundPool.Builder#setAudioAttributes(android.media.AudioAttributes)` to
change them).

<br />

## Public methods

### build

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

```
public SoundPool build ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/SoundPool` | <br /> |

### setAudioAttributes

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

```
public SoundPool.Builder setAudioAttributes (AudioAttributes attributes)
```

Sets the `https://developer.android.com/reference/android/media/AudioAttributes`. For examples, game applications will use attributes
built with usage information set to `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_GAME`.

<br />

| Parameters ||
|---|---|
| `attributes` | `AudioAttributes`: a non-null <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/SoundPool.Builder` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` |   |

### setAudioSessionId

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

```
public SoundPool.Builder setAudioSessionId (int sessionId)
```

Sets the session ID the `https://developer.android.com/reference/android/media/SoundPool` will be attached to.

Note, that if there's a device specific session id associated with the context
(see `https://developer.android.com/reference/android/media/SoundPool.Builder#setContext(android.content.Context)`), explicitly setting a session id using this
method will override it.

<br />

| Parameters ||
|---|---|
| `sessionId` | `int`: a strictly positive ID number retrieved from another player or allocated by `https://developer.android.com/reference/android/media/AudioManager` via `https://developer.android.com/reference/android/media/AudioManager#generateAudioSessionId()`, or `https://developer.android.com/reference/android/media/AudioManager#AUDIO_SESSION_ID_GENERATE`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/SoundPool.Builder` | the same `https://developer.android.com/reference/android/media/SoundPool.Builder` instance. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | when sessionId is invalid. |

### setContext

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

```
public SoundPool.Builder setContext (Context context)
```

Sets the context the SoundPool belongs to.

The context will be used to pull information, such as
`https://developer.android.com/reference/android/content/AttributionSource` and device specific audio session ids,
which will be associated with the `https://developer.android.com/reference/android/media/SoundPool`. However, the context itself will
not be retained by the `https://developer.android.com/reference/android/media/SoundPool` instance after initialization.

<br />

| Parameters ||
|---|---|
| `context` | `Context`: a non-null `https://developer.android.com/reference/android/content/Context` instance <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/SoundPool.Builder` | the same `https://developer.android.com/reference/android/media/SoundPool.Builder` instance. This value cannot be `null`. <br /> |

### setMaxStreams

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

```
public SoundPool.Builder setMaxStreams (int maxStreams)
```

Sets the maximum of number of simultaneous streams that can be played simultaneously.

<br />

| Parameters ||
|---|---|
| `maxStreams` | `int`: a value equal to 1 or greater. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/SoundPool.Builder` | the same Builder instance <br /> |

| Throws ||
|---|---|
|   | java.lang.IllegalArgumentException |
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` |   |