Skip to content

Add support to make AndroidForegroundService optional to MediaElement #2658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

Add support to make AndroidForegroundService optional to MediaElement #2658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
14eab7b
Add support to make AndroidForegroundService optional to MediaElement
ne0rrmatrix May 7, 2025
44a9928
Rename foreground service property for clarity
ne0rrmatrix May 7, 2025
c683d61
Update media playback service and permissions
ne0rrmatrix May 7, 2025
0feee28
Add tests for AndroidForegroundService default behavior
ne0rrmatrix May 7, 2025
f6407f6
Set service on by default
ne0rrmatrix May 8, 2025
63ad21b
Remove old intent filter that was added by accident
ne0rrmatrix May 8, 2025
1e60956
Rename AndroidForegroundServiceEnabled property
ne0rrmatrix May 8, 2025
5a3c0fe
Merge branch 'main' into MediaElementOptionService
ne0rrmatrix Jun 3, 2025
904ae95
Merge branch 'main' into MediaElementOptionService
ne0rrmatrix Jun 8, 2025
ea35514
Merge branch 'main' into MediaElementOptionService
ne0rrmatrix Jun 25, 2025
cecaf32
Merge branch 'main' into MediaElementOptionService
ne0rrmatrix Jul 3, 2025
178e8ae
Enable Android Foreground Service for MediaElement
ne0rrmatrix Jul 3, 2025
25b22c6
Merge branch 'MediaElementOptionService' of https://github.com/ne0rrm…
ne0rrmatrix Jul 3, 2025
1168302
Merge branch 'main' into MediaElementOptionService
ne0rrmatrix Jul 3, 2025
838d9a5
Merge branch 'main' into MediaElementOptionService
ne0rrmatrix Jul 3, 2025
7aba464
Merge branch 'main' into MediaElementOptionService
ne0rrmatrix Jul 8, 2025
a83de86
Merge branch 'main' into MediaElementOptionService
ne0rrmatrix Jul 30, 2025
ed62a22
Update src/CommunityToolkit.Maui.MediaElement/MediaElementOptions.sha…
ne0rrmatrix Aug 3, 2025
84b337c
Merge branch 'main' into MediaElementOptionService
ne0rrmatrix Aug 3, 2025
58e07a8
Merge branch 'main' into MediaElementOptionService
ne0rrmatrix Oct 10, 2025
cb63525
Merge branch 'main' into MediaElementOptionService
ne0rrmatrix Oct 16, 2025
54830f8
Merge branch 'main' into MediaElementOptionService
ne0rrmatrix Nov 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions samples/CommunityToolkit.Maui.Sample/MauiProgram.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ public static MauiApp CreateMauiApp()
.UseMauiCommunityToolkitMediaElement(static options =>
{
options.SetDefaultAndroidViewType(AndroidViewType.TextureView);
options.SetDefaultAndroidForegroundService(true);
})
.ConfigureMauiHandlers(static handlers =>
{
Expand Down
11 changes: 11 additions & 0 deletions samples/CommunityToolkit.Maui.Sample/Platforms/Android/AndroidManifest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,23 @@
android:supportsRtl="true">

<meta-data android:name="com.google.android.geo.API_KEY" android:value="PASTE-YOUR-API-KEY-HERE" />

<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"/>
Expand Down
2 changes: 1 addition & 1 deletion src/CommunityToolkit.Maui.MediaElement/AppBuilderExtensions.shared.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
{
// Update the default MediaElementOptions for MediaElement if Action is not null
options?.Invoke(new MediaElementOptions(builder));

// Perform Handler configuration
builder.ConfigureMauiHandlers(h =>
{
Expand All @@ -34,7 +34,7 @@
});

#if ANDROID
builder.Services.AddSingleton<Media.Services.MediaControlsService>();

Check warning on line 37 in src/CommunityToolkit.Maui.MediaElement/AppBuilderExtensions.shared.cs

View workflow job for this annotation

GitHub Actions / Build Library (windows-latest) 

This call site is reachable on: 'Android' 26.0 and later, 'iOS' 15.0 and later, 'maccatalyst' 15.0 and later, 'Tizen' 6.5 and later, 'Windows' 10.0.17763 and later. 'MediaControlsService' is only supported on: 'Android' 26.0 and later. (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1416)

Check warning on line 37 in src/CommunityToolkit.Maui.MediaElement/AppBuilderExtensions.shared.cs

View workflow job for this annotation

GitHub Actions / Build Library (windows-latest) 

This call site is reachable on: 'Android' 26.0 and later, 'iOS' 15.0 and later, 'maccatalyst' 15.0 and later, 'Tizen' 6.5 and later, 'Windows' 10.0.17763 and later. 'MediaControlsService' is only supported on: 'Android' 26.0 and later. (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1416)

Check warning on line 37 in src/CommunityToolkit.Maui.MediaElement/AppBuilderExtensions.shared.cs

View workflow job for this annotation

GitHub Actions / Build Library (macos-26) 

This call site is reachable on: 'Android' 26.0 and later, 'iOS' 15.0 and later, 'maccatalyst' 15.0 and later, 'Tizen' 6.5 and later, 'Windows' 10.0.17763 and later. 'MediaControlsService' is only supported on: 'Android' 26.0 and later. (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1416)

Check warning on line 37 in src/CommunityToolkit.Maui.MediaElement/AppBuilderExtensions.shared.cs

View workflow job for this annotation

GitHub Actions / Build Library (macos-26) 

This call site is reachable on: 'Android' 26.0 and later, 'iOS' 15.0 and later, 'maccatalyst' 15.0 and later, 'Tizen' 6.5 and later, 'Windows' 10.0.17763 and later. 'MediaControlsService' is only supported on: 'Android' 26.0 and later. (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1416)
#endif

return builder;
Expand Down
2 changes: 1 addition & 1 deletion src/CommunityToolkit.Maui.MediaElement/Handlers/MediaElementHandler.android.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

Expand Down
2 changes: 2 additions & 0 deletions src/CommunityToolkit.Maui.MediaElement/MediaElement.shared.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,8 @@ internal event EventHandler StopRequested
/// </summary>
public AndroidViewType AndroidViewType { get; init; } = MediaElementOptions.DefaultAndroidViewType;

Copy link

Copilot AI Nov 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing XML documentation for the IsAndroidForegroundServiceEnabled property. Following the pattern used for AndroidViewType on line 226-228, this property should have documentation explaining its purpose and that it's set during construction.

Add documentation like:

/// <summary>
/// Gets whether Android Foreground Service is enabled for this MediaElement instance.
/// This value is set on construction from <see cref="MediaElementOptions"/> and cannot be changed afterward.
/// </summary>
Suggested change
/// <summary>
/// Gets whether Android Foreground Service is enabled for this MediaElement instance.
/// This value is set on construction from <see cref="MediaElementOptions"/> and cannot be changed afterward.
/// </summary>

Copilot uses AI. Check for mistakes.
internal bool IsAndroidForegroundServiceEnabled { get; init; } = MediaElementOptions.IsAndroidForegroundServiceEnabled;
Copy link

Copilot AI Nov 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The visibility of IsAndroidForegroundServiceEnabled is inconsistent with the similar AndroidViewType property on line 229, which is public. Both properties serve the same purpose - allowing per-instance configuration while defaulting to the global option.

For consistency and to allow developers to override the foreground service setting on a per-MediaElement basis (just like they can with AndroidViewType), this property should be public:

public bool IsAndroidForegroundServiceEnabled { get; init; } = MediaElementOptions.IsAndroidForegroundServiceEnabled;
Suggested change
internal bool IsAndroidForegroundServiceEnabled { get; init; } = MediaElementOptions.IsAndroidForegroundServiceEnabled;
public bool IsAndroidForegroundServiceEnabled { get; init; } = MediaElementOptions.IsAndroidForegroundServiceEnabled;

Copilot uses AI. Check for mistakes.

/// <summary>
/// Gets or sets whether the media should start playing as soon as it's loaded.
/// Default is <see langword="false"/>. This is a bindable property.
Expand Down
11 changes: 11 additions & 0 deletions src/CommunityToolkit.Maui.MediaElement/MediaElementOptions.shared.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,19 @@ internal MediaElementOptions(in MauiAppBuilder builder) : this()
/// </summary>
internal static AndroidViewType DefaultAndroidViewType { get; private set; } = AndroidViewType.SurfaceView;

/// <summary>
/// Set Android Foreground Service for MediaElement on construction
/// </summary>
Comment on lines +29 to +31
Copy link

Copilot AI Nov 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The XML documentation for this property and the method on line 42 is identical, which doesn't provide useful information about what each does specifically. The property documentation should describe what it holds/represents, while the method documentation should describe what action it performs.

Consider updating:

  • Line 30-31: "Gets or sets a value indicating whether the Android Foreground Service is enabled by default for MediaElement instances."
  • Line 42: "Sets whether the Android Foreground Service should be enabled by default for MediaElement instances."

Copilot uses AI. Check for mistakes.
internal static bool IsAndroidForegroundServiceEnabled { get; private set; } = true;

/// <summary>
/// Set Android View type for MediaElement as SurfaceView or TextureView on construction
/// </summary>
public void SetDefaultAndroidViewType(AndroidViewType androidViewType) => DefaultAndroidViewType = androidViewType;

/// <summary>
/// Set Android Foreground Service for MediaElement on construction
/// </summary>
/// <param name="androidForegroundServiceEnabled">Specifies whether the Android Foreground Service should be enabled for the MediaElement. Set to <c>true</c> to enable, or <c>false</c> to disable.</param>
public void SetDefaultAndroidForegroundService(bool androidForegroundServiceEnabled) => IsAndroidForegroundServiceEnabled = androidForegroundServiceEnabled;
}
5 changes: 0 additions & 5 deletions src/CommunityToolkit.Maui.MediaElement/Views/MauiMediaElement.android.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
7 changes: 4 additions & 3 deletions src/CommunityToolkit.Maui.MediaElement/Views/MediaManager.android.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ namespace CommunityToolkit.Maui.Core.Views;

public partial class MediaManager : Java.Lang.Object, IPlayerListener
{
bool androidForegroundServiceEnabled;
Copy link

Copilot AI Nov 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The private field androidForegroundServiceEnabled should be marked as readonly since it's only assigned once in the CreatePlatformView method and never modified afterwards. This would make the immutability explicit and prevent accidental modifications.

readonly bool androidForegroundServiceEnabled;
Suggested change
bool androidForegroundServiceEnabled;
readonly bool androidForegroundServiceEnabled;

Copilot uses AI. Check for mistakes.
const int bufferState = 2;
const int readyState = 3;
const int endedState = 4;
Expand Down Expand Up @@ -130,11 +131,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 androidForegroundServiceEnabled)
{
Player = new ExoPlayerBuilder(MauiContext.Context).Build() ?? throw new InvalidOperationException("Player cannot be null");
Player.AddListener(this);

this.androidForegroundServiceEnabled = androidForegroundServiceEnabled;
if (androidViewType is AndroidViewType.SurfaceView)
{
PlayerView = new PlayerView(MauiContext.Context)
Expand Down Expand Up @@ -353,7 +354,7 @@ protected virtual async partial ValueTask PlatformUpdateSource()
return;
}

if (connection is null)
if (connection is null && androidForegroundServiceEnabled)
{
StartService();
}
Expand Down
19 changes: 19 additions & 0 deletions src/CommunityToolkit.Maui.UnitTests/Extensions/AppBuilderExtensionsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,5 +166,24 @@ public void UseMauiCommunityToolkitMediaElement_ShouldSetDefaultAndroidViewType(

MediaElementOptions.DefaultAndroidViewType.Should().Be(AndroidViewType.TextureView);
}

[Fact]
public void UseMauiCommunityToolkitMediaElement_ShouldSetAndroidServiceByDefault()
{
var builder = MauiApp.CreateBuilder();
builder.UseMauiCommunityToolkitMediaElement();
MediaElementOptions.IsAndroidForegroundServiceEnabled.Should().Be(true);
}

[Fact]
public void UseMauiCommunityToolkitMediaElement_ServiceCanBeDisabled()
{
var builder = MauiApp.CreateBuilder();
builder.UseMauiCommunityToolkitMediaElement(static options =>
{
options.SetDefaultAndroidForegroundService(false);
});
MediaElementOptions.IsAndroidForegroundServiceEnabled.Should().Be(false);
}
Comment on lines +179 to +187
Copy link

Copilot AI Nov 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The BaseTest.Dispose method restores default MediaElementOptions but only resets DefaultAndroidViewType. It should also reset the new IsAndroidForegroundServiceEnabled property to its default value (true) to ensure test isolation and prevent test interdependencies.

The cleanup code in BaseTest.cs around line 91-92 should include:

mediaElementOptions.SetDefaultAndroidForegroundService(true);

Copilot uses AI. Check for mistakes.
}
#pragma warning restore CA1416
Loading