Added MediaStyle handling (Android only) (#389)

* [Media Style][Android] Added MediaStyle handling

* [MediaStyle][Android] Removed showActionsInCompactView handling as requested

* [MediaStyle][Android] Updated README as requested

* [MediaStyle][Android]
- Updated README as requested
- Removed MediaStyleInformation class as requested

* renamed button for showing media notification

Co-authored-by: Michael Bui <[email protected]>

Author: gianlucaparadise

README.md

@@ -34,6 +34,8 @@ A cross platform plugin for displaying local notifications.
     * Big text
     * Inbox
     * Messaging
+    * Media
+        * While media playback control using a `MediaSession.Token` is not supported, with this style you let Android treat the `largeIcon` bitmap as album artwork
 * [Android] Group notifications
 * [Android] Show progress notifications
 * [Android] Configure notification visibility on the lockscreen

android/build.gradle

@@ -35,5 +35,6 @@ android {
 
 dependencies {
     implementation "androidx.core:core:1.1.0"
+    implementation "androidx.media:media:1.1.0"
     implementation "com.google.code.gson:gson:2.8.5"
 }

android/src/main/java/com/dexterous/flutterlocalnotifications/FlutterLocalNotificationsPlugin.java

@@ -447,6 +447,9 @@ private static void setStyle(Context context, NotificationDetails notificationDe
             case Messaging:
                 setMessagingStyle(context, notificationDetails, builder);
                 break;
+            case Media:
+                setMediaStyle(builder);
+                break;
             default:
                 break;
         }
@@ -500,6 +503,10 @@ private static void setInboxStyle(NotificationDetails notificationDetails, Notif
         builder.setStyle(inboxStyle);
     }
 
+    private static void setMediaStyle(NotificationCompat.Builder builder) {
+        androidx.media.app.NotificationCompat.MediaStyle mediaStyle = new androidx.media.app.NotificationCompat.MediaStyle();
+        builder.setStyle(mediaStyle);
+    }
 
     private static void setMessagingStyle(Context context, NotificationDetails notificationDetails, NotificationCompat.Builder builder) {
         MessagingStyleInformation messagingStyleInformation = (MessagingStyleInformation) notificationDetails.styleInformation;

android/src/main/java/com/dexterous/flutterlocalnotifications/NotificationStyle.java

@@ -5,6 +5,7 @@ public enum NotificationStyle{
     BigPicture,
     BigText,
     Inbox,
-    Messaging
+    Messaging,
+    Media
 }
 

android/src/main/java/com/dexterous/flutterlocalnotifications/models/NotificationDetails.java

@@ -267,6 +267,8 @@ private static void readStyleInformation(NotificationDetails notificationDetails
             readInboxStyleInformation(notificationDetails, styleInformation, defaultStyleInformation);
         } else if (notificationDetails.style == NotificationStyle.Messaging) {
             readMessagingStyleInformation(notificationDetails, styleInformation, defaultStyleInformation);
+        } else if (notificationDetails.style == NotificationStyle.Media) {
+            notificationDetails.styleInformation = defaultStyleInformation;
         }
     }
 

example/lib/main.dart

@@ -178,7 +178,7 @@ class _HomePageState extends State<HomePage> {
                   ),
                   PaddedRaisedButton(
                     buttonText:
-                    'Show plain notification as public on every lockscreen [Android]',
+                        'Show plain notification as public on every lockscreen [Android]',
                     onPressed: () async {
                       await _showPublicNotification();
                     },
@@ -237,6 +237,12 @@ class _HomePageState extends State<HomePage> {
                       await _showBigPictureNotificationHideExpandedLargeIcon();
                     },
                   ),
+                  PaddedRaisedButton(
+                    buttonText: 'Show media notification [Android]',
+                    onPressed: () async {
+                      await _showNotificationMediaStyle();
+                    },
+                  ),
                   PaddedRaisedButton(
                     buttonText: 'Show big text notification [Android]',
                     onPressed: () async {
@@ -448,6 +454,23 @@ class _HomePageState extends State<HomePage> {
         0, 'big text title', 'silent body', platformChannelSpecifics);
   }
 
+  Future<void> _showNotificationMediaStyle() async {
+    var largeIconPath = await _downloadAndSaveImage(
+        'http://via.placeholder.com/128x128/00FF00/000000', 'largeIcon');
+    var androidPlatformChannelSpecifics = AndroidNotificationDetails(
+      'media channel id',
+      'media channel name',
+      'media channel description',
+      largeIcon: largeIconPath,
+      largeIconBitmapSource: BitmapSource.FilePath,
+      style: AndroidNotificationStyle.Media,
+    );
+    var platformChannelSpecifics =
+        NotificationDetails(androidPlatformChannelSpecifics, null);
+    await flutterLocalNotificationsPlugin.show(
+        0, 'notification title', 'notification body', platformChannelSpecifics);
+  }
+
   Future<void> _showBigTextNotification() async {
     var bigTextStyleInformation = BigTextStyleInformation(
         'Lorem <i>ipsum dolor sit</i> amet, consectetur <b>adipiscing elit</b>, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.',
@@ -775,13 +798,15 @@ class _HomePageState extends State<HomePage> {
   Future<void> _showPublicNotification() async {
     var androidPlatformChannelSpecifics = AndroidNotificationDetails(
         'your channel id', 'your channel name', 'your channel description',
-        importance: Importance.Max, priority: Priority.High, ticker: 'ticker',
+        importance: Importance.Max,
+        priority: Priority.High,
+        ticker: 'ticker',
         visibility: NotificationVisibility.Public);
     var iOSPlatformChannelSpecifics = IOSNotificationDetails();
     var platformChannelSpecifics = NotificationDetails(
         androidPlatformChannelSpecifics, iOSPlatformChannelSpecifics);
-    await flutterLocalNotificationsPlugin.show(
-        0, 'public notification title', 'public notification body', platformChannelSpecifics,
+    await flutterLocalNotificationsPlugin.show(0, 'public notification title',
+        'public notification body', platformChannelSpecifics,
         payload: 'item x');
   }
 

lib/src/platform_specifics/android/enums.dart

@@ -5,7 +5,7 @@ enum BitmapSource { Drawable, FilePath }
 enum IconSource { Drawable, FilePath, ContentUri }
 
 /// The available notification styles on Android
-enum AndroidNotificationStyle { Default, BigPicture, BigText, Inbox, Messaging }
+enum AndroidNotificationStyle { Default, BigPicture, BigText, Inbox, Messaging, Media }
 
 /// The available actions for managing notification channels.
 /// [CreateIfNotExists]: will create a channel if it doesn't exist