Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration#nestedclasses) \| [Methods](https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration#inhmethods)

# AudioPlaybackCaptureConfiguration

*** ** * ** ***

` public final class AudioPlaybackCaptureConfiguration `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

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

<br />

*** ** * ** ***

Configuration for capturing audio played by other apps. When capturing audio signals played by other apps (and yours), you will only capture a mix of the audio signals played by players (such as AudioTrack or MediaPlayer) which present the following characteristics:

- the usage value MUST be `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_UNKNOWN` or `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_GAME` or `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_MEDIA`. All other usages CAN NOT be captured.
- AND the capture policy set by their app (with `https://developer.android.com/reference/android/media/AudioManager#setAllowedCapturePolicy(int)`) or on each player (with `https://developer.android.com/reference/android/media/AudioAttributes.Builder#setAllowedCapturePolicy(int)`) is `https://developer.android.com/reference/android/media/AudioAttributes#ALLOW_CAPTURE_BY_ALL`, whichever is the most strict.
- AND their app attribute allowAudioPlaybackCapture in their manifest MUST either be:
  - set to "true"
  - not set, and their `targetSdkVersion` MUST be equal to or greater than `https://developer.android.com/reference/android/os/Build.VERSION_CODES#Q`. Ie. Apps that do not target at least Android Q must explicitly opt-in to be captured by a MediaProjection.
- AND their apps MUST be in the same user profile as your app (eg work profile cannot capture user profile apps and vice-versa).

An example for creating a capture configuration for capturing all media playback:

```
    MediaProjection mediaProjection;
    // Retrieve a audio capable projection from the MediaProjectionManager
    AudioPlaybackCaptureConfiguration config =
        new AudioPlaybackCaptureConfiguration.Builder(mediaProjection)
        .addMatchingUsage(AudioAttributes.USAGE_MEDIA)
        .build();
    AudioRecord record = new AudioRecord.Builder()
        .setAudioPlaybackCaptureConfig(config)
        .build();
```

<br />

**See also:**

- `https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration.Builder`
- `https://developer.android.com/reference/android/media/projection/MediaProjectionManager#getMediaProjection(int,%20android.content.Intent)`
- `https://developer.android.com/reference/android/media/AudioRecord.Builder#setAudioPlaybackCaptureConfig(android.media.AudioPlaybackCaptureConfiguration)`

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration.Builder` Builder for creating `https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration` instances. |

| ### Public methods ||
|---|---|
| ` int[]` | ` https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration#getExcludeUids()() ` |
| ` int[]` | ` https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration#getExcludeUsages()() ` |
| ` int[]` | ` https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration#getMatchingUids()() ` |
| ` int[]` | ` https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration#getMatchingUsages()() ` |
| ` https://developer.android.com/reference/android/media/projection/MediaProjection` | ` https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration#getMediaProjection()() ` |

### 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 methods

### getExcludeUids

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

```
public int[] getExcludeUids ()
```

<br />

<br />

| Returns ||
|---|---|
| `int[]` | the UIDs passed to `https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration.Builder#excludeUid(int)`. This value cannot be `null`. <br /> |

### getExcludeUsages

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

```
public int[] getExcludeUsages ()
```

<br />

<br />

| Returns ||
|---|---|
| `int[]` | the usages passed to `https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration.Builder#excludeUsage(int)`. Value is one of the following: - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_UNKNOWN` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_MEDIA` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_VOICE_COMMUNICATION` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_VOICE_COMMUNICATION_SIGNALLING` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ALARM` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_RINGTONE` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_REQUEST` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_INSTANT` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_DELAYED` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_EVENT` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ASSISTANCE_ACCESSIBILITY` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ASSISTANCE_NAVIGATION_GUIDANCE` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ASSISTANCE_SONIFICATION` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_GAME` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ASSISTANT` . This value cannot be `null`. |

### getMatchingUids

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

```
public int[] getMatchingUids ()
```

<br />

<br />

| Returns ||
|---|---|
| `int[]` | the UIDs passed to `https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration.Builder#addMatchingUid(int)`. This value cannot be `null`. <br /> |

### getMatchingUsages

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

```
public int[] getMatchingUsages ()
```

<br />

<br />

| Returns ||
|---|---|
| `int[]` | the usages passed to `https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration.Builder#addMatchingUsage(int)`. Value is one of the following: - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_UNKNOWN` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_MEDIA` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_VOICE_COMMUNICATION` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_VOICE_COMMUNICATION_SIGNALLING` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ALARM` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_RINGTONE` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_REQUEST` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_INSTANT` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_DELAYED` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_EVENT` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ASSISTANCE_ACCESSIBILITY` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ASSISTANCE_NAVIGATION_GUIDANCE` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ASSISTANCE_SONIFICATION` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_GAME` - `https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ASSISTANT` . This value cannot be `null`. |

### getMediaProjection

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

```
public MediaProjection getMediaProjection ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/projection/MediaProjection` | the `MediaProjection` used to build this object. This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/media/AudioPlaybackCaptureConfiguration.Builder#Builder(android.media.projection.MediaProjection)`