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/AudioRecord.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/media/AudioRecord.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/AudioRecord.Builder#inhmethods)

# AudioRecord.Builder

*** ** * ** ***

` public static class AudioRecord.Builder `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

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

<br />

*** ** * ** ***

Builder class for `https://developer.android.com/reference/android/media/AudioRecord` objects. Use this class to configure and create an `AudioRecord` instance. By setting the recording source 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 `AudioRecord` instance:

```
AudioRecord recorder = new AudioRecord.Builder()
        .setAudioSource(MediaRecorder.AudioSource.VOICE_COMMUNICATION)
        .setAudioFormat(new AudioFormat.Builder()
                .setEncoding(AudioFormat.ENCODING_PCM_16BIT)
                .setSampleRate(32000)
                .setChannelMask(AudioFormat.CHANNEL_IN_MONO)
                .build())
        .setBufferSizeInBytes(2*minBuffSize)
        .build();
```

If the audio source is not set with `https://developer.android.com/reference/android/media/AudioRecord.Builder#setAudioSource(int)`, `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#DEFAULT` is 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_IN_MONO`, 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 capture and can be queried with `https://developer.android.com/reference/android/media/AudioRecord#getSampleRate()` method.   

If the buffer size is not specified with `https://developer.android.com/reference/android/media/AudioRecord.Builder#setBufferSizeInBytes(int)`, the minimum buffer size for the source is used.

## Summary

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

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/media/AudioRecord` | ` https://developer.android.com/reference/android/media/AudioRecord.Builder#build()() ` Requires `https://developer.android.com/reference/android/Manifest.permission#RECORD_AUDIO` |
| ` https://developer.android.com/reference/android/media/AudioRecord.Builder` | ` https://developer.android.com/reference/android/media/AudioRecord.Builder#setAudioFormat(android.media.AudioFormat)(https://developer.android.com/reference/android/media/AudioFormat format) ` Sets the format of the audio data to be captured. |
| ` https://developer.android.com/reference/android/media/AudioRecord.Builder` | ` https://developer.android.com/reference/android/media/AudioRecord.Builder#setAudioPlaybackCaptureConfig(android.media.AudioPlaybackCaptureConfiguration)(https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration config) ` Sets the `https://developer.android.com/reference/android/media/AudioRecord` to record audio played by other apps. |
| ` https://developer.android.com/reference/android/media/AudioRecord.Builder` | ` https://developer.android.com/reference/android/media/AudioRecord.Builder#setAudioSource(int)(int source) ` |
| ` https://developer.android.com/reference/android/media/AudioRecord.Builder` | ` https://developer.android.com/reference/android/media/AudioRecord.Builder#setBufferSizeInBytes(int)(int bufferSizeInBytes) ` Sets the total size (in bytes) of the buffer where audio data is written during the recording. |
| ` https://developer.android.com/reference/android/media/AudioRecord.Builder` | ` https://developer.android.com/reference/android/media/AudioRecord.Builder#setContext(android.content.Context)(https://developer.android.com/reference/android/content/Context context) ` Sets the context the record belongs to. |
| ` https://developer.android.com/reference/android/media/AudioRecord.Builder` | ` https://developer.android.com/reference/android/media/AudioRecord.Builder#setPrivacySensitive(boolean)(boolean privacySensitive) ` Indicates that this capture request is privacy sensitive and that any concurrent capture is not permitted. |

### 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 AudioRecord build ()
```

Requires `https://developer.android.com/reference/android/Manifest.permission#RECORD_AUDIO`

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/AudioRecord` | a new `https://developer.android.com/reference/android/media/AudioRecord` instance successfully initialized with all the parameters set on this `Builder`. <br /> |

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

### setAudioFormat

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

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

Sets the format of the audio data to be captured.

<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/AudioRecord.Builder` | the same Builder instance. <br /> |

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

### setAudioPlaybackCaptureConfig

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

```
public AudioRecord.Builder setAudioPlaybackCaptureConfig (AudioPlaybackCaptureConfiguration config)
```

Sets the `https://developer.android.com/reference/android/media/AudioRecord` to record audio played by other apps.

<br />

| Parameters ||
|---|---|
| `config` | `AudioPlaybackCaptureConfiguration`: Defines what apps to record audio from (i.e., via either their uid or the type of audio). This value cannot be `null`. <br /> |

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

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if called in conjunction with `https://developer.android.com/reference/android/media/AudioRecord.Builder#setAudioSource(int)`. |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if `config` is null. |

### setAudioSource

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

```
public AudioRecord.Builder setAudioSource (int source)
```

<br />

<br />

| Parameters ||
|---|---|
| `source` | `int`: the audio source. See `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource` for the supported audio source definitions. Value is one of the following: - `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#DEFAULT` - `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#MIC` - `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#VOICE_UPLINK` - `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#VOICE_DOWNLINK` - `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#VOICE_CALL` - `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#CAMCORDER` - `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#VOICE_RECOGNITION` - `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#VOICE_COMMUNICATION` - `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#UNPROCESSED` - `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#VOICE_PERFORMANCE` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/AudioRecord.Builder` | the same Builder instance. <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 AudioRecord.Builder setBufferSizeInBytes (int bufferSizeInBytes)
```

Sets the total size (in bytes) of the buffer where audio data is written during the recording. New audio data can be read from this buffer in smaller chunks than this size. See `https://developer.android.com/reference/android/media/AudioRecord#getMinBufferSize(int,%20int,%20int)` to determine the minimum required buffer size for the successful creation of an AudioRecord instance. Since bufferSizeInBytes may be internally increased to accommodate the source requirements, use `https://developer.android.com/reference/android/media/AudioRecord#getBufferSizeInFrames()` to determine the actual buffer size in frames.

<br />

| Parameters ||
|---|---|
| `bufferSizeInBytes` | `int`: a value strictly greater than 0 <br /> |

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

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

### setContext

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

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

Sets the context the record belongs to. This context will be used to pull information, such as `https://developer.android.com/reference/android/content/AttributionSource` and device specific session ids, which will be associated with the `https://developer.android.com/reference/android/media/AudioRecord` the AudioRecord. However, the context itself will not be retained by the AudioRecord.

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

### setPrivacySensitive

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

```
public AudioRecord.Builder setPrivacySensitive (boolean privacySensitive)
```

Indicates that this capture request is privacy sensitive and that any concurrent capture is not permitted.

The default is not privacy sensitive except when the audio source set with `https://developer.android.com/reference/android/media/AudioRecord.Builder#setAudioSource(int)` is `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#VOICE_COMMUNICATION` or `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#CAMCORDER`.

Always takes precedence over default from audio source when set explicitly.

Using this API is only permitted when the audio source is one of:

- `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#MIC`
- `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#CAMCORDER`
- `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#VOICE_RECOGNITION`
- `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#VOICE_COMMUNICATION`
- `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#UNPROCESSED`
- `https://developer.android.com/reference/android/media/MediaRecorder.AudioSource#VOICE_PERFORMANCE`

Invoking `https://developer.android.com/reference/android/media/AudioRecord.Builder#build()` will throw an UnsupportedOperationException if this condition is not met.

<br />

<br />

| Parameters ||
|---|---|
| `privacySensitive` | `boolean`: True if capture from this AudioRecord must be marked as privacy sensitive, false otherwise. <br /> |

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