Lock Screen Controls and Metadata Support for Windows, Android, IOS and Mac Catalyst

samples/CommunityToolkit.Maui.Sample/CommunityToolkit.Maui.Sample.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFrameworks>$(NetVersion)-ios;$(NetVersion)-android;$(NetVersion)-maccatalyst</TargetFrameworks>

samples/CommunityToolkit.Maui.Sample/Pages/Views/MediaElement/MediaElementPage.xaml

@@ -31,13 +31,15 @@
                 x:Name="MediaElement"
                 ShouldAutoPlay="True"
                 Source="https://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4"
+                MetadataArtworkUrl="https://lh3.googleusercontent.com/pw/AP1GczNRrebWCJvfdIau1EbsyyYiwAfwHS0JXjbioXvHqEwYIIdCzuLodQCZmA57GADIo5iB3yMMx3t_vsefbfoHwSg0jfUjIXaI83xpiih6d-oT7qD_slR0VgNtfAwJhDBU09kS5V2T5ZML-WWZn8IrjD4J-g=w1792-h1024-s-no-gm"
+                MetadataTitle="Big Buck Bunny"
+                MetadataArtist="Blender Foundation"
                 MediaEnded="OnMediaEnded"
                 MediaFailed="OnMediaFailed"
                 MediaOpened="OnMediaOpened"
                 PositionChanged="OnPositionChanged"
                 StateChanged="OnStateChanged"
                 SeekCompleted="OnSeekCompleted"/>
-
             <HorizontalStackLayout Grid.Row="1" Padding="0,0,0,15">
                 <Label HorizontalOptions="Center">
                     <Label.Text>

samples/CommunityToolkit.Maui.Sample/Pages/Views/MediaElement/MediaElementPage.xaml.cs

@@ -1,4 +1,5 @@
 using System.ComponentModel;
+using CommunityToolkit.Maui.Core;
 using CommunityToolkit.Maui.Core.Primitives;
 using CommunityToolkit.Maui.Sample.ViewModels.Views;
 using CommunityToolkit.Maui.Views;
@@ -159,22 +160,35 @@ async void ChangeSourceClicked(Object sender, EventArgs e)
 		switch (result)
 		{
 			case loadOnlineMp4:
+				MediaElement.MetadataTitle = "Big Buck Bunny";
+				MediaElement.MetadataArtworkUrl = "https://lh3.googleusercontent.com/pw/AP1GczNRrebWCJvfdIau1EbsyyYiwAfwHS0JXjbioXvHqEwYIIdCzuLodQCZmA57GADIo5iB3yMMx3t_vsefbfoHwSg0jfUjIXaI83xpiih6d-oT7qD_slR0VgNtfAwJhDBU09kS5V2T5ZML-WWZn8IrjD4J-g=w1792-h1024-s-no-gm";
+				MediaElement.MetadataArtist = "Big Buck Bunny Album";
 				MediaElement.Source =
 					MediaSource.FromUri(
 						"https://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4");
 				return;
 
 			case loadHls:
+				MediaElement.MetadataArtist = "HLS Album";
+				MediaElement.MetadataArtworkUrl = "https://lh3.googleusercontent.com/pw/AP1GczNRrebWCJvfdIau1EbsyyYiwAfwHS0JXjbioXvHqEwYIIdCzuLodQCZmA57GADIo5iB3yMMx3t_vsefbfoHwSg0jfUjIXaI83xpiih6d-oT7qD_slR0VgNtfAwJhDBU09kS5V2T5ZML-WWZn8IrjD4J-g=w1792-h1024-s-no-gm";
+				MediaElement.MetadataTitle = "HLS Title";
 				MediaElement.Source
 					= MediaSource.FromUri(
 						"https://mtoczko.github.io/hls-test-streams/test-gap/playlist.m3u8");
 				return;
 
 			case resetSource:
+				MediaElement.MetadataArtworkUrl = string.Empty;
+				MediaElement.MetadataTitle = string.Empty;
+				MediaElement.MetadataArtist = string.Empty;
 				MediaElement.Source = null;
 				return;
 
 			case loadLocalResource:
+				MediaElement.MetadataArtworkUrl = "https://lh3.googleusercontent.com/pw/AP1GczNRrebWCJvfdIau1EbsyyYiwAfwHS0JXjbioXvHqEwYIIdCzuLodQCZmA57GADIo5iB3yMMx3t_vsefbfoHwSg0jfUjIXaI83xpiih6d-oT7qD_slR0VgNtfAwJhDBU09kS5V2T5ZML-WWZn8IrjD4J-g=w1792-h1024-s-no-gm";
+				MediaElement.MetadataTitle = "Local Resource Title";
+				MediaElement.MetadataArtist = "Local Resource Album";
+
 				if (DeviceInfo.Platform == DevicePlatform.MacCatalyst
 					|| DeviceInfo.Platform == DevicePlatform.iOS)
 				{
@@ -192,7 +206,7 @@ async void ChangeSourceClicked(Object sender, EventArgs e)
 		}
 	}
 
-	async void ChangeAspectClicked(Object sender, EventArgs e)
+	async void ChangeAspectClicked(object? sender, EventArgs e)
 	{
 		var resultAspect = await DisplayActionSheet("Choose aspect ratio",
 			"Cancel", null, Aspect.AspectFit.ToString(),
@@ -203,11 +217,9 @@ async void ChangeAspectClicked(Object sender, EventArgs e)
 			return;
 		}
 
-		if (!Enum.TryParse(typeof(Aspect), resultAspect, true, out var aspectEnum)
-			|| aspectEnum is null)
+		if (!Enum.TryParse(typeof(Aspect), resultAspect, true, out var aspectEnum))
 		{
-			await DisplayAlert("Error", "There was an error determining the selected aspect",
-				"OK");
+			await DisplayAlert("Error", "There was an error determining the selected aspect", "OK");
 
 			return;
 		}

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

@@ -1,16 +1,29 @@
 <?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:roundIcon="@mipmap/appicon_round" android:supportsRtl="true" />
+	<application android:allowBackup="true" android:icon="@mipmap/appicon" android:enableOnBackInvokedCallback="true" android:supportsRtl="true">
+    <service android:name="CommunityToolkit.Maui.Media.Services" android:exported="false" android:enabled="true" android:foregroundServiceType="mediaPlayback">
+      <intent-filter>
+        <action android:name="android.intent.action.MEDIA_BUTTON" />
+      </intent-filter>
+      <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" />
-
-	<uses-permission android:name="android.permission.RECORD_AUDIO" />
-	<queries>
+	<uses-permission android:name="com.sec.android.provider.badge.permission.READ" />
+	<uses-permission android:name="com.sec.android.provider.badge.permission.WRITE" />
+	
+  <uses-permission android:name="android.permission.RECORD_AUDIO" />
+		<queries>
 		<intent>
 			<action android:name="android.intent.action.TTS_SERVICE" />
 		</intent>

samples/CommunityToolkit.Maui.Sample/Platforms/MacCatalyst/Info.plist

@@ -28,7 +28,14 @@
 	<string>Assets.xcassets/appicon.appiconset</string>
 	<key>NSSpeechRecognitionUsageDescription</key>
 	<string>ISpeechToText Uses Speech Recognition</string>
+	<key>NSLocalNetworkUsageDescription</key>
+	<string></string>
 	<key>NSMicrophoneUsageDescription</key>
 	<string>ISpeechToText Uses Microphone</string>
+	<key>UIBackgroundModes</key>
+	<array>
+		<string>bluetooth-central</string>
+		<string>audio</string>
+	</array>
 </dict>
 </plist>

samples/CommunityToolkit.Maui.Sample/Platforms/iOS/Info.plist

@@ -34,5 +34,9 @@
 	<string>ISpeechToText Uses Speech Recognition</string>
 	<key>NSMicrophoneUsageDescription</key>
 	<string>ISpeechToText Uses Microphone</string>
+	<key>UIBackgroundModes</key>
+	<array>
+		<string>audio</string>
+	</array>
 </dict>
 </plist>

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

@@ -1,4 +1,5 @@
 using CommunityToolkit.Maui.Core.Handlers;
+using CommunityToolkit.Maui.Core.Views;
 using CommunityToolkit.Maui.Views;
 
 namespace CommunityToolkit.Maui;
@@ -20,6 +21,9 @@ public static MauiAppBuilder UseMauiCommunityToolkitMediaElement(this MauiAppBui
 			h.AddHandler<MediaElement, MediaElementHandler>();
 		});
 
+#if ANDROID
+		builder.Services.AddSingleton<Media.Services.MediaControlsService>();
+#endif
 		return builder;
 	}
 }

src/CommunityToolkit.Maui.MediaElement/CommunityToolkit.Maui.MediaElement.csproj

@@ -57,10 +57,11 @@
     <None Include="..\CommunityToolkit.Maui.MediaElement.Analyzers\bin\$(Configuration)\netstandard2.0\CommunityToolkit.Maui.MediaElement.Analyzers.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false"/>
     <None Include="..\CommunityToolkit.Maui.MediaElement.Analyzers.CodeFixes\bin\$(Configuration)\netstandard2.0\CommunityToolkit.Maui.MediaElement.Analyzers.CodeFixes.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false"/>
   </ItemGroup>
-
+  
   <ItemGroup Condition="$(TargetFramework.Contains('-android'))">
     <PackageReference Include="Xam.Plugins.Android.ExoPlayer" Version="[2.19.1,)"/>
     <PackageReference Include="Xam.Plugins.Android.ExoPlayer.Transformer" Version="[2.19.1,)"/>
+    <PackageReference Include="Xam.Plugins.Android.ExoPlayer.MediaSession" Version="[2.19.1,)"/>
   </ItemGroup>
 
   <ItemGroup>

src/CommunityToolkit.Maui.MediaElement/Converters/FileMediaSourceConverter.cs

@@ -12,9 +12,9 @@ public sealed class FileMediaSourceConverter : TypeConverter
 {
 	/// <inheritdoc/>
 	/// <exception cref="InvalidOperationException">Thrown when <paramref name="value"/> is <see langword="null"/> or empty.</exception>
-	public override object? ConvertFrom(ITypeDescriptorContext? context, CultureInfo? culture, object value)
+	public override object ConvertFrom(ITypeDescriptorContext? context, CultureInfo? culture, object value)
 	{
-		var filePath = value?.ToString() ?? string.Empty;
+		var filePath = value.ToString() ?? string.Empty;
 
 		return string.IsNullOrWhiteSpace(filePath)
 			? (FileMediaSource)MediaSource.FromFile(filePath)

src/CommunityToolkit.Maui.MediaElement/Interfaces/IMediaElement.cs

@@ -8,6 +8,21 @@ namespace CommunityToolkit.Maui.Core;
 /// </summary>
 public interface IMediaElement : IView, IAsynchronousMediaElementHandler
 {
+	/// <summary>
+	/// Gets or sets the title of the media.
+	/// </summary>
+	string MetadataTitle { get; set; }
+
+	/// <summary>
+	/// Gets or sets the artist of the media.
+	/// </summary>
+	string MetadataArtist { get; set; }
+
+	/// <summary>
+	/// Gets or sets the artwork Image Url.
+	/// </summary>
+	string MetadataArtworkUrl { get; set; }
+
 	/// <summary>
 	/// Gets the media aspect ratio.
 	/// </summary>

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

@@ -16,16 +16,16 @@ public class MediaElement : View, IMediaElement, IDisposable
 	public static readonly BindableProperty AspectProperty =
 		BindableProperty.Create(nameof(Aspect), typeof(Aspect), typeof(MediaElement), Aspect.AspectFit);
 
-	static readonly BindablePropertyKey durationPropertyKey =
-		BindableProperty.CreateReadOnly(nameof(Duration), typeof(TimeSpan), typeof(MediaElement), TimeSpan.Zero);
-
 	/// <summary>
 	/// Backing store for the <see cref="CurrentState"/> property.
 	/// </summary>
 	public static readonly BindableProperty CurrentStateProperty =
 		BindableProperty.Create(nameof(CurrentState), typeof(MediaElementState), typeof(MediaElement),
 			MediaElementState.None, propertyChanged: OnCurrentStatePropertyChanged);
 
+	static readonly BindablePropertyKey durationPropertyKey =
+		BindableProperty.CreateReadOnly(nameof(Duration), typeof(TimeSpan), typeof(MediaElement), TimeSpan.Zero);
+
 	/// <summary>
 	/// Backing store for the <see cref="Duration"/> property.
 	/// </summary>
@@ -99,6 +99,21 @@ public class MediaElement : View, IMediaElement, IDisposable
 		BindableProperty.Create(nameof(Volume), typeof(double), typeof(MediaElement), 1.0,
 			BindingMode.TwoWay, propertyChanging: ValidateVolume);
 
+	/// <summary>
+	/// Backing store for the <see cref="MetadataTitle"/> property.
+	/// </summary>
+	public static readonly BindableProperty MetadataTitleProperty = BindableProperty.Create(nameof(MetadataTitle), typeof(string), typeof(MediaElement), string.Empty);
+
+	/// <summary>
+	/// Backing store for the <see cref="MetadataArtist"/> property.
+	/// </summary>
+	public static readonly BindableProperty MetadataArtistProperty = BindableProperty.Create(nameof(MetadataArtist), typeof(string), typeof(MediaElement), string.Empty);
+
+	/// <summary>
+	/// Backing store for the <see cref="MetadataArtworkUrl"/> property.
+	/// </summary>
+	public static readonly BindableProperty MetadataArtworkUrlProperty = BindableProperty.Create(nameof(MetadataArtworkUrl), typeof(string), typeof(MediaElement), string.Empty);
+
 	readonly WeakEventManager eventManager = new();
 	readonly SemaphoreSlim seekToSemaphoreSlim = new(1, 1);
 
@@ -315,6 +330,36 @@ public int MediaWidth
 		internal set => SetValue(MediaWidthProperty, value);
 	}
 
+	/// <summary>
+	/// Gets or sets the Title of the media.
+	/// This is a bindable property.
+	/// </summary>
+	public string MetadataTitle
+	{
+		get => (string)GetValue(MetadataTitleProperty);
+		set => SetValue(MetadataTitleProperty, value);
+	}
+
+	/// <summary>
+	/// Gets or sets the Artist of the media.
+	/// This is a bindable property.
+	/// </summary>
+	public string MetadataArtist
+	{
+		get => (string)GetValue(MetadataArtistProperty);
+		set => SetValue(MetadataArtistProperty, value);
+	}
+
+	/// <summary>
+	/// Gets or sets the Artwork Image Url of the media.
+	/// This is a bindable property.
+	/// </summary>
+	public string MetadataArtworkUrl
+	{
+		get => (string)GetValue(MetadataArtworkUrlProperty);
+		set => SetValue(MetadataArtworkUrlProperty, value);
+	}
+
 	/// <summary>
 	/// Gets or sets how the media will be scaled to fit the display area.
 	/// Default value is <see cref="Aspect.AspectFit"/>. This is a bindable property.
@@ -355,6 +400,7 @@ TimeSpan IMediaElement.Duration
 		set => SetValue(durationPropertyKey, value);
 	}
 
+
 	/// <inheritdoc/>
 	TaskCompletionSource IAsynchronousMediaElementHandler.SeekCompletedTCS => seekCompletedTaskCompletionSource;
 

src/CommunityToolkit.Maui.MediaElement/Primitives/AndroidMediaPermissions.android.cs

@@ -0,0 +1,27 @@
+using static Microsoft.Maui.ApplicationModel.Permissions;
+
+namespace CommunityToolkit.Maui.ApplicationModel.Permissions;
+
+sealed class AndroidMediaPermissions : BasePlatformPermission
+{
+	static readonly Lazy<(string androidPermission, bool isRuntime)[]> permissionsHolder = new(CreatePermissions);
+
+	public override (string androidPermission, bool isRuntime)[] RequiredPermissions => permissionsHolder.Value;
+
+	static (string androidPermission, bool isRuntime)[] CreatePermissions()
+	{
+		List<(string androidPermission, bool isRuntime)> requiredPermissionsList = new();
+
+		if (OperatingSystem.IsAndroidVersionAtLeast(28))
+		{
+			requiredPermissionsList.Add((global::Android.Manifest.Permission.ForegroundService, true));
+		}
+
+		if (OperatingSystem.IsAndroidVersionAtLeast(33))
+		{
+			requiredPermissionsList.Add((global::Android.Manifest.Permission.PostNotifications, true));
+		}
+
+		return [.. requiredPermissionsList];
+	}
+}