Added in API level 29

Summary: Nested Classes | Methods | Inherited Methods

AudioPlaybackCaptureConfiguration

---

Kotlin |Java

public final class AudioPlaybackCaptureConfiguration
extends Object

java.lang.Object
↳	android.media.AudioPlaybackCaptureConfiguration

---

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 AudioAttributes.USAGE_UNKNOWN or AudioAttributes.USAGE_GAME or AudioAttributes.USAGE_MEDIA. All other usages CAN NOT be captured.
• AND the capture policy set by their app (with AudioManager.setAllowedCapturePolicy) or on each player (with AudioAttributes.Builder.setAllowedCapturePolicy) is 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 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();
 

See also:

• AudioPlaybackCaptureConfiguration.Builder
• MediaProjectionManager.getMediaProjection(int, Intent)
• AudioRecord.Builder.setAudioPlaybackCaptureConfig(AudioPlaybackCaptureConfiguration)

Summary

Nested classes
class	AudioPlaybackCaptureConfiguration.Builder Builder for creating AudioPlaybackCaptureConfiguration instances.

Public methods
int[]	getExcludeUids()
int[]	getExcludeUsages()
int[]	getMatchingUids()
int[]	getMatchingUsages()
MediaProjection	getMediaProjection()

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(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 wait(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 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

public int[] getExcludeUids ()

Returns
int[]	the UIDs passed to Builder.excludeUid(int). This value cannot be null.

getExcludeUsages

Added in API level 29

public int[] getExcludeUsages ()

Returns

int[]

the usages passed to Builder.excludeUsage(int). Value is AudioAttributes.USAGE_UNKNOWN, AudioAttributes.USAGE_MEDIA, AudioAttributes.USAGE_VOICE_COMMUNICATION, AudioAttributes.USAGE_VOICE_COMMUNICATION_SIGNALLING, AudioAttributes.USAGE_ALARM, AudioAttributes.USAGE_NOTIFICATION, AudioAttributes.USAGE_NOTIFICATION_RINGTONE, AudioAttributes.USAGE_NOTIFICATION_COMMUNICATION_REQUEST, AudioAttributes.USAGE_NOTIFICATION_COMMUNICATION_INSTANT, AudioAttributes.USAGE_NOTIFICATION_COMMUNICATION_DELAYED, AudioAttributes.USAGE_NOTIFICATION_EVENT, AudioAttributes.USAGE_ASSISTANCE_ACCESSIBILITY, AudioAttributes.USAGE_ASSISTANCE_NAVIGATION_GUIDANCE, AudioAttributes.USAGE_ASSISTANCE_SONIFICATION, AudioAttributes.USAGE_GAME, AudioAttributes.USAGE_ASSISTANT, 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 This value cannot be null.

getMatchingUids

Added in API level 29

public int[] getMatchingUids ()

Returns
int[]	the UIDs passed to Builder.addMatchingUid(int). This value cannot be null.

getMatchingUsages

Added in API level 29

public int[] getMatchingUsages ()

Returns

int[]

the usages passed to Builder.addMatchingUsage(int). Value is AudioAttributes.USAGE_UNKNOWN, AudioAttributes.USAGE_MEDIA, AudioAttributes.USAGE_VOICE_COMMUNICATION, AudioAttributes.USAGE_VOICE_COMMUNICATION_SIGNALLING, AudioAttributes.USAGE_ALARM, AudioAttributes.USAGE_NOTIFICATION, AudioAttributes.USAGE_NOTIFICATION_RINGTONE, AudioAttributes.USAGE_NOTIFICATION_COMMUNICATION_REQUEST, AudioAttributes.USAGE_NOTIFICATION_COMMUNICATION_INSTANT, AudioAttributes.USAGE_NOTIFICATION_COMMUNICATION_DELAYED, AudioAttributes.USAGE_NOTIFICATION_EVENT, AudioAttributes.USAGE_ASSISTANCE_ACCESSIBILITY, AudioAttributes.USAGE_ASSISTANCE_NAVIGATION_GUIDANCE, AudioAttributes.USAGE_ASSISTANCE_SONIFICATION, AudioAttributes.USAGE_GAME, AudioAttributes.USAGE_ASSISTANT, 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 This value cannot be null.

getMediaProjection

Added in API level 29

public MediaProjection getMediaProjection ()

Returns
MediaProjection	the MediaProjection used to build this object. This value cannot be null.

See also:

• AudioPlaybackCaptureConfiguration.Builder.Builder(MediaProjection)