AudioPlaybackCaptureConfiguration Class

Reference

Definition

Namespace:: Android.Media

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Configuration for capturing audio played by other apps.

[Android.Runtime.Register("android/media/AudioPlaybackCaptureConfiguration", ApiSince=29, DoNotGenerateAcw=true)]
public sealed class AudioPlaybackCaptureConfiguration : Java.Lang.Object

[<Android.Runtime.Register("android/media/AudioPlaybackCaptureConfiguration", ApiSince=29, DoNotGenerateAcw=true)>]
type AudioPlaybackCaptureConfiguration = class
    inherit Object

Inheritance: Object

Object
AudioPlaybackCaptureConfiguration

Attributes: RegisterAttribute

Remarks

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: <ul> <li> the usage value MUST be AudioAttributes#USAGE_UNKNOWN or AudioAttributes#USAGE_GAME or AudioAttributes#USAGE_MEDIA. All other usages CAN NOT be captured. </li> <li> 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. </li> <li> AND their app attribute allowAudioPlaybackCapture in their manifest MUST either be: <ul> <li> set to "true" </li> <li> not set, and their targetSdkVersion MUST be equal to or greater than 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. </li></ul> <li> AND their apps MUST be in the same user profile as your app (eg work profile cannot capture user profile apps and vice-versa). </li> </ul>

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();

Java documentation for android.media.AudioPlaybackCaptureConfiguration.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
ExcludeUsages
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
MatchingUsages
MediaProjection
PeerReference	(Inherited from Object)
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetExcludeUids()
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetMatchingUids()
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to