Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Inherited Constants](https://developer.android.com/reference/android/media/AudioRecordingConfiguration#inhconstants) \| [Fields](https://developer.android.com/reference/android/media/AudioRecordingConfiguration#lfields) \| [Methods](https://developer.android.com/reference/android/media/AudioRecordingConfiguration#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/AudioRecordingConfiguration#inhmethods)

# AudioRecordingConfiguration

*** ** * ** ***

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


`
public

final

class
AudioRecordingConfiguration
`


`

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.media.AudioRecordingConfiguration |

<br />

*** ** * ** ***

The AudioRecordingConfiguration class collects the information describing an audio recording
session.

Direct polling (see `https://developer.android.com/reference/android/media/AudioManager#getActiveRecordingConfigurations()`) or callback
(see `https://developer.android.com/reference/android/media/AudioManager#registerAudioRecordingCallback(android.media.AudioManager.AudioRecordingCallback,%20android.os.Handler)`
methods are ways to receive information about the current recording configuration of the device.

An audio recording configuration contains information about the recording format as used by
the application (`https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getClientFormat()`, as well as the recording format actually used by
the device (`https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getFormat()`). The two recording formats may, for instance, be at different
sampling rates due to hardware limitations (e.g. application recording at 44.1kHz whereas the
device always records at 48kHz, and the Android framework resamples for the application).

The configuration also contains the use case for which audio is recorded
(`https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getClientAudioSource()`), enabling the ability to distinguish between different
activities such as ongoing voice recognition or camcorder recording.

## Summary

| ### 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/media/AudioRecordingConfiguration>` | `https://developer.android.com/reference/android/media/AudioRecordingConfiguration#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/android/media/AudioDeviceInfo` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getAudioDevice()() ` Returns information about the audio input device used for this recording. |
| ` int` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getAudioSource()() ` Returns the audio source currently used to configure the capture path. |
| ` int` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getClientAudioSessionId()() ` Returns the session number of the recording, see `https://developer.android.com/reference/android/media/AudioRecord#getAudioSessionId()`. |
| ` int` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getClientAudioSource()() ` Returns the audio source selected by the client. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor>` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getClientEffects()() ` Returns the list of `https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor` for all effects currently enabled on the audio capture client (e.g. `https://developer.android.com/reference/android/media/AudioRecord` or `https://developer.android.com/reference/android/media/MediaRecorder`). |
| ` https://developer.android.com/reference/android/media/AudioFormat` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getClientFormat()() ` Returns the audio format at which the client application is recording audio. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor>` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getEffects()() ` Returns the list of `https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor` for all effects currently enabled on the capture stream. |
| ` https://developer.android.com/reference/android/media/AudioFormat` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getFormat()() ` Returns the audio format at which audio is recorded on this Android device. |
| ` int` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#hashCode()() ` Returns a hash code value for the object. |
| ` boolean` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#isClientSilenced()() ` Returns true if the audio returned to the client is currently being silenced by the audio framework due to concurrent capture policy (e.g the capturing application does not have an active foreground process or service anymore). |
| ` void` | ` https://developer.android.com/reference/android/media/AudioRecordingConfiguration#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. | ||

## Fields

### CREATOR

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

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

<br />

<br />

## Public methods

### describeContents

Added in [API level 24](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 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object o)
```

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 ||
|---|---|
| `o` | `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 /> |

### getAudioDevice

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

```
public AudioDeviceInfo getAudioDevice ()
```

Returns information about the audio input device used for this recording.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/AudioDeviceInfo` | the audio recording device or null if this information cannot be retrieved <br /> |

### getAudioSource

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

```
public int getAudioSource ()
```

Returns the audio source currently used to configure the capture path. It can be different
from the source returned by `https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getClientAudioSource()` if another capture is active.

<br />

| Returns ||
|---|---|
| `int` | the audio source active on the capture path. 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` |

### getClientAudioSessionId

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

```
public int getClientAudioSessionId ()
```

Returns the session number of the recording, see `https://developer.android.com/reference/android/media/AudioRecord#getAudioSessionId()`.

<br />

| Returns ||
|---|---|
| `int` | the session number. <br /> |

### getClientAudioSource

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

```
public int getClientAudioSource ()
```

Returns the audio source selected by the client.

<br />

| Returns ||
|---|---|
| `int` | the audio source selected by the client. 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` |

### getClientEffects

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

```
public List<AudioEffect.Descriptor> getClientEffects ()
```

Returns the list of `https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor` for all effects currently enabled on
the audio capture client (e.g. `https://developer.android.com/reference/android/media/AudioRecord` or `https://developer.android.com/reference/android/media/MediaRecorder`).

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor>` | List of `https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor` containing all effects enabled for the client. This value cannot be `null`. <br /> |

### getClientFormat

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

```
public AudioFormat getClientFormat ()
```

Returns the audio format at which the client application is recording audio.
Note that it may differ from the actual recording format (see `https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getFormat()`).

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/AudioFormat` | the recording format <br /> |

### getEffects

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

```
public List<AudioEffect.Descriptor> getEffects ()
```

Returns the list of `https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor` for all effects currently enabled on
the capture stream.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor>` | List of `https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor` containing all effects enabled on the capture stream. This can be different from the list returned by `https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getClientEffects()` if another capture is active. This value cannot be `null`. <br /> |

### getFormat

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

```
public AudioFormat getFormat ()
```

Returns the audio format at which audio is recorded on this Android device.
Note that it may differ from the client application recording format
(see `https://developer.android.com/reference/android/media/AudioRecordingConfiguration#getClientFormat()`).

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/AudioFormat` | the device recording format <br /> |

### hashCode

Added in [API level 24](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 /> |

### isClientSilenced

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

```
public boolean isClientSilenced ()
```

Returns true if the audio returned to the client is currently being silenced by the
audio framework due to concurrent capture policy (e.g the capturing application does not have
an active foreground process or service anymore).

<br />

| Returns ||
|---|---|
| `boolean` | true if captured audio is silenced, false otherwise . <br /> |

### writeToParcel

Added in [API level 24](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`: The Parcel in which the object should be written. 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` |