# AudioPlaybackCaptureConfiguration.Builder

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

# Builder

*** ** * ** ***

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

```
class Builder
```

|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                                     ||
| ↳ | [android.media.AudioPlaybackCaptureConfiguration.Builder](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#) |

Builder for creating[AudioPlaybackCaptureConfiguration](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration)instances.

## Summary

|                                                                                                                                             Public constructors                                                                                                                                             ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [Builder](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#Builder(android.media.projection.MediaProjection))`(`projection:` `[MediaProjection](https://developer.android.com/reference/kotlin/android/media/projection/MediaProjection)`)` <br /> |

|                                                                                                                                                                                                                                                                     Public methods                                                                                                                                                                                                                                                                     ||
|------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [AudioPlaybackCaptureConfiguration.Builder](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#) | [addMatchingUid](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#addMatchingUid(kotlin.Int))`(`uid:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Only capture audio output by app with the matching`uid`.                                                                                              |
| [AudioPlaybackCaptureConfiguration.Builder](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#) | [addMatchingUsage](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#addMatchingUsage(kotlin.Int))`(`usage:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Only capture audio output with the given[AudioAttributes](https://developer.android.com/reference/kotlin/android/media/AudioAttributes).        |
| [AudioPlaybackCaptureConfiguration](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration)                  | [build](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#build())`()` Builds the configuration instance.                                                                                                                                                                                                                                   |
| [AudioPlaybackCaptureConfiguration.Builder](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#) | [excludeUid](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#excludeUid(kotlin.Int))`(`uid:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Only capture audio output by apps that do not have the matching`uid`.                                                                                         |
| [AudioPlaybackCaptureConfiguration.Builder](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#) | [excludeUsage](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#excludeUsage(kotlin.Int))`(`usage:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Only capture audio output that does not match the given[AudioAttributes](https://developer.android.com/reference/kotlin/android/media/AudioAttributes). |

## Public constructors

### Builder

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

```
Builder(projection: MediaProjection)
```

|                                                                                               Parameters                                                                                               ||
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `projection` | [MediaProjection](https://developer.android.com/reference/kotlin/android/media/projection/MediaProjection):A MediaProjection that supports audio projection. This value cannot be`null`. |

## Public methods

### addMatchingUid

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

```
fun addMatchingUid(uid: Int): AudioPlaybackCaptureConfiguration.Builder
```

Only capture audio output by app with the matching`uid`.

If called multiple times, will capture audio output by apps whose uid is any of the given uids.

|                                                                                      Return                                                                                       ||
|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [AudioPlaybackCaptureConfiguration.Builder](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#) | This value cannot be`null`. |

|                                                                                                    Exceptions                                                                                                     ||
|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `java.lang.IllegalStateException` | if called in conjunction with[excludeUid(int)](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#excludeUid(kotlin.Int)). |

### addMatchingUsage

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

```
fun addMatchingUsage(usage: Int): AudioPlaybackCaptureConfiguration.Builder
```

Only capture audio output with the given[AudioAttributes](https://developer.android.com/reference/kotlin/android/media/AudioAttributes).

If called multiple times, will capture audio output that matches any of the given attributes.

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             Parameters                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             ||
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `usage` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):Value is[android.media.AudioAttributes#USAGE_UNKNOWN](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_UNKNOWN:kotlin.Int),[android.media.AudioAttributes#USAGE_MEDIA](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_MEDIA:kotlin.Int),[android.media.AudioAttributes#USAGE_VOICE_COMMUNICATION](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_VOICE_COMMUNICATION:kotlin.Int),[android.media.AudioAttributes#USAGE_VOICE_COMMUNICATION_SIGNALLING](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_VOICE_COMMUNICATION_SIGNALLING:kotlin.Int),[android.media.AudioAttributes#USAGE_ALARM](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_ALARM:kotlin.Int),[android.media.AudioAttributes#USAGE_NOTIFICATION](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_NOTIFICATION:kotlin.Int),[android.media.AudioAttributes#USAGE_NOTIFICATION_RINGTONE](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_NOTIFICATION_RINGTONE:kotlin.Int),[android.media.AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_REQUEST](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_REQUEST:kotlin.Int),[android.media.AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_INSTANT](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_INSTANT:kotlin.Int),[android.media.AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_DELAYED](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_DELAYED:kotlin.Int),[android.media.AudioAttributes#USAGE_NOTIFICATION_EVENT](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_NOTIFICATION_EVENT:kotlin.Int),[android.media.AudioAttributes#USAGE_ASSISTANCE_ACCESSIBILITY](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_ASSISTANCE_ACCESSIBILITY:kotlin.Int),[android.media.AudioAttributes#USAGE_ASSISTANCE_NAVIGATION_GUIDANCE](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_ASSISTANCE_NAVIGATION_GUIDANCE:kotlin.Int),[android.media.AudioAttributes#USAGE_ASSISTANCE_SONIFICATION](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_ASSISTANCE_SONIFICATION:kotlin.Int),[android.media.AudioAttributes#USAGE_GAME](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_GAME:kotlin.Int),[android.media.AudioAttributes#USAGE_ASSISTANT](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_ASSISTANT:kotlin.Int), android.media.AudioAttributes.USAGE_CALL_ASSISTANT, android.media.AudioAttributes.USAGE_EMERGENCY, android.media.AudioAttributes.USAGE_SAFETY, android.media.AudioAttributes.USAGE_VEHICLE_STATUS, android.media.AudioAttributes.USAGE_ANNOUNCEMENT, or android.media.AudioAttributes.USAGE_SPEAKER_CLEANUP |

|                                                                                      Return                                                                                       ||
|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [AudioPlaybackCaptureConfiguration.Builder](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#) | This value cannot be`null`. |

|                                                                                                      Exceptions                                                                                                       ||
|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `java.lang.IllegalStateException` | if called in conjunction with[excludeUsage(int)](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#excludeUsage(kotlin.Int)). |

### build

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

```
fun build(): AudioPlaybackCaptureConfiguration
```

Builds the configuration instance.

|                                                                              Return                                                                              ||
|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [AudioPlaybackCaptureConfiguration](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration) | This value cannot be`null`. |

|                                     Exceptions                                     ||
|-------------------------------------------|-----------------------------------------|
| `java.lang.UnsupportedOperationException` | if the parameters set are incompatible. |

### excludeUid

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

```
fun excludeUid(uid: Int): AudioPlaybackCaptureConfiguration.Builder
```

Only capture audio output by apps that do not have the matching`uid`.

If called multiple times, will capture audio output by apps whose uid is not any of the given uids.

|                                                                                      Return                                                                                       ||
|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [AudioPlaybackCaptureConfiguration.Builder](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#) | This value cannot be`null`. |

|                                                                                                        Exceptions                                                                                                         ||
|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `java.lang.IllegalStateException` | if called in conjunction with[addMatchingUid(int)](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#addMatchingUid(kotlin.Int)). |

### excludeUsage

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

```
fun excludeUsage(usage: Int): AudioPlaybackCaptureConfiguration.Builder
```

Only capture audio output that does not match the given[AudioAttributes](https://developer.android.com/reference/kotlin/android/media/AudioAttributes).

If called multiple times, will capture audio output that does not match any of the given attributes.

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             Parameters                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             ||
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `usage` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):Value is[android.media.AudioAttributes#USAGE_UNKNOWN](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_UNKNOWN:kotlin.Int),[android.media.AudioAttributes#USAGE_MEDIA](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_MEDIA:kotlin.Int),[android.media.AudioAttributes#USAGE_VOICE_COMMUNICATION](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_VOICE_COMMUNICATION:kotlin.Int),[android.media.AudioAttributes#USAGE_VOICE_COMMUNICATION_SIGNALLING](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_VOICE_COMMUNICATION_SIGNALLING:kotlin.Int),[android.media.AudioAttributes#USAGE_ALARM](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_ALARM:kotlin.Int),[android.media.AudioAttributes#USAGE_NOTIFICATION](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_NOTIFICATION:kotlin.Int),[android.media.AudioAttributes#USAGE_NOTIFICATION_RINGTONE](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_NOTIFICATION_RINGTONE:kotlin.Int),[android.media.AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_REQUEST](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_REQUEST:kotlin.Int),[android.media.AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_INSTANT](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_INSTANT:kotlin.Int),[android.media.AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_DELAYED](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_DELAYED:kotlin.Int),[android.media.AudioAttributes#USAGE_NOTIFICATION_EVENT](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_NOTIFICATION_EVENT:kotlin.Int),[android.media.AudioAttributes#USAGE_ASSISTANCE_ACCESSIBILITY](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_ASSISTANCE_ACCESSIBILITY:kotlin.Int),[android.media.AudioAttributes#USAGE_ASSISTANCE_NAVIGATION_GUIDANCE](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_ASSISTANCE_NAVIGATION_GUIDANCE:kotlin.Int),[android.media.AudioAttributes#USAGE_ASSISTANCE_SONIFICATION](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_ASSISTANCE_SONIFICATION:kotlin.Int),[android.media.AudioAttributes#USAGE_GAME](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_GAME:kotlin.Int),[android.media.AudioAttributes#USAGE_ASSISTANT](https://developer.android.com/reference/kotlin/android/media/AudioAttributes#USAGE_ASSISTANT:kotlin.Int), android.media.AudioAttributes.USAGE_CALL_ASSISTANT, android.media.AudioAttributes.USAGE_EMERGENCY, android.media.AudioAttributes.USAGE_SAFETY, android.media.AudioAttributes.USAGE_VEHICLE_STATUS, android.media.AudioAttributes.USAGE_ANNOUNCEMENT, or android.media.AudioAttributes.USAGE_SPEAKER_CLEANUP |

|                                                                                      Return                                                                                       ||
|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [AudioPlaybackCaptureConfiguration.Builder](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#) | This value cannot be`null`. |

|                                                                                                          Exceptions                                                                                                           ||
|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `java.lang.IllegalStateException` | if called in conjunction with[addMatchingUsage(int)](https://developer.android.com/reference/kotlin/android/media/AudioPlaybackCaptureConfiguration.Builder#addMatchingUsage(kotlin.Int)). |