FIXED - Custom notification sound Android how to #461

tbink · 2023-12-12T23:02:16Z

tbink
Dec 12, 2023

I found out why custom sound in Android weren't working in my project. The fix is not documented as far as I can tell. The code I show here is strictly test code... to find the way to make it work.. and it does now. Also I set the minimum API for Android to 31 in the VS Project.
I'm not entirely clear if new channels have to be created in MauiProgram... I'd prefer to create Android channels on the fly when I create the NotificationRequest. Comments/Advice welcome

The audio file has to be in a created folder on this path:
-- Platforms/Android/Resources/raw/myaudiofile.mp3 (and this file has to be 128kps or it won't work)
-- MOST IMPORTANT: BuildAction MUST be set to AndroidResource (I'm in VS 2022 Preview latest)

I use this code in MauiProgram.cs to setup the Android Channel

using Microsoft.Extensions.Logging;
using Plugin.LocalNotification;
using Plugin.LocalNotification.AndroidOption;
using System.Xml.Linq;

namespace LocalNotification_Sample
{
    public static class MauiProgram
    {
        public static MauiApp CreateMauiApp()
        {
            var builder = MauiApp.CreateBuilder();
            builder
                .UseMauiApp<App>()
                .ConfigureFonts(fonts =>
                {
                    fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
                    fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
                })
            .UseLocalNotification(config =>
                {
                    config.AddAndroid(android =>
                    {
                        android.AddChannel(new NotificationChannelRequest
                        {
                            CanBypassDnd = true,
                            Description = "Android Channel",
                            Id = "8",
                            EnableSound = true,
                            Sound = "tibet128mono",
                            Name = "AndroidChannel",
                            Importance = AndroidImportance.Max,
                            LockScreenVisibility = AndroidVisibilityType.Public,
                        });
                    });
                });

#if DEBUG
            builder.Logging.AddDebug();
#endif
            return builder.Build();
        }
    }
}

I created the notification here:

        private void OnCounterClicked(object sender, EventArgs e)
        {
            var notification = new NotificationRequest
            {
                NotificationId = 111,
                Title = "Zen Alarm",
                Description = $"Zen Request# {count++}",
                ReturningData = "Dummy data",
                Android =
                {
                    AutoCancel = true,   // removes the notification from the status bar when the user taps on it
                    Ongoing = false,
                    Priority = AndroidPriority.Max,
                    VisibilityType = AndroidVisibilityType.Public,
                    ChannelId = "8",  //this is from the channel created in MauiProgram.cs
                },
                CategoryType = NotificationCategoryType.Reminder,
                //Sound is NOT SET HERE!
                //If not specified, the default sound will be played. In Android, this must be set at the channel level for new versions of Android. 
                //Sound = DeviceInfo.Platform == DevicePlatform.Android ? "tibet128mono" : "tibet128mono.mp3",
                Schedule =
                {
                    NotifyTime = DateTime.Now.AddSeconds(2), // Used for Scheduling local notification, if not specified notification will show immediately.
                    RepeatType = NotificationRepeat.No
                }
            };
            LocalNotificationCenter.Current.Show(notification);
        }