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

# AudioTrack.Builder

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/media/AudioTrack.Builder "View this page in Kotlin") \|Java


`
public
static


class
AudioTrack.Builder
`


`

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


`

`


`

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

<br />

*** ** * ** ***

Builder class for `https://developer.android.com/reference/android/media/AudioTrack` objects.
Use this class to configure and create an `AudioTrack` instance. By setting audio
attributes and audio format parameters, you indicate which of those vary from the default
behavior on the device.

Here is an example where `Builder` is used to specify all `https://developer.android.com/reference/android/media/AudioFormat`
parameters, to be used by a new `AudioTrack` instance:

```scdoc
 AudioTrack player = new AudioTrack.Builder()
         .setAudioAttributes(new AudioAttributes.Builder()
                  .setUsage(AudioAttributes.USAGE_ALARM)
                  .setContentType(AudioAttributes.CONTENT_TYPE_MUSIC)
                  .build())
         .setAudioFormat(new AudioFormat.Builder()
                 .setEncoding(AudioFormat.ENCODING_PCM_16BIT)
                 .setSampleRate(44100)
                 .setChannelMask(AudioFormat.CHANNEL_OUT_STEREO)
                 .build())
         .setBufferSizeInBytes(minBuffSize)
         .build();
 
```


If the audio attributes are not set with `https://developer.android.com/reference/android/media/AudioTrack.Builder#setAudioAttributes(android.media.AudioAttributes)`,
attributes comprising `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_MEDIA` will be used.

If the audio format is not specified or is incomplete, its channel configuration will be
`https://developer.android.com/reference/android/media/AudioFormat#CHANNEL_OUT_STEREO` and the encoding will be
`https://developer.android.com/reference/android/media/AudioFormat#ENCODING_PCM_16BIT`.
The sample rate will depend on the device actually selected for playback and can be queried
with `https://developer.android.com/reference/android/media/AudioTrack#getSampleRate()` method.

If the buffer size is not specified with `https://developer.android.com/reference/android/media/AudioTrack.Builder#setBufferSizeInBytes(int)`,
and the mode is `https://developer.android.com/reference/android/media/AudioTrack#MODE_STREAM`, the minimum buffer size is used.

If the transfer mode is not specified with `https://developer.android.com/reference/android/media/AudioTrack.Builder#setTransferMode(int)`,
`MODE_STREAM` will be used.

If the session ID is not specified with `https://developer.android.com/reference/android/media/AudioTrack.Builder#setSessionId(int)`, a new one will
be generated.

Offload is false by default.

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/media/AudioTrack.Builder#Builder()() ` Constructs a new Builder with the default values as described above. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/media/AudioTrack` | ` https://developer.android.com/reference/android/media/AudioTrack.Builder#build()() ` Builds an `https://developer.android.com/reference/android/media/AudioTrack` instance initialized with all the parameters set on this `Builder`. |
| ` https://developer.android.com/reference/android/media/AudioTrack.Builder` | ` https://developer.android.com/reference/android/media/AudioTrack.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/AudioTrack.Builder` | ` https://developer.android.com/reference/android/media/AudioTrack.Builder#setAudioFormat(android.media.AudioFormat)(https://developer.android.com/reference/android/media/AudioFormat format) ` Sets the format of the audio data to be played by the `https://developer.android.com/reference/android/media/AudioTrack`. |
| ` https://developer.android.com/reference/android/media/AudioTrack.Builder` | ` https://developer.android.com/reference/android/media/AudioTrack.Builder#setBufferSizeInBytes(int)(int bufferSizeInBytes) ` Sets the total size (in bytes) of the buffer where audio data is read from for playback. |
| ` https://developer.android.com/reference/android/media/AudioTrack.Builder` | ` https://developer.android.com/reference/android/media/AudioTrack.Builder#setContext(android.content.Context)(https://developer.android.com/reference/android/content/Context context) ` Sets the context the track belongs to. |
| ` https://developer.android.com/reference/android/media/AudioTrack.Builder` | ` https://developer.android.com/reference/android/media/AudioTrack.Builder#setEncapsulationMode(int)(int encapsulationMode) ` Sets the encapsulation mode. |
| ` https://developer.android.com/reference/android/media/AudioTrack.Builder` | ` https://developer.android.com/reference/android/media/AudioTrack.Builder#setOffloadedPlayback(boolean)(boolean offload) ` Sets whether this track will play through the offloaded audio path. |
| ` https://developer.android.com/reference/android/media/AudioTrack.Builder` | ` https://developer.android.com/reference/android/media/AudioTrack.Builder#setPerformanceMode(int)(int performanceMode) ` Sets the `https://developer.android.com/reference/android/media/AudioTrack` performance mode. |
| ` https://developer.android.com/reference/android/media/AudioTrack.Builder` | ` https://developer.android.com/reference/android/media/AudioTrack.Builder#setSessionId(int)(int sessionId) ` Sets the session ID the `https://developer.android.com/reference/android/media/AudioTrack` will be attached to. |
| ` https://developer.android.com/reference/android/media/AudioTrack.Builder` | ` https://developer.android.com/reference/android/media/AudioTrack.Builder#setTransferMode(int)(int mode) ` Sets the mode under which buffers of audio data are transferred from the `https://developer.android.com/reference/android/media/AudioTrack` to the framework. |

| ### 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 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Builder ()
```

Constructs a new Builder with the default values as described above.

<br />

## Public methods

### build

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

```
public AudioTrack build ()
```

Builds an `https://developer.android.com/reference/android/media/AudioTrack` instance initialized with all the parameters set
on this `Builder`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/AudioTrack` | a new successfully initialized `https://developer.android.com/reference/android/media/AudioTrack` instance. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | if the parameters set on the `Builder` were incompatible, or if they are not supported by the device, or if the device was not available. |

### setAudioAttributes

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

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

Sets the `https://developer.android.com/reference/android/media/AudioAttributes`.

<br />

| Parameters ||
|---|---|
| `attributes` | `AudioAttributes`: a non-null `https://developer.android.com/reference/android/media/AudioAttributes` instance that describes the audio data to be played. <br /> |

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

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

### setAudioFormat

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

```
public AudioTrack.Builder setAudioFormat (AudioFormat format)
```

Sets the format of the audio data to be played by the `https://developer.android.com/reference/android/media/AudioTrack`.
See `https://developer.android.com/reference/android/media/AudioFormat.Builder` for configuring the audio format parameters such
as encoding, channel mask and sample rate.

<br />

| Parameters ||
|---|---|
| `format` | `AudioFormat`: a non-null `https://developer.android.com/reference/android/media/AudioFormat` instance. <br /> |

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

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

### setBufferSizeInBytes

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

```
public AudioTrack.Builder setBufferSizeInBytes (int bufferSizeInBytes)
```

Sets the total size (in bytes) of the buffer where audio data is read from for playback.
If using the `https://developer.android.com/reference/android/media/AudioTrack` in streaming mode
(see `https://developer.android.com/reference/android/media/AudioTrack#MODE_STREAM`, you can write data into this buffer in smaller
chunks than this size. See `https://developer.android.com/reference/android/media/AudioTrack#getMinBufferSize(int,%20int,%20int)` to determine
the estimated minimum buffer size for the creation of an AudioTrack instance
in streaming mode.

If using the `AudioTrack` in static mode (see
`https://developer.android.com/reference/android/media/AudioTrack#MODE_STATIC`), this is the maximum size of the sound that will be
played by this instance.

<br />

| Parameters ||
|---|---|
| `bufferSizeInBytes` | `int`: Value is 0 or greater <br /> |

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

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

### setContext

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

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

Sets the context the track belongs to. This 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/AudioTrack`. However, the context itself will
not be retained by the `https://developer.android.com/reference/android/media/AudioTrack`.

<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/AudioTrack.Builder` | the same Builder instance. This value cannot be `null`. <br /> |

### setEncapsulationMode

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

```
public AudioTrack.Builder setEncapsulationMode (int encapsulationMode)
```

Sets the encapsulation mode.

Encapsulation mode allows metadata to be sent together with
the audio data payload in a `ByteBuffer`.
This requires a compatible hardware audio codec.

<br />

| Parameters ||
|---|---|
| `encapsulationMode` | `int`: one of `https://developer.android.com/reference/android/media/AudioTrack#ENCAPSULATION_MODE_NONE`, or `https://developer.android.com/reference/android/media/AudioTrack#ENCAPSULATION_MODE_ELEMENTARY_STREAM`. Value is one of the following: - `https://developer.android.com/reference/android/media/AudioTrack#ENCAPSULATION_MODE_NONE` - `https://developer.android.com/reference/android/media/AudioTrack#ENCAPSULATION_MODE_ELEMENTARY_STREAM` |

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

### setOffloadedPlayback

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

```
public AudioTrack.Builder setOffloadedPlayback (boolean offload)
```

Sets whether this track will play through the offloaded audio path.
When set to true, at build time, the audio format will be checked against
`https://developer.android.com/reference/android/media/AudioManager#isOffloadedPlaybackSupported(android.media.AudioFormat,%20android.media.AudioAttributes)`
to verify the audio format used by this track is supported on the device's offload
path (if any).

Offload is only supported for media audio streams, and therefore requires that
the usage be `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_MEDIA`.

<br />

| Parameters ||
|---|---|
| `offload` | `boolean`: true to require the offload path for playback. <br /> |

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

### setPerformanceMode

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

```
public AudioTrack.Builder setPerformanceMode (int performanceMode)
```

Sets the `https://developer.android.com/reference/android/media/AudioTrack` performance mode. This is an advisory request which
may not be supported by the particular device, and the framework is free
to ignore such request if it is incompatible with other requests or hardware.

<br />

| Parameters ||
|---|---|
| `performanceMode` | `int`: one of `https://developer.android.com/reference/android/media/AudioTrack#PERFORMANCE_MODE_NONE`, `https://developer.android.com/reference/android/media/AudioTrack#PERFORMANCE_MODE_LOW_LATENCY`, or `https://developer.android.com/reference/android/media/AudioTrack#PERFORMANCE_MODE_POWER_SAVING`. Value is one of the following: - `https://developer.android.com/reference/android/media/AudioTrack#PERFORMANCE_MODE_NONE` - `https://developer.android.com/reference/android/media/AudioTrack#PERFORMANCE_MODE_LOW_LATENCY` - `https://developer.android.com/reference/android/media/AudioTrack#PERFORMANCE_MODE_POWER_SAVING` |

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

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `performanceMode` is not valid. |

### setSessionId

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

```
public AudioTrack.Builder setSessionId (int sessionId)
```

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

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

<br />

| Parameters ||
|---|---|
| `sessionId` | `int`: a strictly positive ID number retrieved from another `AudioTrack` via `https://developer.android.com/reference/android/media/AudioTrack#getAudioSessionId()` 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`. Value is 1 or greater <br /> |

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

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

### setTransferMode

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

```
public AudioTrack.Builder setTransferMode (int mode)
```

Sets the mode under which buffers of audio data are transferred from the
`https://developer.android.com/reference/android/media/AudioTrack` to the framework.

<br />

| Parameters ||
|---|---|
| `mode` | `int`: one of `https://developer.android.com/reference/android/media/AudioTrack#MODE_STREAM`, `https://developer.android.com/reference/android/media/AudioTrack#MODE_STATIC`. Value is one of the following: - `https://developer.android.com/reference/android/media/AudioTrack#MODE_STATIC` - `https://developer.android.com/reference/android/media/AudioTrack#MODE_STREAM` |

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

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