Add support to make AndroidForegroundService optional to MediaElement

samples/CommunityToolkit.Maui.Sample/MauiProgram.cs

@@ -68,10 +68,12 @@ public static MauiApp CreateMauiApp()
 #endif
 								.UseMauiCommunityToolkitMarkup()
 								.UseMauiCommunityToolkitCamera()
-								.UseMauiCommunityToolkitMediaElement(static options =>
-								{
-									options.SetDefaultAndroidViewType(AndroidViewType.TextureView);
-								})
+								.UseMauiCommunityToolkitMediaElement(
+									enableForegroundService: true,
+									static options =>
+									{
+										options.SetDefaultAndroidViewType(AndroidViewType.TextureView);
+									})
 								.ConfigureMauiHandlers(static handlers =>
 								{
 #if IOS || MACCATALYST

samples/CommunityToolkit.Maui.Sample/Platforms/Android/AndroidManifest.xml

@@ -1,25 +1,36 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
     <application android:allowBackup="true" android:icon="@mipmap/appicon" android:enableOnBackInvokedCallback="true" android:hardwareAccelerated="true"
-                 android:supportsRtl="true">
-
-      <meta-data android:name="com.google.android.geo.API_KEY" android:value="PASTE-YOUR-API-KEY-HERE" />
-    </application>
-
-    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
-    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
-    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
+               android:supportsRtl="true">
 
-    <!-- Samsung -->
-    <uses-permission android:name="com.sec.android.provider.badge.permission.READ"/>
-    <uses-permission android:name="com.sec.android.provider.badge.permission.WRITE"/>
-    <!-- /Samsung -->
+    <meta-data android:name="com.google.android.geo.API_KEY" android:value="PASTE-YOUR-API-KEY-HERE" />
 
-    <uses-permission android:name="android.permission.RECORD_AUDIO"/>
-    <uses-permission android:name="android.permission.CAMERA"/>
-    <queries>
-        <intent>
-            <action android:name="android.intent.action.TTS_SERVICE"/>
-        </intent>
-    </queries>
+    <service android:name="communityToolkit.maui.media.services" android:stopWithTask="true" android:exported="false" android:enabled="true"
+               android:foregroundServiceType="mediaPlayback">
+      <intent-filter>
+        <action android:name="androidx.media3.session.MediaSessionService"/>
+      </intent-filter>
+    </service>
+  </application>
+
+  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
+  <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
+  <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
+
+  <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
+  <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
+  <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK"/>
+  <uses-permission android:name="android.permission.MEDIA_CONTENT_CONTROL"/>
+  <!-- Samsung -->
+  <uses-permission android:name="com.sec.android.provider.badge.permission.READ"/>
+  <uses-permission android:name="com.sec.android.provider.badge.permission.WRITE"/>
+  <!-- /Samsung -->
+
+  <uses-permission android:name="android.permission.RECORD_AUDIO"/>
+  <uses-permission android:name="android.permission.CAMERA"/>
+  <queries>
+    <intent>
+      <action android:name="android.intent.action.TTS_SERVICE"/>
+    </intent>
+  </queries>
 </manifest>

src/CommunityToolkit.Maui.Analyzers.UnitTests/UseCommunityToolkitMediaElementInitializationAnalyzerTests.cs

@@ -1,4 +1,4 @@
-using CommunityToolkit.Maui.Core;
+using CommunityToolkit.Maui.Core;
 using CommunityToolkit.Maui.MediaElement.Analyzers;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Testing;
@@ -34,7 +34,7 @@ public static MauiApp CreateMauiApp()
 					{
 						var builder = MauiApp.CreateBuilder();
 						builder.UseMauiApp<Microsoft.Maui.Controls.Application>()
-							.UseMauiCommunityToolkitMediaElement()
+							.UseMauiCommunityToolkitMediaElement(enableForegroundService: true)
 							.ConfigureFonts(fonts =>
 							{
 								fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
@@ -69,7 +69,7 @@ public static MauiApp CreateMauiApp()
 					{
 						var builder = MauiApp.CreateBuilder ();
 						builder.UseMauiApp<Microsoft.Maui.Controls.Application> ()
-							.UseMauiCommunityToolkitMediaElement ()
+							.UseMauiCommunityToolkitMediaElement(enableForegroundService: true)
 							.ConfigureFonts(fonts =>
 							{
 								fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
@@ -139,7 +139,7 @@ public static MauiApp CreateMauiApp()
 						var builder = MauiApp.CreateBuilder();
 						builder.UseMauiApp<Microsoft.Maui.Controls.Application>()
 						#if ANDROID || IOS
-							.UseMauiCommunityToolkitMediaElement()
+							.UseMauiCommunityToolkitMediaElement(enableForegroundService: true)
 					    #endif
 							.ConfigureFonts(fonts =>
 							{

src/CommunityToolkit.Maui.MediaElement/AppBuilderExtensions.shared.cs

@@ -20,12 +20,20 @@
 	/// Initializes the .NET MAUI Community Toolkit MediaElement Library
 	/// </summary>
 	/// <param name="builder"><see cref="MauiAppBuilder"/> generated by <see cref="MauiApp"/>.</param>
-	/// <param name="options"></param>
+	/// <param name="options"><see cref="MediaElementOptions"/>.</param>
+	/// <param name="enableForegroundService"> Enable Android Foreground Service for MediaElement.
+	/// When providing <c>true</c> the required permissions and service must be included in android manifest.
+	/// For more information, see the <see href="https://learn.microsoft.com/dotnet/communitytoolkit/maui/views/mediaelement?tabs=android">MediaElement Documentation.</see> for details.
+	/// </param>
 	/// <returns><see cref="MauiAppBuilder"/> initialized for <see cref="MediaElement"/>.</returns>
-	public static MauiAppBuilder UseMauiCommunityToolkitMediaElement(this MauiAppBuilder builder, Action<MediaElementOptions>? options = null)
+	public static MauiAppBuilder UseMauiCommunityToolkitMediaElement(this MauiAppBuilder builder, bool enableForegroundService, Action<MediaElementOptions>? options = null)
 	{
+		// Create MediaElementOptions and set the foreground service setting
+		var mediaElementOptions = new MediaElementOptions(builder);
+		mediaElementOptions.SetAndroidForegroundServiceEnabled(enableForegroundService);
+
 		// Update the default MediaElementOptions for MediaElement if Action is not null
-		options?.Invoke(new MediaElementOptions(builder));
+		options?.Invoke(mediaElementOptions);
 
 		// Perform Handler configuration
 		builder.ConfigureMauiHandlers(h =>
@@ -34,7 +42,7 @@
 		});
 
 #if ANDROID
 		builder.Services.AddSingleton<Media.Services.MediaControlsService>();
 #endif
 
 		return builder;

src/CommunityToolkit.Maui.MediaElement/Handlers/MediaElementHandler.android.cs

@@ -24,7 +24,7 @@ protected override MauiMediaElement CreatePlatformView()
 								VirtualView,
 								Dispatcher.GetForCurrentThread() ?? throw new InvalidOperationException($"{nameof(IDispatcher)} cannot be null"));
 
-		var (_, playerView) = MediaManager.CreatePlatformView(VirtualView.AndroidViewType);
+		var (_, playerView) = MediaManager.CreatePlatformView(VirtualView.AndroidViewType, VirtualView.IsAndroidForegroundServiceEnabled);
 		return new(Context, playerView);
 	}
 

src/CommunityToolkit.Maui.MediaElement/MediaElement.shared.cs

@@ -128,6 +128,11 @@ internal event EventHandler StopRequested
 	/// </summary>
 	public AndroidViewType AndroidViewType { get; init; } = MediaElementOptions.DefaultAndroidViewType;
 
+	/// <summary>
+	/// Gets or sets a value indicating whether Android Foreground Service is enabled.
+	/// </summary>
+	public bool IsAndroidForegroundServiceEnabled { get; init; } = MediaElementOptions.IsAndroidForegroundServiceEnabled;
+
 	/// <summary>
 	/// Gets or sets the <see cref="Aspect"/> ratio used to display the video content.
 	/// </summary>

src/CommunityToolkit.Maui.MediaElement/MediaElementOptions.shared.cs

@@ -26,8 +26,19 @@ internal MediaElementOptions(in MauiAppBuilder builder) : this()
 	/// </summary>
 	internal static AndroidViewType DefaultAndroidViewType { get; private set; } = AndroidViewType.SurfaceView;
 
+	/// <summary>
+	/// Set whether Android Foreground Service is enabled for MediaElement
+	/// </summary>
+	internal static bool IsAndroidForegroundServiceEnabled { get; private set; }
+
 	/// <summary>
 	/// Set Android View type for MediaElement as SurfaceView or TextureView on construction
 	/// </summary>
 	public void SetDefaultAndroidViewType(AndroidViewType androidViewType) => DefaultAndroidViewType = androidViewType;
+
+	/// <summary>
+	/// Enable Android Foreground Service for MediaElement
+	/// </summary>
+	/// <param name="enabled">True to enable foreground service, false to disable</param>
+	internal void SetAndroidForegroundServiceEnabled(bool enabled) => IsAndroidForegroundServiceEnabled = enabled;
 }

src/CommunityToolkit.Maui.MediaElement/Services/MediaControlsService.android.cs

@@ -13,7 +13,6 @@
 namespace CommunityToolkit.Maui.Media.Services;
 
 [SupportedOSPlatform("Android26.0")]
-[IntentFilter(["androidx.media3.session.MediaSessionService"])]
 [Service(Exported = false, Enabled = true, Name = "communityToolkit.maui.media.services", ForegroundServiceType = ForegroundService.TypeMediaPlayback)]
 sealed partial class MediaControlsService : Service
 {

src/CommunityToolkit.Maui.MediaElement/Views/MauiMediaElement.android.cs

@@ -8,11 +8,6 @@
 using AndroidX.Media3.UI;
 using CommunityToolkit.Maui.Views;
 
-[assembly: UsesPermission(Android.Manifest.Permission.ForegroundServiceMediaPlayback)]
-[assembly: UsesPermission(Android.Manifest.Permission.ForegroundService)]
-[assembly: UsesPermission(Android.Manifest.Permission.MediaContentControl)]
-[assembly: UsesPermission(Android.Manifest.Permission.PostNotifications)]
-
 namespace CommunityToolkit.Maui.Core.Views;
 
 /// <summary>

src/CommunityToolkit.Maui.MediaElement/Views/MediaManager.android.cs

@@ -27,6 +27,7 @@ public partial class MediaManager : Java.Lang.Object, IPlayerListener
 
 	static readonly HttpClient client = new();
 	readonly SemaphoreSlim seekToSemaphoreSlim = new(1, 1);
+	bool isAndroidServiceEnabled = false;
 
 	double? previousSpeed;
 	float volumeBeforeMute = 1;
@@ -62,9 +63,8 @@ public void OnPlaybackParametersChanged(PlaybackParameters? playbackParameters)
 
 	public void UpdateNotifications()
 	{
-		if (connection?.Binder?.Service is null)
+		if (connection?.Binder?.Service is null || !isAndroidServiceEnabled)
 		{
-			System.Diagnostics.Trace.TraceInformation("Notification Service not running.");
 			return;
 		}
 
@@ -130,11 +130,11 @@ or PlaybackState.StateSkippingToQueueItem
 	/// <returns>The platform native counterpart of <see cref="MediaElement"/>.</returns>
 	/// <exception cref="NullReferenceException">Thrown when <see cref="Context"/> is <see langword="null"/> or when the platform view could not be created.</exception>
 	[MemberNotNull(nameof(Player), nameof(PlayerView), nameof(session))]
-	public (PlatformMediaElement platformView, PlayerView PlayerView) CreatePlatformView(AndroidViewType androidViewType)
+	public (PlatformMediaElement platformView, PlayerView PlayerView) CreatePlatformView(AndroidViewType androidViewType, bool isAndroidServiceEnabled)
 	{
 		Player = new ExoPlayerBuilder(MauiContext.Context).Build() ?? throw new InvalidOperationException("Player cannot be null");
 		Player.AddListener(this);
-
+		this.isAndroidServiceEnabled = isAndroidServiceEnabled;
 		if (androidViewType is AndroidViewType.SurfaceView)
 		{
 			PlayerView = new PlayerView(MauiContext.Context)
@@ -353,7 +353,7 @@ protected virtual async partial ValueTask PlatformUpdateSource()
 			return;
 		}
 
-		if (connection is null)
+		if (connection is null && isAndroidServiceEnabled)
 		{
 			StartService();
 		}
@@ -381,10 +381,16 @@ protected virtual async partial ValueTask PlatformUpdateSource()
 			hasSetSource = true;
 		}
 
-		if (hasSetSource && Player.PlayerError is null)
+		if (hasSetSource)
 		{
-			MediaElement.MediaOpened();
-			UpdateNotifications();
+			if (Player.PlayerError is null)
+			{
+				MediaElement.MediaOpened();
+			}
+			if (isAndroidServiceEnabled)
+			{
+				UpdateNotifications();
+			}
 		}
 	}
 
@@ -631,9 +637,12 @@ static async ValueTask<long> GetByteCountFromStream(Stream stream, CancellationT
 		}
 	}
 
-	[MemberNotNull(nameof(connection))]
 	void StartService()
 	{
+		if (!isAndroidServiceEnabled)
+		{
+			return;
+		}
 		var intent = new Intent(Android.App.Application.Context, typeof(MediaControlsService));
 		connection = new BoundServiceConnection(this);
 		connection.MediaControlsServiceTaskRemoved += HandleMediaControlsServiceTaskRemoved;
@@ -644,6 +653,10 @@ void StartService()
 
 	void StopService(in BoundServiceConnection boundServiceConnection)
 	{
+		if (!isAndroidServiceEnabled)
+		{
+			return;
+		}
 		boundServiceConnection.MediaControlsServiceTaskRemoved -= HandleMediaControlsServiceTaskRemoved;
 
 		var serviceIntent = new Intent(Platform.AppContext, typeof(MediaControlsService));

src/CommunityToolkit.Maui.UnitTests/BaseTest.cs

@@ -90,7 +90,7 @@ protected virtual void Dispose(bool isDisposing)
 		// Restore default MediaElementOptions
 		var mediaElementOptions = new MediaElementOptions();
 		mediaElementOptions.SetDefaultAndroidViewType(AndroidViewType.SurfaceView);
-
+		mediaElementOptions.SetAndroidForegroundServiceEnabled(false);
 		isDisposed = true;
 	}
 

src/CommunityToolkit.Maui.UnitTests/Extensions/AppBuilderExtensionsTests.cs

@@ -148,7 +148,7 @@ void HandleShouldUseStatusBarBehaviorOnAndroidModalPageOptionCompleted(object? s
 	public void UseMauiCommunityToolkitMediaElement_ShouldUseSurfaceViewByDefault()
 	{
 		var builder = MauiApp.CreateBuilder();
-		builder.UseMauiCommunityToolkitMediaElement();
+		builder.UseMauiCommunityToolkitMediaElement(enableForegroundService: true);
 
 		MediaElementOptions.DefaultAndroidViewType.Should().Be(AndroidViewType.SurfaceView);
 	}
@@ -159,12 +159,28 @@ public void UseMauiCommunityToolkitMediaElement_ShouldSetDefaultAndroidViewType(
 		MediaElementOptions.DefaultAndroidViewType.Should().Be(AndroidViewType.SurfaceView);
 
 		var builder = MauiApp.CreateBuilder();
-		builder.UseMauiCommunityToolkitMediaElement(static options =>
+		builder.UseMauiCommunityToolkitMediaElement(enableForegroundService: true, static options =>
 		{
 			options.SetDefaultAndroidViewType(AndroidViewType.TextureView);
 		});
 
 		MediaElementOptions.DefaultAndroidViewType.Should().Be(AndroidViewType.TextureView);
 	}
+
+	[Fact]
+	public void UseMauiCommunityToolkitMediaElement_ShouldSetAndroidServiceByDefault()
+	{
+		var builder = MauiApp.CreateBuilder();
+		builder.UseMauiCommunityToolkitMediaElement(enableForegroundService: true);
+		MediaElementOptions.IsAndroidForegroundServiceEnabled.Should().Be(true);
+	}
+
+	[Fact]
+	public void UseMauiCommunityToolkitMediaElement_ServiceCanBeDisabled()
+	{
+		var builder = MauiApp.CreateBuilder();
+		builder.UseMauiCommunityToolkitMediaElement(enableForegroundService: false);
+		MediaElementOptions.IsAndroidForegroundServiceEnabled.Should().Be(false);
+	}
 }
 #pragma warning restore CA1416